Skip to content

Latest commit

 

History

History
65 lines (63 loc) · 16.3 KB

Parameters.md

File metadata and controls

65 lines (63 loc) · 16.3 KB

The Parameters used as Environment Variables (1.2.0)

Parameter Description
PORT The port number on which the application will run (default is 8000).
AZURE_OPENAI_API_KEY The API key for accessing Azure OpenAI services.
AZURE_OPENAI_Deployment The specific deployment name for the Azure OpenAI GPT model (e.g., gpt-4o-mini).
AZURE_OPENAI_EMBEDDING_Deployment The specific deployment name for the Azure OpenAI embedding model (e.g., text-embedding-3-small).
AZURE_OPENAI_ENDPOINT The endpoint URL of the Azure OpenAI service (replace [name] with your service name).
AZURE_OPENAI_API_VERSION The API version for Azure OpenAI (e.g., 2023-05-15).
OPENAI_API_VERSION The API version for OpenAI.
OPENAI_API_TYPE Indicates that the API type is for Azure.
DOC_AI_BASE The base URL for Azure Document Intelligence services (replace [name] with your service name).
DOC_AI_KEY The API key for accessing Azure Document Intelligence services.
AZURE_SEARCH_ENDPOINT The endpoint URL for Azure AI Search services (replace [name] with your service name).
AZURE_SEARCH_API_KEY The API key for accessing Azure AI Search services.
AZURE_SEARCH_API_VERSION The API version for Azure AI Search services (e.g., 2023-11-01).
USE_SUB_QUERY_ENGINE Boolean flag (True/False) indicating whether to use a sub-query engine.
DEFAULT_STORAGE Path to the default storage location. Can be empty for temporary storage or set with a specific path. Examples: /app/data, ./data on Linux Docker, or C:\data on Windows.
USE_LMSTUDIO Boolean flag (True/False) indicating whether to use LMSTUDIO for CSV Query Engine, Recursive Retriever, Knowledge Graph, and Tree Mode Summarize.
USE_OLLAMA Boolean flag (True/False) indicating whether to use OLLAMA.
LLAMACPP_URL URL endpoint for the self-hosted LM-STUDIO.
LLAMACPP_MODEL Model name for the self-hosted LM-STUDIO.
LLAMACPP_API_KEY API key for the self-hosted LM-STUDIO.
OLLAMA_MODEL Model name for the self-hosted OLLAMA (default is llama3.1:latest).
OLLAMA_URL URL endpoint for the self-hosted OLLAMA.
GRAPHRAG_ENDPOINT Endpoint URL for the GraphRAG Service (replace [name] with your service name).
GRAPHRAG_API_KEY API key for accessing the GraphRAG Service.
Max_Output_Columns Maximum number of columns for the CSV Query Engine (default is 100).
Max_Output_Rows Maximum number of rows for the CSV Query Engine (default is 100).
Default_System_Message_Long The default system message for general chat mode, providing a detailed description of the assistant's capabilities and behavior.
Default_System_Message The default system message for general chat mode, providing a concise description of the assistant's capabilities and behavior.
Proofread_System_Message The system message for enabling proofreading mode with specific guidelines and rules.
Content_Prefix Prefix content for proofreading requests.
Sample_Content Sample content for demonstrating proofreading capabilities.
GRADIO_ANALYTICS_ENABLED Boolean flag (True/False) indicating whether Gradio analytics are enabled.
LOG_LEVEL Log level setting (e.g., ERROR).
Predict_Concurrency Number of concurrent predictions that can be handled (default is 10).
Build_Concurrency Number of concurrent build processes that can be handled (default is 3).
Max_Queue_Size Maximum size of the queue for handling requests (default is 100).
QueryEngineTool_Name Name of the query engine tool.
QueryEngineTool_Description Description of the query engine tool.
Individual_Chat Boolean flag (True/False) for setting individual chat mode when more than two index tabs are enabled.
AdvChatBot_Tab Boolean flag (True/False) for enabling the Advanced ChatBot Tab.
BuildAzureIndex_Tab Boolean flag (True/False) for enabling the Build Azure Index Tab.
BuildKGIndex_Tab Boolean flag (True/False) for enabling the Build Knowledge Graph Index Tab.
BuildRRIndex_Tab Boolean flag (True/False) for enabling the Build Recursive Retriever Index Tab.
BuildGraphRAGIndex_Tab Boolean flag (True/False) for enabling the Build GraphRAG Index Tab.
BuildSummaryIndex_Tab Boolean flag (True/False) for enabling the Build Summary Index Tab.
CSVQueryEngine_Tab Boolean flag (True/False) for enabling the CSV Query Engine Tab.
Proofread_Tab Boolean flag (True/False) for enabling the Proofread Tab.
AdvProofread_Tab Boolean flag (True/False) for enabling the Advanced Proofread Tab.
ProofreadAddin_Tab Boolean flag (True/False) for enabling the Proofread Add-in Tab.
AdvChatBot_API Boolean flag (True/False) for enabling the Advanced ChatBot API.
BuildAzureIndex_API Boolean flag (True/False) for enabling the Build Azure Index API.
BuildKGIndex_API Boolean flag (True/False) for enabling the Build Knowledge Graph Index API.
BuildRRIndex_API Boolean flag (True/False) for enabling the Build Recursive Retriever Index API.
BuildGraphRAGIndex_API Boolean flag (True/False) for enabling the Build GraphRAG Index API.
BuildSummaryIndex_API Boolean flag (True/False) for enabling the Build Summary Index API.
CSVQueryEngine_API Boolean flag (True/False) for enabling the CSV Query Engine API.
Proofread_API Boolean flag (True/False) for enabling the Proofread API.
AdvProofread_API Boolean flag (True/False) for enabling the Advanced Proofread API.
ProofreadAddin_API Boolean flag (True/False) for enabling the Proofread Add-in API.
Default_Theme The default theme for the application (values can be light, dark, or system; default is dark).