Skip to content

Commit bb61495

Browse files
ypldanypldan
authored
chore: update README with environment variables (#54)
1 parent 2d850f7 commit bb61495

File tree

2 files changed

+78
-48
lines changed

2 files changed

+78
-48
lines changed

‎CONFIGURATION.md‎

Lines changed: 2 additions & 35 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# Quick Apps (2.0) — Configuration Reference
22

3-
This file contains the full configuration reference for Quick Apps (2.0): configuration model, environment variables,
3+
This file contains the full configuration reference for Quick Apps (2.0): configuration model,
44
orchestrator configuration, contexts, tool sets, tool fallback and attachments, authorization types, parameters,
55
display configuration, examples and notes for registering and running Quick Apps.
6+
For environment variables see [README.md](./README.md#environment-variables).
67

78
## Configuration model
89

@@ -12,40 +13,6 @@ Schema reference:
1213
- Generated locally via: make dump_app_schema
1314
- Hosted reference: https://mydial.epam.com/custom_application_schemas/quickapps2
1415

15-
## Environment Variables
16-
17-
| Variable | Required | Description | Available Values | Default Value |
18-
|------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------------|------------------|----------------------------|
19-
| DIAL_URL | Yes | URL for the DIAL service | URL string | |
20-
| DIAL_API_KEY | Yes | Authorization [API key](https://github.com/epam/ai-dial-core/blob/development/docs/dynamic-settings/keys.md) cofigured in core | String | |
21-
| PY_INTERPRETER_LOCAL_RUN | No | Run the PyInterpreter locally or use the DIAL Core API | `true`, `false` | `false` |
22-
| PY_INTERPRETER_URL | No | The URL of the PyInterpreter service or DIAL Core API | URL string | DIAL_URL value |
23-
| PY_INTERPRETER_API_KEY | No | API key for local run of the PyInterpreter | String | `null` |
24-
| PY_INTERPRETER_DEFAULT_SESSION_ID | No | Default session ID for the PyInterpreter | String | `null` |
25-
| PY_INTERPRETER_ADDITIONAL_HANDLING_MODEL | No | Model used for additional handling in the PyInterpreter | String | `"gpt-4o-mini-2024-07-18"` |
26-
| PY_INTERPRETER_CLIENT_TIMEOUT | No | Timeout for the PyInterpreter client requests in seconds | Float | `60.0` |
27-
| PY_INTERPRETER_CLIENT_MAX_RETRIES | No | Maximum number of retries for the PyInterpreter client requests | Integer | `3` |
28-
| OTEL_SERVICE_NAME | No | The name of the service for OpenTelemetry tracing and metrics | String | `"quickapps"` |
29-
| REMOTE_DIAL_URL | No | The URL of the remote DIAL used only by the `generate_dial_config` script and e2e/integration tests | URL string | `null` |
30-
| REMOTE_DIAL_API_KEY | No | The API KEY of the remote DIAL used only by the `generate_dial_config` script and e2e/integration tests | String | `null` |
31-
| PREDEFINED_BASE_PATH: | No | Specifies the base path to the predefined configurations/templates files for the application. | String | `config/predefined` |
32-
| SHOW_USAGE_STATISTICS | No | Flag to show the "Usage statistics" stage per user message. | `true`, `false` | `false` |
33-
| DEFAULT_AGENT_MAX_ITERATIONS | No | Default vale for the server for the max count of orchestrator(agent) operations. | Integer | 15 |
34-
| CONTENT_DOWNLOADER_FILE_SIZE_LIMIT | No | Internal tool file size limitation. It is used to download files from DIAL to pass content as MCP attachment. Bytes count. | Integer | 20971520 |
35-
| SHOW_EXECUTION_TIME_STAGE | No | Flag to show time execution stage | `true`, `false` | `false` |
36-
| CHAT_MESSAGE_LOG_LEN | No | Truncates message, tool-argument and stage content shown in OpenAI message log previews. | Integer | -1 |
37-
38-
Notes:
39-
- Variables marked in this table are a superset used across development and deployment modes. Some variables are only used when running the full local stack via docker-compose.
40-
- Important variables for a standalone Quick Apps deployment:
41-
- DIAL_URL — URL of the DIAL Core API reachable from Quick Apps.
42-
- DIAL_API_KEY — if your DIAL Core requires API key auth.
43-
- REMOTE_DIAL_URL and REMOTE_DIAL_API_KEY are used by the generate_dial_config script and e2e/integration tests and typically do not affect normal runtime behavior of standalone Quick Apps.
44-
- For pyinterpreter tool setup, see:
45-
- DIAL Core: https://github.com/epam/ai-dial-core
46-
- PyInterpreter docs: https://github.com/epam/ai-dial-code-interpreter
47-
48-
4916
## Agent Configuration:
5017

5118
<details>

0 commit comments

Comments
 (0)