curl --request GET \
--url https://api.example.com/v1/knowledge-bases \
--header 'X-API-Key: <api-key>'{
"items": [
{
"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": {},
"version": "v2",
"total_documents": 123,
"training_documents": 123,
"trained_documents": 123,
"error_documents": 123,
"uploaded_documents": 123,
"source_types": {},
"training_source_types": [
"Document"
],
"meta": {},
"settings_": {
"retrieval_info": "",
"retrieval_method": "hybrid_relative_score",
"retrieval_top_k": 25,
"fts_weight": 0.7,
"semantic_weight": 0.3,
"rrf_k": 60,
"threshold_enabled": false,
"threshold": 0,
"reranker_type": "vertex",
"reranker_top_k": 10,
"reranker_threshold_enabled": false,
"reranker_threshold": 0,
"vertex_model": "semantic-ranker-512@latest",
"ingestion_info": "",
"embedding_model": [
"vertexai/text-multilingual-embedding-002"
],
"mm_embedding_model": [
"vertexai/multimodalembedding"
],
"batch_size": 8,
"default_chunk_size": 2048,
"default_chunk_overlap": 512,
"enrich_chunks_mode": "inject_summary",
"enrich_pre_made_qa": false,
"pdf_info": "",
"pdf_extract_images": true,
"pdf_chunk_size": 1024,
"pdf_chunk_overlap": 256,
"pdf_ocr_enabled": false,
"pdf_ocr_confidence": 0.7,
"pdf_ocr_language": "auto",
"text_info": "",
"text_chunking_enabled": true,
"text_chunk_size": 1024,
"text_chunk_overlap": 256,
"text_preserve_formatting": true,
"html_info": "",
"html_extract_text_only": true,
"html_include_tables": true,
"html_include_images": false,
"image_info": "",
"image_ocr_enabled": false,
"image_ocr_confidence": 0.7,
"csv_row_as_document": true,
"csv_include_headers": true,
"csv_auto_detect_delimiter": true,
"csv_delimiter": ",",
"csv_encoding": "utf-8"
}
}
],
"total": 1,
"page": 2,
"size": 2,
"pages": 1
}Get all knowledge bases belonging to a user
curl --request GET \
--url https://api.example.com/v1/knowledge-bases \
--header 'X-API-Key: <api-key>'{
"items": [
{
"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": {},
"version": "v2",
"total_documents": 123,
"training_documents": 123,
"trained_documents": 123,
"error_documents": 123,
"uploaded_documents": 123,
"source_types": {},
"training_source_types": [
"Document"
],
"meta": {},
"settings_": {
"retrieval_info": "",
"retrieval_method": "hybrid_relative_score",
"retrieval_top_k": 25,
"fts_weight": 0.7,
"semantic_weight": 0.3,
"rrf_k": 60,
"threshold_enabled": false,
"threshold": 0,
"reranker_type": "vertex",
"reranker_top_k": 10,
"reranker_threshold_enabled": false,
"reranker_threshold": 0,
"vertex_model": "semantic-ranker-512@latest",
"ingestion_info": "",
"embedding_model": [
"vertexai/text-multilingual-embedding-002"
],
"mm_embedding_model": [
"vertexai/multimodalembedding"
],
"batch_size": 8,
"default_chunk_size": 2048,
"default_chunk_overlap": 512,
"enrich_chunks_mode": "inject_summary",
"enrich_pre_made_qa": false,
"pdf_info": "",
"pdf_extract_images": true,
"pdf_chunk_size": 1024,
"pdf_chunk_overlap": 256,
"pdf_ocr_enabled": false,
"pdf_ocr_confidence": 0.7,
"pdf_ocr_language": "auto",
"text_info": "",
"text_chunking_enabled": true,
"text_chunk_size": 1024,
"text_chunk_overlap": 256,
"text_preserve_formatting": true,
"html_info": "",
"html_extract_text_only": true,
"html_include_tables": true,
"html_include_images": false,
"image_info": "",
"image_ocr_enabled": false,
"image_ocr_confidence": 0.7,
"csv_row_as_document": true,
"csv_include_headers": true,
"csv_auto_detect_delimiter": true,
"csv_delimiter": ",",
"csv_encoding": "utf-8"
}
}
],
"total": 1,
"page": 2,
"size": 2,
"pages": 1
}Page number
x >= 1Page size
1 <= x <= 100