GET
/
orchestrate
/
knowledge-bases
/
{id}
curl --request GET \
  --url http://localhost/api/v1/orchestrate/knowledge-bases/{id} \
  --header 'Authorization: Bearer <token>'
{
  "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

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

Response

200
application/json

Successful Response

The response is of type object.