Skip to main content
PATCH
/
v1
/
knowledge-bases
/
{knowledge_base_id}
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "group_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "status": "created",
  "description": "<string>",
  "document_types": [
    "<string>"
  ],
  "kb_type": "temporary",
  "size": 123,
  "num_docs": 123,
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z",
  "error": {},
  "total_documents": 123,
  "training_documents": 123,
  "trained_documents": 123,
  "error_documents": 123,
  "uploaded_documents": 123,
  "source_types": {},
  "training_source_types": [
    "Document"
  ],
  "settings_": {
    "allowed_sources": [
      "Document",
      "Google Drive",
      "OneDrive",
      "Website"
    ],
    "ingestion": {
      "batch_size": 8,
      "default_chunk_size": 1024,
      "default_chunk_overlap": 256,
      "enrich_chunks_mode": "inject_summary",
      "enrich_pre_made_qa": false,
      "methods": {
        "application/pdf": {
          "chunk_overlap": 256,
          "chunk_size": 1024,
          "enrich_chunks_mode": "inject_summary",
          "extract_images": true,
          "extract_qa_pairs": false,
          "supported_mime_types": [
            "application/pdf",
            "application/vnd.openxmlformats-officedocument.wordprocessingml.document",
            "application/vnd.openxmlformats-officedocument.presentationml.presentation",
            "application/msword",
            "application/vnd.ms-powerpoint"
          ],
          "type": "pdf"
        },
        "default": {
          "chunk_size": 1024,
          "chunk_overlap": 256,
          "enrich_chunks_mode": "inject_summary",
          "extract_qa_pairs": false,
          "type": "default",
          "supported_mime_types": [
            "text/plain",
            "text/html",
            "text/markdown",
            "application/json"
          ]
        },
        "image/*": {
          "supported_mime_types": [
            "image/jpeg",
            "image/png",
            "image/bmp"
          ],
          "type": "image"
        },
        "text/html": {
          "chunk_overlap": 256,
          "chunk_size": 1024,
          "enrich_chunks_mode": "inject_summary",
          "extract_qa_pairs": false,
          "extract_text_only": true,
          "include_images": false,
          "include_tables": true,
          "supported_mime_types": [
            "text/html"
          ],
          "type": "html"
        },
        "text/plain": {
          "chunk_overlap": 256,
          "chunk_size": 1024,
          "chunking": true,
          "enrich_chunks_mode": "inject_summary",
          "extract_qa_pairs": false,
          "preserve_formatting": true,
          "supported_mime_types": [
            "text/plain",
            "text/html",
            "text/markdown",
            "application/json"
          ],
          "type": "text"
        }
      }
    },
    "retrieval": {
      "type": "hybrid_reranking",
      "hybrid_settings": {
        "fts_weight": 0.7,
        "full_text_search": {
          "type": "full_text_search"
        },
        "semantic_search": {
          "sets_threshold": false,
          "threshold": 0,
          "top_k": 25,
          "type": "semantic"
        },
        "semantic_weight": 0.3,
        "threshold": 0,
        "type": "hybrid_relative_score"
      },
      "reranker_settings": {
        "model_name": "semantic-ranker-512@latest",
        "ranking_config": "default_ranking_config",
        "sets_threshold": false,
        "threshold": 0,
        "top_k": 10,
        "type": "vertex"
      }
    },
    "embeddings": {
      "text_model": "vertexai/text-multilingual-embedding-002",
      "mm_model": "vertexai/multimodalembedding@001"
    }
  }
}

Authorizations

​
X-API-Key
string
header
required

Path Parameters

​
knowledge_base_id
string
required

Body

application/json
​
name
string | null
​
description
string | null
​
status
enum<string> | null
Available options:
created,
trained,
training,
error
​
document_types
string[] | null
​
kb_type
enum<string> | null
Available options:
temporary,
entity
​
error
Error · object
​
summary
string | null
​
summary_embedding
number[] | null
​
needs_summary_update
boolean | null
​
settings_
KnowledgeBaseSettings · object

Response

Successful Response

​
id
string<uuid>
required
​
group_id
string<uuid>
required
​
name
string
required
​
status
enum<string>
required
Available options:
created,
trained,
training,
error
​
description
string
required
​
document_types
string[]
required
​
kb_type
enum<string>
required
Available options:
temporary,
entity
​
size
number
required
​
num_docs
integer
required
​
created_at
string<date-time>
required
​
updated_at
string<date-time>
required
​
error
Error · object
required
​
total_documents
integer
required
​
training_documents
integer
required
​
trained_documents
integer
required
​
error_documents
integer
required
​
uploaded_documents
integer
required
​
source_types
Source Types · object
required
​
training_source_types
enum<string>[]
required
Available options:
Document,
Google Drive,
Notion,
Website,
OneDrive,
Slack,
Linear,
Github,
Teams,
Sharepoint,
Custom
​
settings_
KnowledgeBaseSettings · object