curl --request GET \
--url https://{api_endpoint}/api/v1/orchestrate/knowledge-bases/{id} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"prioritize_built_in_index": true,
"created_by": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"representation": "auto",
"vector_index": {
"embeddings_model_name": "<string>",
"chunk_size": 123,
"chunk_overlap": 123,
"status": "not_ready",
"status_msg": "<string>",
"top_k": 10,
"extraction_strategy": "standard"
},
"conversational_search_tool": {
"language": "en",
"index_config": [
{
"connection_id": "<string>",
"milvus": {
"grpc_host": "<string>",
"database": "<string>",
"collection": "<string>",
"index": "<string>",
"embedding_model_id": "<string>",
"grpc_port": "<string>",
"server_cert": "<string>",
"limit": 10,
"filter": "<string>",
"field_mapping": {
"title": "title",
"body": "text",
"url": "<string>"
}
},
"elastic_search": {
"url": "<string>",
"index": "<string>",
"port": "<string>",
"query_body": {},
"result_filter": [
"<unknown>"
],
"field_mapping": {
"title": "title",
"body": "text",
"url": "<string>"
}
},
"custom_search": {
"url": "<string>",
"filter": "<string>",
"metadata": {}
},
"astradb": {
"api_endpoint": "<string>",
"port": "<string>",
"server_cert": "<string>",
"keyspace": "<string>",
"data_type": "collection",
"collection": "<string>",
"table": "<string>",
"index_column": "<string>",
"embedding_mode": "server",
"embedding_model_id": "<string>",
"search_mode": "vector",
"limit": 5,
"filter": "<string>",
"field_mapping": {
"title": "title",
"body": "text",
"url": "<string>"
}
}
}
],
"generation": {
"model_id": "<string>",
"prompt_instruction": "",
"max_docs_passed_to_llm": 5,
"generated_response_length": "Moderate",
"display_text_no_results_found": "I searched my knowledge base, but did not find anything related to your query",
"display_text_connectivity_issue": "I might have information related to your query to share, but am unable to connect to my knowledge base at the moment",
"idk_message": "I'm afraid I don't understand. Please rephrase your question.",
"enabled": true
},
"query_rewrite": {
"enabled": true,
"model_id": "<string>"
},
"confidence_thresholds": {
"retrieval_confidence_threshold": "Lowest",
"response_confidence_threshold": "Lowest"
},
"citations": {
"citation_title": "How do we know?",
"citations_shown": -1
},
"hap_filtering": {
"output": {
"enabled": false,
"threshold": 0.5
}
},
"query_source": "SessionHistory",
"agent_query_description": "The query to search for in the knowledge base",
"supports_full_document": false
}
}Retrieves details of a specific agent by its id.
curl --request GET \
--url https://{api_endpoint}/api/v1/orchestrate/knowledge-bases/{id} \
--header 'Authorization: Bearer <token>'{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"name": "<string>",
"display_name": "<string>",
"description": "<string>",
"prioritize_built_in_index": true,
"created_by": "<string>",
"updated_at": "2023-11-07T05:31:56Z",
"representation": "auto",
"vector_index": {
"embeddings_model_name": "<string>",
"chunk_size": 123,
"chunk_overlap": 123,
"status": "not_ready",
"status_msg": "<string>",
"top_k": 10,
"extraction_strategy": "standard"
},
"conversational_search_tool": {
"language": "en",
"index_config": [
{
"connection_id": "<string>",
"milvus": {
"grpc_host": "<string>",
"database": "<string>",
"collection": "<string>",
"index": "<string>",
"embedding_model_id": "<string>",
"grpc_port": "<string>",
"server_cert": "<string>",
"limit": 10,
"filter": "<string>",
"field_mapping": {
"title": "title",
"body": "text",
"url": "<string>"
}
},
"elastic_search": {
"url": "<string>",
"index": "<string>",
"port": "<string>",
"query_body": {},
"result_filter": [
"<unknown>"
],
"field_mapping": {
"title": "title",
"body": "text",
"url": "<string>"
}
},
"custom_search": {
"url": "<string>",
"filter": "<string>",
"metadata": {}
},
"astradb": {
"api_endpoint": "<string>",
"port": "<string>",
"server_cert": "<string>",
"keyspace": "<string>",
"data_type": "collection",
"collection": "<string>",
"table": "<string>",
"index_column": "<string>",
"embedding_mode": "server",
"embedding_model_id": "<string>",
"search_mode": "vector",
"limit": 5,
"filter": "<string>",
"field_mapping": {
"title": "title",
"body": "text",
"url": "<string>"
}
}
}
],
"generation": {
"model_id": "<string>",
"prompt_instruction": "",
"max_docs_passed_to_llm": 5,
"generated_response_length": "Moderate",
"display_text_no_results_found": "I searched my knowledge base, but did not find anything related to your query",
"display_text_connectivity_issue": "I might have information related to your query to share, but am unable to connect to my knowledge base at the moment",
"idk_message": "I'm afraid I don't understand. Please rephrase your question.",
"enabled": true
},
"query_rewrite": {
"enabled": true,
"model_id": "<string>"
},
"confidence_thresholds": {
"retrieval_confidence_threshold": "Lowest",
"response_confidence_threshold": "Lowest"
},
"citations": {
"citation_title": "How do we know?",
"citations_shown": -1
},
"hap_filtering": {
"output": {
"enabled": false,
"threshold": 0.5
}
},
"query_source": "SessionHistory",
"agent_query_description": "The query to search for in the knowledge base",
"supports_full_document": false
}
}Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Successful Response
Unique identifier for the KB
ID of the tenant that owns this KB
Name of the KB
Display name of the KB
Description of what the KB contains
prioritize built in vector index if both a built in index and external index is provided
Username of the user who created the KB
Last update timestamp
auto, tool Show child attributes
ready, not_ready, rebuilding, error, update_pending express, standard, high_quality Show child attributes
Show child attributes
example: { "grpc_host": "https://xxxx.lakehouse.appdomain.cloud", "database": "test_db", "collection": "search_wa_docs", "index": "dense", "embedding_model_id": "sentence-transformers/all-minilm-l12-v2", "grpc_port": "30564", "filter": "title like "%action%"", "limit": 10, "field_mapping": { "title": "title", "body": "text", "url": "some-url" } }
Show child attributes
example
{ "title": "title", "body": "text", "url": "some-url" }
example:
{ "url": "https://xxxx.databases.appdomain.cloud", "index": "search-wa-docs", "port": "31871", "query_body": {"size":5,"query":{"text_expansion":{"ml.tokens":{"model_id":".elser_model_2_linux-x86_64","model_text": "$QUERY"}}}}, "result_filter": [ { "match": { "title": "A_keyword_in_title" } }, { "match": { "text": "A_keyword_in_text" } }, { "match": { "id": "A_specific_ID" } } ], "field_mapping": { "title": "title", "body": "text", "url": "some-url" } }
Show child attributes
example
{ "title": "title", "body": "text", "url": "some-url" }
example:
{ "url": "https://customsearch.xxxx.us-east.codeengine.appdomain.cloud", "filter": "...", "metadata": {...} }
example: { "api_endpoint": "https://xxx-us-east-2.apps.astra.datastax.com", "key_space": "default_keyspace", "collection": "search_wa_docs", "embedding_model_id": "sentence-transformers/all-minilm-l12-v2", "port": "443", "filter": "productType: "boots"", "limit": 5, "field_mapping": { "title": "title", "body": "text", "url": "some-url" } }
Show child attributes
collection, table server, client vector, hybrid, lexical example
{ "title": "title", "body": "text", "url": "some-url" }
example { "model_id": "meta-llama/llama-3-1-70b-instruct", "prompt_instruction": "When the documents are in different languages, you should respond in english.", "max_docs_passed_to_llm": 5, "retrieval_confidence_threshold": "Lowest", "generated_response_length": "Moderate", "response_confidence_threshold": "Low", "display_text_no_results_found": "no docs found", "display_text_connectivity_issue": "conn failed", }
Show child attributes
Concise, Moderate, Verbose Show child attributes
Off, Lowest, Low, High, Highest Off, Lowest, Low, High, Highest example { "output": { "enabled": True, "threshold": 0.7, } }
SessionHistory, Agent