Release Notes
- What's new
- Known issues
- Troubleshooting
- License reference
Get Started
Environments
Large Language Models (LLMs)
Webchats
Tutorials
API's reference
- watsonx Orchestrate Developer Edition APIs
- Orchestrate Agent
- Custom Assistants
- watsonx Assistant
- External Chat Agents
- Message Threads
- Models
- Embed settings
- Completions
- Prompts
- Default Agent Settings
- Tools
- Welcome Content
- LLM Analytics
- Agents
- Agent Releases
- Agent Release Environments
- API Reference
- Channel integration
- Knowledge-Bases
- POSTCreate A Knowledge-Base By Uploading Documents, Or Providing A External Vector Index
- PUTIngest Additional Documents Into A Knowledge-Base
- PATCHPatch A Knowledge-Base By Uploading Documents, Or Providing A External Vector Index
- GETGet A Kb By Id.
- DELDelete A Kb And Ingested Documents By Id
- DELDelete Some Ingested Documents From A Knowledge-Base
- GETKnowledge-Base Status
- GETFetch Knowledge-Bases
- POST
- Toolkits
- GETAlive
- GETReady
Legal notices
Knowledge-Bases
Get A Kb By Id.
Retrieves details of a specific agent by its id.
GET
/
orchestrate
/
knowledge-bases
/
{id}
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/orchestrate/knowledge-bases/{id} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"name": "<string>",
"description": "<string>",
"prioritize_built_in_index": true,
"representation": "auto",
"conversational_search_tool": {
"language": "en",
"index_config": [
{
"connection_id": "<string>",
"milvus": {
"grpc_host": "<string>",
"database": "<string>",
"collection": "<string>",
"index": "<string>",
"embedding_model_id": "<string>",
"limit": 10,
"grpc_port": "<string>",
"filter": "<string>",
"field_mapping": {
"title": "<string>",
"body": "<string>",
"url": "<string>"
}
},
"elastic_search": {
"url": "<string>",
"index": "<string>",
"port": "<string>",
"query_body": {},
"result_filter": [
"<any>"
],
"field_mapping": {
"title": "<string>",
"body": "<string>",
"url": "<string>"
}
}
}
],
"generation": {
"model_id": "<string>",
"prompt_instruction": "",
"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"
},
"query_rewrite": {
"enabled": true,
"model_id": "<string>"
},
"confidence_thresholds": {
"retrieval_confidence_threshold": "Low",
"response_confidence_threshold": "Low"
},
"citations": {
"citation_title": "How do we know?",
"citations_shown": -1
},
"hap_filtering": {
"output": {
"enabled": false,
"threshold": 0.5
}
}
}
}
Authorizations
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
Response
200
application/json
Successful Response
The response is of type object
.
Copy
Ask AI
curl --request GET \
--url http://localhost/api/v1/orchestrate/knowledge-bases/{id} \
--header 'Authorization: Bearer <token>'
Copy
Ask AI
{
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tenant_id": "<string>",
"name": "<string>",
"description": "<string>",
"prioritize_built_in_index": true,
"representation": "auto",
"conversational_search_tool": {
"language": "en",
"index_config": [
{
"connection_id": "<string>",
"milvus": {
"grpc_host": "<string>",
"database": "<string>",
"collection": "<string>",
"index": "<string>",
"embedding_model_id": "<string>",
"limit": 10,
"grpc_port": "<string>",
"filter": "<string>",
"field_mapping": {
"title": "<string>",
"body": "<string>",
"url": "<string>"
}
},
"elastic_search": {
"url": "<string>",
"index": "<string>",
"port": "<string>",
"query_body": {},
"result_filter": [
"<any>"
],
"field_mapping": {
"title": "<string>",
"body": "<string>",
"url": "<string>"
}
}
}
],
"generation": {
"model_id": "<string>",
"prompt_instruction": "",
"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"
},
"query_rewrite": {
"enabled": true,
"model_id": "<string>"
},
"confidence_thresholds": {
"retrieval_confidence_threshold": "Low",
"response_confidence_threshold": "Low"
},
"citations": {
"citation_title": "How do we know?",
"citations_shown": -1
},
"hap_filtering": {
"output": {
"enabled": false,
"threshold": 0.5
}
}
}
}
Assistant
Responses are generated using AI and may contain mistakes.