--- title: "Get Configs" method: GET path: "/api/configs/{config_ext_id}" tags: ["configs"] --- # Get Configs `GET /api/configs/{config_ext_id}` Read configurations from database to be displayed in the UI ## Path parameters - `config_ext_id` string, required — Config name: 'cfg-XXXXXXXX' or 'default' for system default ## Response `200` Successful Response - union - AllConfigs - `Agents` AgentsConfig - `ENABLED` boolean — Whether to use agents mode for queries. - `AGENT_MODEL_NAME` string — The name of the model to be used for the agent. - `AGENT_PROMPT` string - `LLM_AGENT_TEMPERATURE` number — Temperature value for randomness. - `LLM_PAGE_FILTER_MODEL_NAME` string — The name of the model to be used for the llm page filter model. - `LLM_PAGE_FILTER_TEMPERATURE` number — Temperature value for randomness. - `LLM_PAGE_FILTER_PROMPT` string - `LLM_SUMMARISE_MODEL_NAME` string — The name of the model to be used for the llm summarise model. - `LLM_SUMMARISE_TEMPERATURE` number — Temperature value for randomness. - `LLM_SUMMARISE_PROMPT` string - `QueryLLM` QueryLLMConfig - `API_TYPE` 'local' | 'remote' — The inference type (local or remote). - `MODEL_NAME` string — The name of the non-reasoning model to be used. - `SYSTEM_INSTRUCTION` string — The system instruction string. - `MAX_CHAR_SIZE_TO_ANSWER` integer — Maximum character size to answer. - `TEMPERATURE` number — Temperature value for randomness. - `MAX_TOKENS` integer — Maximum number of tokens allowed. - `AgentLLM` AgentLLMConfig - `API_TYPE` 'local' | 'remote' — The inference type (local or remote). - `MODEL_NAME` string — The name of the model to be used. - `ENABLED` boolean — Whether to use agent mode for queries. - `MAX_ITERATIONS` integer — Maximum agent loop iterations. - `SHOW_INTERIM_STEPS` boolean — Whether to show agent's intermediate steps. - `MAX_CONTEXT_TOKENS` integer — Maximum tokens for gathered context (applies to evidence buffer and final query). - `SYSTEM_INSTRUCTION` string — The system instruction for agent planning. - `TEMPERATURE` number — Temperature for agent decisions. - `MAX_TOKENS` integer — Maximum tokens for planning decisions. - `MAX_CHAR_SIZE_TO_ANSWER` integer — Maximum character size for history. - `EvaluatorLLM` EvaluatorLLMConfig - `API_TYPE` 'local' | 'remote' — The inference type (local or remote). - `MODEL_NAME` string — The name of the non-reasoning model to be used. - `SYSTEM_INSTRUCTION` string — The system instruction for chunk evaluation. - `TEMPERATURE` number — Low temperature for consistent evaluation. - `MAX_TOKENS` integer — Maximum tokens for evaluation response. - `MAX_CHAR_SIZE_TO_ANSWER` integer — Maximum character size for evaluation context. - `TitleLLM` TitleLLMConfig - `API_TYPE` 'local' | 'remote' — The inference type (local or remote). - `MODEL_NAME` string — The name of the non-reasoning model to be used. - `SYSTEM_INSTRUCTION` string - `MAX_CHAR_SIZE_TO_ANSWER` integer — Maximum character size to answer. - `TEMPERATURE` number — Temperature value for randomness. - `MAX_TOKENS` integer — Maximum number of tokens allowed. - `DoctagLLM` DoctagLLMConfigOutput — Configuration for DoctagLLM - extracts information from documents based on tag instructions. - `API_TYPE` 'local' | 'remote' — The inference type (local or remote). - `MODEL_NAME` string — The name of the non-reasoning model to be used. - `SYSTEM_INSTRUCTION` string - `MAX_CHAR_CONTEXT_TO_ANSWER` integer — Maximum characters in document for context. - `TEMPERATURE` number — Temperature for factual answers. - `MAX_TOKENS` integer — Maximum number of tokens allowed for all answers. - `MAX_CONCURRENT_DOCS` integer — Maximum concurrent documents for doctag generation. - `DEFAULT_METADATA_TAGS` TagTemplate[] — Metadata templates used for automatic document metadata extraction during indexing. - `name` string, required - `instruction` string, nullable - `tag_type` TagFormat — Tag format configuration stored as JSONB. Type-specific fields: - select: options (list of choices, can be single or multi-select) - search: tag name is the query, chunks include relevance scores - checkbox, text, number, folder: type only - `type` 'checkbox' | 'text' | 'number' | 'select' | 'folder' | 'search' | 'date' - `options` string[] - `ModelCitation` ModelCitationConfig - `SIM_THREASHOLD` number — How similar does the statement needs to be to be considered as citation. - `MIN_CHAR_SIZE_TO_ANSWER` integer — Minimum character length to be considered as a statement for citation. - `MAX_NUMB_CITATIONS` integer — Maximum number of citations to return per statement. - `Retriever` RetrieverConfig - `MIN_RETRIEVAL_SIM_SCORE` number — Minimum similarity score for retrieval of a chunk. - `MAX_DISTINCT_DOCUMENTS` integer — Maximum number of distinct documents to search for. - `MAX_TOTAL_CHUNKS_TO_RETRIEVE` integer — Maximum total number of chunks to retrieve for all documents retrieved. - `GROUP_SIZE` integer — Maximum number of chunks per document for retrieval. - `SEARCH_MODE` 'semantic' | 'keyword' | 'hybrid' — Search mode for retrieval. - `HYBRID_DENSE_WEIGHT` number — Weight for dense vectors in hybrid mode - `HYBRID_SPARSE_WEIGHT` number — Weight for sparse vectors in hybrid mode - `HYBRID_RERANKER_WEIGHT` number — Weight for reranker score in hybrid mode score blending (0-1). RRF weight = 1 - this value - `Reranker` RerankerConfig - `MAX_NUMB_OF_CHUNKS` integer — Maximum number of chunks to return after reranking. - `MAX_CONCURRENT_REQUESTS` integer — Maximum number of concurrent reranking requests. - `MODEL_NAME` string — Name of the reranking model to use. - `API_TYPE` 'local' | 'remote' — The inference type (local or remote). - `Parser` ParserConfig - `Chunker` ChunkerConfig - `Embedder` EmbedderConfig - `MODEL_NAME` string — The name of the embedder model. - `API_TYPE` 'local' | 'remote' — The inference type (local or remote). - `BATCH_SIZE` integer — Smaller batch size for better parallelization. - `MAX_CONCURRENT_REQUESTS` integer — Adjust concurrency level as needed. - `EMBED_PREFIX` string — How to embed the sentence for retrieval. - `QUERY_PREFIX` string — How to embed the sentence for query. - `KeywordEmbedder` KeywordEmbedderConfig — Configuration for keyword embedder with BM25 scoring. - `DIMENSION_SPACE` integer — Total dimension space for hash trick (1,048,576 dimensions) - `FILTER_STOPWORDS` boolean — Remove common stopwords to reduce noise - `BM25_K1` number — BM25 term frequency saturation (1.2-2.0). Higher = more weight on term repetition. Default 1.5 works for most cases. - `BM25_B` number — BM25 document length normalization (0.0-1.0). 0=ignore length, 1=full penalty for long docs. Default 0.75 is standard. - `BM25_AVGDL` number — Average document length in tokens. Adjust based on your documents: chat messages ~20-50, articles ~100-300, papers ~1000+ - NonDeveloperConfig — Limited configuration response for non-developer users - `QueryLLM` object, required - `AgentLLM` object, required ## Other responses - `422` — Validation Error ## Changes - **2026-01-21** `1f956ac3d1c1` — 4 info - added the optional property `anyOf[subschema #1: AllConfigs]/Reranker/MAX_CONCURRENT_REQUESTS` to the response with the `200` status - the `DEFAULT_METADATA_TAGS` response's property default value changed from `{"name":"doc_date","instruction":"What is the primary date of this document (creation date, signing date, or effective date)? Return in YYYY-MM-DD format or 'Not found' if no date can be determined.","tag_type":{"options":[],"type":"date"}}, {"name":"doc_nature","instruction":"What is the nature/type of this document? (e.g., email, contract, memorandum, declaration, invoice, letter, report, agreement, etc.)","tag_type":{"options":[],"type":"text"}}, {"name":"doc_author","instruction":"Who is the author or creator of this document? If there are multiple authors, list up to 3 followed by 'et al.' if more exist.","tag_type":{"options":[],"type":"text"}}, {"name":"doc_subject","instruction":"What is the main subject or purpose of this document? Provide a brief 1-2 sentence description.","tag_type":{"options":[],"type":"text"}}` to `{"name":"doc_date","instruction":"What is the primary date of this document (creation date, signing date, or effective date)? Identify the most significant date such as the document's creation, signing, or effective date.","tag_type":{"options":[],"type":"date"}}, {"name":"doc_nature","instruction":"What is the Document type (select one):","tag_type":{"options":["Agreement","Email","Letter","Report","Decision","Memo","Financial","Form","Index","Submission","Other"],"type":"select"}}, {"name":"doc_author","instruction":"Who is the author or creator of this document? If there are multiple authors, list up to 3 followed by 'et al.' if more exist.","tag_type":{"options":[],"type":"text"}}, {"name":"doc_subject","instruction":"What is the main subject or purpose of this document? Provide a brief 1-2 sentence description.","tag_type":{"options":[],"type":"text"}}` for the status `200` - the `DoctagLLM` response's property default value changed from `{"API_TYPE":"remote","MODEL_NAME":"Q30@ARBICITY","SYSTEM_INSTRUCTION":"You are a document analysis assistant. Answer questions based strictly on document content.\n\nGuidelines:\n- Only use information explicitly stated in the document\n- Do not infer or assume information not present\n- If information is not found, respond with \"Information not found in document.\"\n- Follow format instructions exactly for each answer\n- Be concise and precise","MAX_CHAR_CONTEXT_TO_ANSWER":100000,"TEMPERATURE":0.1,"MAX_TOKENS":2000,"MAX_CONCURRENT_DOCS":10,"DEFAULT_METADATA_TAGS":[{"instruction":"What is the primary date of this document (creation date, signing date, or effective date)? Return in YYYY-MM-DD format or 'Not found' if no date can be determined.","name":"doc_date","tag_type":{"options":[],"type":"date"}},{"instruction":"What is the nature/type of this document? (e.g., email, contract, memorandum, declaration, invoice, letter, report, agreement, etc.)","name":"doc_nature","tag_type":{"options":[],"type":"text"}},{"instruction":"Who is the author or creator of this document? If there are multiple authors, list up to 3 followed by 'et al.' if more exist.","name":"doc_author","tag_type":{"options":[],"type":"text"}},{"instruction":"What is the main subject or purpose of this document? Provide a brief 1-2 sentence description.","name":"doc_subject","tag_type":{"options":[],"type":"text"}}]}` to `{"API_TYPE":"remote","MODEL_NAME":"Q30@ARBICITY","SYSTEM_INSTRUCTION":"You are a document analysis assistant. Answer questions based strictly on document content.\n\nGuidelines:\n- Only use information explicitly stated in the document\n- Do not infer or assume information not present\n- If information is not found, respond with \"Information not found in document.\"\n- Follow format instructions exactly for each answer\n- Be concise and precise","MAX_CHAR_CONTEXT_TO_ANSWER":100000,"TEMPERATURE":0.1,"MAX_TOKENS":2000,"MAX_CONCURRENT_DOCS":10,"DEFAULT_METADATA_TAGS":[{"instruction":"What is the primary date of this document (creation date, signing date, or effective date)? Identify the most significant date such as the document's creation, signing, or effective date.","name":"doc_date","tag_type":{"options":[],"type":"date"}},{"instruction":"What is the Document type (select one):","name":"doc_nature","tag_type":{"options":["Agreement","Email","Letter","Report","Decision","Memo","Financial","Form","Index","Submission","Other"],"type":"select"}},{"instruction":"Who is the author or creator of this document? If there are multiple authors, list up to 3 followed by 'et al.' if more exist.","name":"doc_author","tag_type":{"options":[],"type":"text"}},{"instruction":"What is the main subject or purpose of this document? Provide a brief 1-2 sentence description.","name":"doc_subject","tag_type":{"options":[],"type":"text"}}]}` for the status `200` - the `Reranker` response's property default value changed from `{"MAX_NUMB_OF_CHUNKS":30,"MODEL_NAME":"BAAI/bge-reranker-large","API_TYPE":"local"}` to `{"MAX_NUMB_OF_CHUNKS":30,"MAX_CONCURRENT_REQUESTS":64,"MODEL_NAME":"BAAI/bge-reranker-large","API_TYPE":"local"}` for the status `200` - …earlier changes not shown [Full history](https://skmtc.dev/arbicity/apis/arbi/changes/api/configs/:config_ext_id/get.md) --- [API](https://skmtc.dev/arbicity/apis/arbi.md) · [All operations](https://skmtc.dev/arbicity/apis/arbi/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/arbicity/arbi/revisions/1f956ac3d1c1/schema)