{"openapi":"3.1.0","info":{"title":"TiDB.AI","version":"0.1.0"},"paths":{"/api/v1/healthz":{"get":{"tags":["index"],"summary":"Status","operationId":"index-status","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}}}}},"/api/v1/site-config":{"get":{"tags":["index"],"summary":"Site Config","operationId":"index-site_config","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":true,"type":"object","title":"Response Index-Site Config"}}}}}}},"/api/v1/system/bootstrap-status":{"get":{"tags":["index"],"summary":"System Bootstrap Status","operationId":"index-system_bootstrap_status","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/SystemConfigStatusResponse"}}}}}}},"/api/v1/chats":{"post":{"tags":["chat"],"summary":"Chats","operationId":"chat-chats","security":[{"APIKeyCookie":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["chat"],"summary":"List Chats","operationId":"chat-list_chats","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"filters","in":"query","required":true,"schema":{"$ref":"#/components/schemas/ChatFilters"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_Chat_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/chats/{chat_id}":{"get":{"tags":["chat"],"summary":"Get Chat","operationId":"chat-get_chat","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"chat_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Chat Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["chat"],"summary":"Update Chat","operationId":"chat-update_chat","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"chat_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Chat Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["chat"],"summary":"Delete Chat","operationId":"chat-delete_chat","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"chat_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","title":"Chat Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/chat-messages/{chat_message_id}/subgraph":{"get":{"tags":["chat"],"summary":"Get Chat Subgraph","operationId":"chat-get_chat_subgraph","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"chat_message_id","in":"path","required":true,"schema":{"type":"integer","title":"Chat Message Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrievedKnowledgeGraph"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/chat-messages/{chat_message_id}/recommended-questions":{"get":{"tags":["chat"],"summary":"Get Recommended Questions","operationId":"chat-get_recommended_questions","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"chat_message_id","in":"path","required":true,"schema":{"type":"integer","title":"Chat Message Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"title":"Response Chat-Get Recommended Questions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["chat"],"summary":"Refresh Recommended Questions","operationId":"chat-refresh_recommended_questions","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"chat_message_id","in":"path","required":true,"schema":{"type":"integer","title":"Chat Message Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"type":"string"},"title":"Response Chat-Refresh Recommended Questions"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/chat-messages/{chat_message_id}/feedback":{"post":{"tags":["chat"],"summary":"Feedback","operationId":"chat-feedback","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"chat_message_id","in":"path","required":true,"schema":{"type":"integer","title":"Chat Message Id"}},{"name":"origin","in":"header","required":false,"schema":{"type":"string","title":"Origin"}},{"name":"referer","in":"header","required":false,"schema":{"type":"string","title":"Referer"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/FeedbackRequest"}}}},"responses":{"201":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/users/me":{"get":{"tags":["user"],"summary":"Me","operationId":"user-me","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/UserRead"}}}}},"security":[{"APIKeyCookie":[]}]}},"/api/v1/api-keys":{"post":{"tags":["auth"],"summary":"Create Api Key","operationId":"auth-create_api_key","security":[{"APIKeyCookie":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiKeyRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateApiKeyResponse"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["auth"],"summary":"List Api Keys","operationId":"auth-list_api_keys","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_PublicApiKey_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/api-keys/{api_key_id}":{"delete":{"tags":["auth"],"summary":"Delete Api Key","operationId":"auth-delete_api_key","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"api_key_id","in":"path","required":true,"schema":{"type":"integer","title":"Api Key Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/documents/{doc_id}/download":{"get":{"tags":["documents"],"summary":"Download File","operationId":"documents-download_file","parameters":[{"name":"doc_id","in":"path","required":true,"schema":{"type":"integer","title":"Doc Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/chat-engines":{"get":{"tags":["chat-engines"],"summary":"List Chat Engines","operationId":"chat-engines-list_chat_engines","parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_ChatEngine_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/chat-engines/{chat_engine_id}":{"get":{"tags":["chat-engines"],"summary":"Get Chat Engine","operationId":"chat-engines-get_chat_engine","parameters":[{"name":"chat_engine_id","in":"path","required":true,"schema":{"type":"integer","title":"Chat Engine Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatEngine"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/retrieve/chunks":{"post":{"tags":["retrieve"],"summary":"Retrieve Chunks","operationId":"retrieve-retrieve_chunks","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChunksRetrievalRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChunksRetrievalResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyCookie":[]}]}},"/api/v1/retrieve/knowledge_graph":{"post":{"tags":["retrieve"],"summary":"Retrieve Knowledge Graph","operationId":"retrieve-retrieve_knowledge_graph","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeGraphRetrievalRequest"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrievedKnowledgeGraph"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyCookie":[]}]}},"/api/v1/admin/chats/origins":{"get":{"tags":["admin/chats"],"summary":"List Chat Origins","operationId":"admin/chats-list_chat_origins","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_ChatOrigin_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/chat-engines":{"get":{"tags":["admin/chat-engines"],"summary":"List Chat Engines","operationId":"admin/chat-engines-list_chat_engines","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_ChatEngine_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["admin/chat-engines"],"summary":"Create Chat Engine","operationId":"admin/chat-engines-create_chat_engine","security":[{"APIKeyCookie":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatEngine"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatEngine"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/chat-engines/{chat_engine_id}":{"get":{"tags":["admin/chat-engines"],"summary":"Get Chat Engine","operationId":"admin/chat-engines-get_chat_engine","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"chat_engine_id","in":"path","required":true,"schema":{"type":"integer","title":"Chat Engine Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatEngine"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["admin/chat-engines"],"summary":"Update Chat Engine","operationId":"admin/chat-engines-update_chat_engine","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"chat_engine_id","in":"path","required":true,"schema":{"type":"integer","title":"Chat Engine Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatEngineUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatEngine"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["admin/chat-engines"],"summary":"Delete Chat Engine","operationId":"admin/chat-engines-delete_chat_engine","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"chat_engine_id","in":"path","required":true,"schema":{"type":"integer","title":"Chat Engine Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatEngine"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/chat-engines-default-config":{"get":{"tags":["admin/chat-engines"],"summary":"Get Default Config","operationId":"admin/chat-engines-get_default_config","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatEngineConfig"}}}}},"security":[{"APIKeyCookie":[]}]}},"/api/v1/admin/documents":{"get":{"tags":["admin/documents"],"summary":"List Documents","operationId":"admin/documents-list_documents","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"filters","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DocumentFilters"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_DocumentItem_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/feedbacks/":{"get":{"tags":["admin/feedback"],"summary":"List Feedbacks","operationId":"admin/feedback-list_feedbacks","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"filters","in":"query","required":true,"schema":{"$ref":"#/components/schemas/FeedbackFilters"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_AdminFeedbackPublic_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/feedbacks/origins":{"get":{"tags":["admin/feedback"],"summary":"List Feedback Origins","operationId":"admin/feedback-list_feedback_origins","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_FeedbackOrigin_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/site-settings":{"get":{"tags":["admin/site_settings"],"summary":"Site Settings","operationId":"admin/site_settings-site_settings","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"additionalProperties":{"$ref":"#/components/schemas/SettingValue"},"type":"object","title":"Response Admin/Site Settings-Site Settings"}}}}},"security":[{"APIKeyCookie":[]}]}},"/api/v1/admin/site-settings/{setting_name}":{"put":{"tags":["admin/site_settings"],"summary":"Update Site Setting","operationId":"admin/site_settings-update_site_setting","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"setting_name","in":"path","required":true,"schema":{"type":"string","title":"Setting Name"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SettingUpdate"}}}},"responses":{"204":{"description":"Successful Response"},"400":{"content":{"application/json":{"examples":{"invalid_data_type":{"summary":"Invalid data type","value":{"detail":"title must be of type `str`"}}}}},"description":"Bad Request"},"404":{"content":{"application/json":{"examples":{"setting_not_found":{"summary":"Setting not found","value":{"detail":"Setting not found"}}}}},"description":"Not Found"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/uploads":{"post":{"tags":["admin/upload"],"summary":"Upload Files","operationId":"admin/upload-upload_files","requestBody":{"content":{"multipart/form-data":{"schema":{"$ref":"#/components/schemas/Body_admin_upload-upload_files"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/Upload"},"type":"array","title":"Response Admin/Upload-Upload Files"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyCookie":[]}]}},"/api/v1/admin/knowledge_bases":{"post":{"tags":["admin/knowledge_base"],"summary":"Create Knowledge Base","operationId":"admin/knowledge_base-create_knowledge_base","security":[{"APIKeyCookie":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["admin/knowledge_base"],"summary":"List Knowledge Bases","operationId":"admin/knowledge_base-list_knowledge_bases","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_KnowledgeBaseItem_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{knowledge_base_id}":{"get":{"tags":["admin/knowledge_base"],"summary":"Get Knowledge Base","operationId":"admin/knowledge_base-get_knowledge_base","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"integer","title":"Knowledge Base Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["admin/knowledge_base"],"summary":"Update Knowledge Base Setting","operationId":"admin/knowledge_base-update_knowledge_base_setting","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"integer","title":"Knowledge Base Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeBaseDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/linked_chat_engines":{"get":{"tags":["admin/knowledge_base"],"summary":"List Kb Linked Chat Engines","operationId":"admin/knowledge_base-list_kb_linked_chat_engines","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChatEngineDescriptor"},"title":"Response Admin/Knowledge Base-List Kb Linked Chat Engines"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}":{"delete":{"tags":["admin/knowledge_base"],"summary":"Delete Knowledge Base","operationId":"admin/knowledge_base-delete_knowledge_base","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{knowledge_base_id}/overview":{"get":{"tags":["admin/knowledge_base"],"summary":"Get Knowledge Base Index Overview","operationId":"admin/knowledge_base-get_knowledge_base_index_overview","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"knowledge_base_id","in":"path","required":true,"schema":{"type":"integer","title":"Knowledge Base Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Admin/Knowledge Base-Get Knowledge Base Index Overview"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/vector-index-errors":{"get":{"tags":["admin/knowledge_base"],"summary":"List Kb Vector Index Errors","operationId":"admin/knowledge_base-list_kb_vector_index_errors","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_VectorIndexError_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/kg-index-errors":{"get":{"tags":["admin/knowledge_base"],"summary":"List Kb Kg Index Errors","operationId":"admin/knowledge_base-list_kb_kg_index_errors","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_KGIndexError_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/retry-failed-index-tasks":{"post":{"tags":["admin/knowledge_base"],"summary":"Retry Failed Tasks","operationId":"admin/knowledge_base-retry_failed_tasks","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Admin/Knowledge Base-Retry Failed Tasks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/graph/entities/search":{"get":{"tags":["admin/knowledge_base/graph/knowledge"],"summary":"Search Similar Entities","operationId":"admin/knowledge_base/graph/knowledge-search_similar_entities","parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"query","in":"query","required":true,"schema":{"type":"string","title":"Query"}},{"name":"top_k","in":"query","required":false,"schema":{"type":"integer","default":10,"title":"Top K"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/EntityPublic"},"title":"Response Admin/Knowledge Base/Graph/Knowledge-Search Similar Entities"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/graph/entities/synopsis":{"post":{"tags":["admin/knowledge_base/graph/knowledge"],"summary":"Create Synopsis Entity","operationId":"admin/knowledge_base/graph/knowledge-create_synopsis_entity","parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/SynopsisEntityCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityPublic"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/graph/entities/{entity_id}":{"get":{"tags":["admin/knowledge_base/graph/knowledge"],"summary":"Get Entity","operationId":"admin/knowledge_base/graph/knowledge-get_entity","parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"entity_id","in":"path","required":true,"schema":{"type":"integer","title":"Entity Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityPublic"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["admin/knowledge_base/graph/knowledge"],"summary":"Update Entity","operationId":"admin/knowledge_base/graph/knowledge-update_entity","parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"entity_id","in":"path","required":true,"schema":{"type":"integer","title":"Entity Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EntityPublic"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/graph/entities/{entity_id}/subgraph":{"get":{"tags":["admin/knowledge_base/graph/knowledge"],"summary":"Get Entity Subgraph","operationId":"admin/knowledge_base/graph/knowledge-get_entity_subgraph","parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"entity_id","in":"path","required":true,"schema":{"type":"integer","title":"Entity Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Admin/Knowledge Base/Graph/Knowledge-Get Entity Subgraph"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/graph/relationships/{relationship_id}":{"get":{"tags":["admin/knowledge_base/graph/knowledge"],"summary":"Get Relationship","operationId":"admin/knowledge_base/graph/knowledge-get_relationship","parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"relationship_id","in":"path","required":true,"schema":{"type":"integer","title":"Relationship Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipPublic"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["admin/knowledge_base/graph/knowledge"],"summary":"Update Relationship","operationId":"admin/knowledge_base/graph/knowledge-update_relationship","parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"relationship_id","in":"path","required":true,"schema":{"type":"integer","title":"Relationship Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RelationshipPublic"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/graph/retrieve":{"post":{"tags":["admin/knowledge_base/graph/knowledge"],"summary":"Retrieve Kb Knowledge Graph","operationId":"admin/knowledge_base/graph/knowledge-retrieve_kb_knowledge_graph","parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KBRetrieveKnowledgeGraphRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RetrievedKnowledgeGraph"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/graph/search":{"post":{"tags":["admin/knowledge_base/graph/knowledge"],"summary":"Legacy Search Graph","operationId":"admin/knowledge_base/graph/knowledge-legacy_search_graph","deprecated":true,"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/GraphSearchRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/graph/entire_graph":{"post":{"tags":["admin/knowledge_base/graph/knowledge"],"summary":"Get Entire Knowledge Graph","operationId":"admin/knowledge_base/graph/knowledge-get_entire_knowledge_graph","parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/graph/entire_graph/stream":{"get":{"tags":["admin/knowledge_base/graph/knowledge"],"summary":"Stream Entire Knowledge Graph","operationId":"admin/knowledge_base/graph/knowledge-stream_entire_knowledge_graph","parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/graph/knowledge":{"post":{"tags":["admin/knowledge_base/graph/knowledge"],"summary":"Retrieve Knowledge","operationId":"admin/knowledge_base/graph/knowledge-retrieve_knowledge","parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/graph/knowledge/neighbors":{"post":{"tags":["admin/knowledge_base/graph/knowledge"],"summary":"Retrieve Knowledge Neighbors","operationId":"admin/knowledge_base/graph/knowledge-retrieve_knowledge_neighbors","parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeNeighborRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/graph/knowledge/chunks":{"post":{"tags":["admin/knowledge_base/graph/knowledge"],"summary":"Retrieve Knowledge Chunks","operationId":"admin/knowledge_base/graph/knowledge-retrieve_knowledge_chunks","parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KnowledgeChunkRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/datasources":{"post":{"tags":["admin/knowledge_base/data_source"],"summary":"Create Kb Datasource","operationId":"admin/knowledge_base/data_source-create_kb_datasource","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KBDataSourceCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KBDataSource"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["admin/knowledge_base/data_source"],"summary":"List Kb Datasources","operationId":"admin/knowledge_base/data_source-list_kb_datasources","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_KBDataSource_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/datasources/{data_source_id}":{"put":{"tags":["admin/knowledge_base/data_source"],"summary":"Update Kb Datasource","operationId":"admin/knowledge_base/data_source-update_kb_datasource","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"data_source_id","in":"path","required":true,"schema":{"type":"integer","title":"Data Source Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KBDataSourceUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KBDataSource"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["admin/knowledge_base/data_source"],"summary":"Get Kb Datasource","operationId":"admin/knowledge_base/data_source-get_kb_datasource","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"data_source_id","in":"path","required":true,"schema":{"type":"integer","title":"Data Source Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/KBDataSource"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["admin/knowledge_base/data_source"],"summary":"Remove Kb Datasource","operationId":"admin/knowledge_base/data_source-remove_kb_datasource","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"data_source_id","in":"path","required":true,"schema":{"type":"integer","title":"Data Source Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/documents":{"get":{"tags":["admin/knowledge_base/document"],"summary":"List Kb Documents","operationId":"admin/knowledge_base/document-list_kb_documents","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"filters","in":"query","required":true,"schema":{"$ref":"#/components/schemas/DocumentFilters"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_DocumentItem_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/documents/{doc_id}":{"get":{"tags":["admin/knowledge_base/document"],"summary":"Get Kb Document By Id","operationId":"admin/knowledge_base/document-get_kb_document_by_id","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"doc_id","in":"path","required":true,"schema":{"type":"integer","title":"Doc Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Document"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/documents/{doc_id}/chunks":{"get":{"tags":["admin/knowledge_base/document"],"summary":"List Kb Document Chunks","operationId":"admin/knowledge_base/document-list_kb_document_chunks","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"doc_id","in":"path","required":true,"schema":{"type":"integer","title":"Doc Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/ChunkItem"},"title":"Response Admin/Knowledge Base/Document-List Kb Document Chunks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/documents/{document_id}":{"delete":{"tags":["admin/knowledge_base/document"],"summary":"Remove Kb Document","operationId":"admin/knowledge_base/document-remove_kb_document","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"document_id","in":"path","required":true,"schema":{"type":"integer","title":"Document Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RebuildIndexResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/documents/reindex":{"post":{"tags":["admin/knowledge_base/document"],"summary":"Rebuild Kb Documents Index","operationId":"admin/knowledge_base/document-rebuild_kb_documents_index","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"reindex_completed_task","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Reindex Completed Task"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"array","items":{"type":"integer"},"title":"Document Ids"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_bases/{kb_id}/documents/{doc_id}/reindex":{"post":{"tags":["admin/knowledge_base/document"],"summary":"Rebuild Kb Document Index","operationId":"admin/knowledge_base/document-rebuild_kb_document_index","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}},{"name":"doc_id","in":"path","required":true,"schema":{"type":"integer","title":"Doc Id"}},{"name":"reindex_completed_task","in":"query","required":false,"schema":{"type":"boolean","default":false,"title":"Reindex Completed Task"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/RebuildIndexResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/knowledge_base/{kb_id}/chunks/retrieve":{"post":{"tags":["admin/knowledge_base/chunk"],"summary":"Retrieve Chunks","operationId":"admin/knowledge_base/chunk-retrieve_chunks","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"kb_id","in":"path","required":true,"schema":{"type":"integer","title":"Kb Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/KBRetrieveChunksRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChunksRetrievalResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/llms/providers/options":{"get":{"tags":["admin/llm"],"summary":"List Llm Provider Options","operationId":"admin/llm-list_llm_provider_options","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/LLMProviderOption"},"type":"array","title":"Response Admin/Llm-List Llm Provider Options"}}}}},"security":[{"APIKeyCookie":[]}]}},"/api/v1/admin/llms":{"get":{"tags":["admin/llm"],"summary":"List Llms","operationId":"admin/llm-list_llms","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_AdminLLM_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["admin/llm"],"summary":"Create Llm","operationId":"admin/llm-create_llm","security":[{"APIKeyCookie":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LLM"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminLLM"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/llms/test":{"post":{"tags":["admin/llm"],"summary":"Test Llm","operationId":"admin/llm-test_llm","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LLM"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LLMTestResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyCookie":[]}]}},"/api/v1/admin/llms/{llm_id}":{"get":{"tags":["admin/llm"],"summary":"Get Llm","operationId":"admin/llm-get_llm","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"llm_id","in":"path","required":true,"schema":{"type":"integer","title":"Llm Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminLLM"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["admin/llm"],"summary":"Update Llm","operationId":"admin/llm-update_llm","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"llm_id","in":"path","required":true,"schema":{"type":"integer","title":"Llm Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LLMUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminLLM"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["admin/llm"],"summary":"Delete Llm","operationId":"admin/llm-delete_llm","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"llm_id","in":"path","required":true,"schema":{"type":"integer","title":"Llm Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/llms/{llm_id}/set_default":{"put":{"tags":["admin/llm"],"summary":"Set Default Llm","operationId":"admin/llm-set_default_llm","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"llm_id","in":"path","required":true,"schema":{"type":"integer","title":"Llm Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminLLM"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/embedding-models/providers/options":{"get":{"tags":["admin/embedding_model"],"summary":"List Embedding Model Provider Options","operationId":"admin/embedding_model-list_embedding_model_provider_options","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/EmbeddingProviderOption"},"type":"array","title":"Response Admin/Embedding Model-List Embedding Model Provider Options"}}}}},"security":[{"APIKeyCookie":[]}]}},"/api/v1/admin/embedding-models":{"get":{"tags":["admin/embedding_model"],"summary":"List Embedding Models","operationId":"admin/embedding_model-list_embedding_models","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_EmbeddingModelItem_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["admin/embedding_model"],"summary":"Create Embedding Model","operationId":"admin/embedding_model-create_embedding_model","security":[{"APIKeyCookie":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingModelCreate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingModelDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/embedding-models/test":{"post":{"tags":["admin/embedding_model"],"summary":"Test Embedding Model","operationId":"admin/embedding_model-test_embedding_model","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingModelCreate"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingModelTestResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyCookie":[]}]}},"/api/v1/admin/embedding-models/{model_id}":{"get":{"tags":["admin/embedding_model"],"summary":"Get Embedding Model Detail","operationId":"admin/embedding_model-get_embedding_model_detail","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"integer","title":"Model Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingModelDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["admin/embedding_model"],"summary":"Update Embedding Model","operationId":"admin/embedding_model-update_embedding_model","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"integer","title":"Model Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingModelUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingModelDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["admin/embedding_model"],"summary":"Delete Embedding Model","operationId":"admin/embedding_model-delete_embedding_model","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"integer","title":"Model Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/embedding-models/{model_id}/set_default":{"put":{"tags":["admin/embedding_model"],"summary":"Set Default Embedding Model","operationId":"admin/embedding_model-set_default_embedding_model","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"integer","title":"Model Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EmbeddingModelDetail"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/reranker-models/providers/options":{"get":{"tags":["admin/reranker_model"],"summary":"List Reranker Model Provider Options","operationId":"admin/reranker_model-list_reranker_model_provider_options","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"items":{"$ref":"#/components/schemas/RerankerProviderOption"},"type":"array","title":"Response Admin/Reranker Model-List Reranker Model Provider Options"}}}}},"security":[{"APIKeyCookie":[]}]}},"/api/v1/admin/reranker-models":{"get":{"tags":["admin/reranker_model"],"summary":"List Reranker Models","operationId":"admin/reranker_model-list_reranker_models","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_AdminRerankerModel_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["admin/reranker_model"],"summary":"Create Reranker Model","operationId":"admin/reranker_model-create_reranker_model","security":[{"APIKeyCookie":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RerankerModel"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminRerankerModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/reranker-models/test":{"post":{"tags":["admin/reranker_model"],"summary":"Test Reranker Model","operationId":"admin/reranker_model-test_reranker_model","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RerankerModel"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LLMTestResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyCookie":[]}]}},"/api/v1/admin/reranker-models/{model_id}":{"get":{"tags":["admin/reranker_model"],"summary":"Get Reranker Model","operationId":"admin/reranker_model-get_reranker_model","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"integer","title":"Model Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminRerankerModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["admin/reranker_model"],"summary":"Update Reranker Model","operationId":"admin/reranker_model-update_reranker_model","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"integer","title":"Model Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/RerankerModelUpdate"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminRerankerModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"delete":{"tags":["admin/reranker_model"],"summary":"Delete Reranker Model","operationId":"admin/reranker_model-delete_reranker_model","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"integer","title":"Model Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/reranker-models/{model_id}/set_default":{"put":{"tags":["admin/reranker_model"],"summary":"Set Default Reranker Model","operationId":"admin/reranker_model-set_default_reranker_model","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"model_id","in":"path","required":true,"schema":{"type":"integer","title":"Model Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/AdminRerankerModel"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/langfuse/test":{"post":{"tags":["admin/langfuse"],"summary":"Test Langfuse","operationId":"admin/langfuse-test_langfuse","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/LangfuseSetting"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/LangfuseTestResult"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyCookie":[]}]}},"/api/v1/admin/retrieve/documents":{"get":{"tags":["admin/retrieve_old"],"summary":"Legacy Retrieve Documents","operationId":"admin/retrieve_old-legacy_retrieve_documents","deprecated":true,"security":[{"APIKeyCookie":[]}],"parameters":[{"name":"question","in":"query","required":true,"schema":{"type":"string","title":"Question"}},{"name":"chat_engine","in":"query","required":false,"schema":{"type":"string","default":"default","title":"Chat Engine"}},{"name":"top_k","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":5,"title":"Top K"}},{"name":"similarity_top_k","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Similarity Top K"}},{"name":"oversampling_factor","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":5,"title":"Oversampling Factor"}},{"name":"refine_question_with_kg","in":"query","required":false,"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"default":true,"title":"Refine Question With Kg"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/Document"},"title":"Response Admin/Retrieve Old-Legacy Retrieve Documents"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/embedding_retrieve":{"get":{"tags":["admin/retrieve_old"],"summary":"Legacy Retrieve Chunks","operationId":"admin/retrieve_old-legacy_retrieve_chunks","deprecated":true,"security":[{"APIKeyCookie":[]}],"parameters":[{"name":"question","in":"query","required":true,"schema":{"type":"string","title":"Question"}},{"name":"chat_engine","in":"query","required":false,"schema":{"type":"string","default":"default","title":"Chat Engine"}},{"name":"top_k","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":5,"title":"Top K"}},{"name":"similarity_top_k","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Similarity Top K"}},{"name":"oversampling_factor","in":"query","required":false,"schema":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":5,"title":"Oversampling Factor"}},{"name":"refine_question_with_kg","in":"query","required":false,"schema":{"default":false,"title":"Refine Question With Kg"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NodeWithScore"},"title":"Response Admin/Retrieve Old-Legacy Retrieve Chunks"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"post":{"tags":["admin/retrieve_old"],"summary":"Legacy Retrieve Chunks 2","operationId":"admin/retrieve_old-legacy_retrieve_chunks_2","deprecated":true,"security":[{"APIKeyCookie":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatEngineBasedRetrieveRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"array","items":{"$ref":"#/components/schemas/NodeWithScore"},"title":"Response Admin/Retrieve Old-Legacy Retrieve Chunks 2"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/stats/trend/chat-user":{"get":{"tags":["admin/stats"],"summary":"Chat Count Trend","operationId":"admin/stats-chat_count_trend","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"start_date","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Start Date"}},{"name":"end_date","in":"query","required":true,"schema":{"type":"string","format":"date","title":"End Date"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatStats"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/stats/trend/chat-origin":{"get":{"tags":["admin/stats"],"summary":"Chat Origin Trend","operationId":"admin/stats-chat_origin_trend","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"start_date","in":"query","required":true,"schema":{"type":"string","format":"date","title":"Start Date"}},{"name":"end_date","in":"query","required":true,"schema":{"type":"string","format":"date","title":"End Date"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ChatStats"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/semantic_cache":{"post":{"tags":["admin/semantic_cache"],"summary":"Add Semantic Cache","operationId":"admin/semantic_cache-add_semantic_cache","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"question","in":"query","required":true,"schema":{"type":"string","title":"Question"}},{"name":"answer","in":"query","required":true,"schema":{"type":"string","title":"Answer"}},{"name":"namespace","in":"query","required":false,"schema":{"type":"string","default":"default","title":"Namespace"}},{"name":"chat_engine","in":"query","required":false,"schema":{"type":"string","default":"default","title":"Chat Engine"}}],"requestBody":{"content":{"application/json":{"schema":{"anyOf":[{"type":"object","additionalProperties":true},{"type":"null"}],"title":"Metadata"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Admin/Semantic Cache-Add Semantic Cache"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["admin/semantic_cache"],"summary":"Search Semantic Cache","operationId":"admin/semantic_cache-search_semantic_cache","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"query","in":"query","required":true,"schema":{"type":"string","title":"Query"}},{"name":"namespace","in":"query","required":false,"schema":{"type":"string","default":"default","title":"Namespace"}},{"name":"chat_engine","in":"query","required":false,"schema":{"type":"string","default":"default","title":"Chat Engine"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"object","additionalProperties":true,"title":"Response Admin/Semantic Cache-Search Semantic Cache"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/evaluation/tasks":{"post":{"tags":["admin/evaluation/task"],"summary":"Create Evaluation Task","description":"Create an evaluation task from the evaluation dataset.\n\nArgs:\n    evaluation_task.name: The name of the evaluation task.\n    evaluation_task.evaluation_dataset_id: The ID of the uploaded evaluation dataset.\n    evaluation_task.chat_engine: The chat engine to evaluate the queries against. Default is \"default\".\n    evaluation_task.run_size: The number of queries to evaluate. Default is None, which means all queries in the CSV file.\n\nReturns:\n    True if the evaluation task is created successfully.","operationId":"admin/evaluation/task-create_evaluation_task","security":[{"APIKeyCookie":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEvaluationTask"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"$ref":"#/components/schemas/EvaluationTask"},{"type":"null"}],"title":"Response Admin/Evaluation/Task-Create Evaluation Task"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["admin/evaluation/task"],"summary":"List Evaluation Task","operationId":"admin/evaluation/task-list_evaluation_task","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"keyword","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Keyword"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_EvaluationTaskSummary_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/evaluation/tasks/{evaluation_task_id}":{"delete":{"tags":["admin/evaluation/task"],"summary":"Cancel Evaluation Task","operationId":"admin/evaluation/task-cancel_evaluation_task","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"evaluation_task_id","in":"path","required":true,"schema":{"type":"integer","title":"Evaluation Task Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Response Admin/Evaluation/Task-Cancel Evaluation Task"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["admin/evaluation/task"],"summary":"Get Evaluation Task","operationId":"admin/evaluation/task-get_evaluation_task","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"evaluation_task_id","in":"path","required":true,"schema":{"type":"integer","title":"Evaluation Task Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationTask"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/evaluation/tasks/{evaluation_task_id}/summary":{"get":{"tags":["admin/evaluation/task"],"summary":"Get Evaluation Task Summary","operationId":"admin/evaluation/task-get_evaluation_task_summary","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"evaluation_task_id","in":"path","required":true,"schema":{"type":"integer","title":"Evaluation Task Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationTaskSummary"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/evaluation/tasks/{evaluation_task_id}/items":{"get":{"tags":["admin/evaluation/task"],"summary":"List Evaluation Task Items","operationId":"admin/evaluation/task-list_evaluation_task_items","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"evaluation_task_id","in":"path","required":true,"schema":{"type":"integer","title":"Evaluation Task Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"keyword","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Keyword"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_EvaluationTaskItem_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/evaluation/datasets":{"post":{"tags":["admin/evaluation/dataset"],"summary":"Create Evaluation Dataset","description":"Create a dataset for a given question and chat engine.\nThis API depends on the /admin/uploads API to upload the evaluation data.\nThe evaluation data is expected to be a CSV file with the following columns:\n\n- query: The query to evaluate\n- reference: The expected response to the query\n\nYou can add more columns to the CSV file, and the extra columns will adhere to the results.\n\nArgs:\n    evaluation_dataset.name: The name of the evaluation dataset.\n    evaluation_dataset.upload_id: The ID of the uploaded CSV file of the evaluation dataset.\n\nReturns:\n    True if the evaluation dataset is created successfully.","operationId":"admin/evaluation/dataset-create_evaluation_dataset","security":[{"APIKeyCookie":[]}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateEvaluationDataset"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationDataset"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["admin/evaluation/dataset"],"summary":"List Evaluation Dataset","operationId":"admin/evaluation/dataset-list_evaluation_dataset","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"keyword","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Keyword"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_EvaluationDataset_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/evaluation/datasets/{evaluation_dataset_id}":{"delete":{"tags":["admin/evaluation/dataset"],"summary":"Delete Evaluation Dataset","operationId":"admin/evaluation/dataset-delete_evaluation_dataset","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"evaluation_dataset_id","in":"path","required":true,"schema":{"type":"integer","title":"Evaluation Dataset Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Admin/Evaluation/Dataset-Delete Evaluation Dataset"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["admin/evaluation/dataset"],"summary":"Update Evaluation Dataset","operationId":"admin/evaluation/dataset-update_evaluation_dataset","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"evaluation_dataset_id","in":"path","required":true,"schema":{"type":"integer","title":"Evaluation Dataset Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/UpdateEvaluationDataset"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationDataset"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/evaluation/dataset-items":{"post":{"tags":["admin/evaluation/dataset"],"summary":"Create Evaluation Dataset Item","operationId":"admin/evaluation/dataset-create_evaluation_dataset_item","requestBody":{"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyEvaluationDatasetItem"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationDatasetItem"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}},"security":[{"APIKeyCookie":[]}]}},"/api/v1/admin/evaluation/dataset-items/{evaluation_dataset_item_id}":{"delete":{"tags":["admin/evaluation/dataset"],"summary":"Delete Evaluation Dataset Item","operationId":"admin/evaluation/dataset-delete_evaluation_dataset_item","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"evaluation_dataset_item_id","in":"path","required":true,"schema":{"type":"integer","title":"Evaluation Dataset Item Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"type":"boolean","title":"Response Admin/Evaluation/Dataset-Delete Evaluation Dataset Item"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"put":{"tags":["admin/evaluation/dataset"],"summary":"Update Evaluation Dataset Item","operationId":"admin/evaluation/dataset-update_evaluation_dataset_item","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"evaluation_dataset_item_id","in":"path","required":true,"schema":{"type":"integer","title":"Evaluation Dataset Item Id"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/ModifyEvaluationDatasetItem"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationDatasetItem"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}},"get":{"tags":["admin/evaluation/dataset"],"summary":"Get Evaluation Dataset Item","operationId":"admin/evaluation/dataset-get_evaluation_dataset_item","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"evaluation_dataset_item_id","in":"path","required":true,"schema":{"type":"integer","title":"Evaluation Dataset Item Id"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/EvaluationDatasetItem"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/evaluation/datasets/{evaluation_dataset_id}/dataset-items":{"get":{"tags":["admin/evaluation/dataset"],"summary":"List Evaluation Dataset Item","operationId":"admin/evaluation/dataset-list_evaluation_dataset_item","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"evaluation_dataset_id","in":"path","required":true,"schema":{"type":"integer","title":"Evaluation Dataset Id"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}},{"name":"keyword","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Keyword"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_EvaluationDatasetItem_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/admin/users/search":{"get":{"tags":["admin/users"],"summary":"Search Users","operationId":"admin/users-search_users","security":[{"APIKeyCookie":[]}],"parameters":[{"name":"search","in":"query","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search"}},{"name":"page","in":"query","required":false,"schema":{"type":"integer","minimum":1,"default":1,"title":"Page"}},{"name":"size","in":"query","required":false,"schema":{"type":"integer","maximum":100,"minimum":1,"default":50,"title":"Size"}}],"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Page_UserDescriptor_"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/auth/login":{"post":{"tags":["auth"],"summary":"Auth:Database.Login","operationId":"auth-auth:database.login","requestBody":{"content":{"application/x-www-form-urlencoded":{"schema":{"$ref":"#/components/schemas/login"}}},"required":true},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"400":{"description":"Bad Request","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ErrorModel"},"examples":{"LOGIN_BAD_CREDENTIALS":{"summary":"Bad credentials or the user is inactive.","value":{"detail":"LOGIN_BAD_CREDENTIALS"}},"LOGIN_USER_NOT_VERIFIED":{"summary":"The user is not verified.","value":{"detail":"LOGIN_USER_NOT_VERIFIED"}}}}}},"204":{"description":"No Content"},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}},"/api/v1/auth/logout":{"post":{"tags":["auth"],"summary":"Auth:Database.Logout","operationId":"auth-auth:database.logout","responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{}}}},"401":{"description":"Missing token or inactive user."},"204":{"description":"No Content"}},"security":[{"APIKeyCookie":[]}]}}},"components":{"schemas":{"AdminFeedbackPublic":{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"feedback_type":{"$ref":"#/components/schemas/FeedbackType","default":"like"},"comment":{"type":"string","maxLength":500,"title":"Comment"},"chat_id":{"type":"string","format":"uuid","title":"Chat Id"},"chat_message_id":{"type":"integer","title":"Chat Message Id"},"user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Id"},"origin":{"anyOf":[{"type":"string","maxLength":256},{"type":"null"}],"title":"Origin"},"id":{"type":"integer","title":"Id"},"chat_title":{"type":"string","title":"Chat Title"},"chat_origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chat Origin"},"chat_message_content":{"type":"string","title":"Chat Message Content"},"user_email":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User Email"}},"type":"object","required":["chat_id","chat_message_id","user_id","id","chat_title","chat_origin","chat_message_content","user_email"],"title":"AdminFeedbackPublic"},"AdminLLM":{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","maxLength":64,"title":"Name"},"provider":{"$ref":"#/components/schemas/LLMProvider"},"model":{"type":"string","maxLength":256,"title":"Model"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"title":"Config","default":{}},"is_default":{"type":"boolean","title":"Is Default","default":false},"id":{"type":"integer","title":"Id"}},"type":"object","required":["name","provider","model","id"],"title":"AdminLLM"},"AdminRerankerModel":{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","maxLength":64,"title":"Name"},"provider":{"$ref":"#/components/schemas/RerankerProvider"},"model":{"type":"string","maxLength":256,"title":"Model"},"top_n":{"type":"integer","title":"Top N","default":10},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"title":"Config","default":{}},"is_default":{"type":"boolean","title":"Is Default","default":false},"id":{"type":"integer","title":"Id"}},"type":"object","required":["name","provider","model","id"],"title":"AdminRerankerModel"},"AdvancedChunkingConfig-Input":{"properties":{"mode":{"$ref":"#/components/schemas/ChunkingMode","default":"advanced"},"rules":{"additionalProperties":{"$ref":"#/components/schemas/ChunkSplitterConfig"},"propertyNames":{"$ref":"#/components/schemas/MimeTypes"},"type":"object","title":"Rules"}},"type":"object","title":"AdvancedChunkingConfig"},"AdvancedChunkingConfig-Output":{"properties":{"mode":{"$ref":"#/components/schemas/ChunkingMode","default":"advanced"},"rules":{"additionalProperties":{"$ref":"#/components/schemas/ChunkSplitterConfig"},"propertyNames":{"$ref":"#/components/schemas/MimeTypes"},"type":"object","title":"Rules"}},"type":"object","title":"AdvancedChunkingConfig"},"AudioBlock":{"properties":{"block_type":{"type":"string","const":"audio","title":"Block Type","default":"audio"},"audio":{"anyOf":[{"type":"string","format":"binary"},{"type":"null"}],"title":"Audio"},"path":{"anyOf":[{"type":"string","format":"file-path"},{"type":"null"}],"title":"Path"},"url":{"anyOf":[{"type":"string","minLength":1,"format":"uri"},{"type":"string"},{"type":"null"}],"title":"Url"},"format":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Format"}},"type":"object","title":"AudioBlock","description":"A representation of audio data to directly pass to/from the LLM."},"BaseNode":{"additionalProperties":true,"type":"object"},"Body_admin_upload-upload_files":{"properties":{"files":{"items":{"type":"string","format":"binary"},"type":"array","title":"Files"}},"type":"object","required":["files"],"title":"Body_admin/upload-upload_files"},"CacheControl":{"properties":{"type":{"type":"string","title":"Type"},"ttl":{"type":"string","title":"Ttl","default":"5m"}},"type":"object","required":["type"],"title":"CacheControl"},"CachePoint":{"properties":{"block_type":{"type":"string","const":"cache","title":"Block Type","default":"cache"},"cache_control":{"$ref":"#/components/schemas/CacheControl"}},"type":"object","required":["cache_control"],"title":"CachePoint","description":"Used to set the point to cache up to, if the LLM supports caching."},"Chat":{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"id":{"type":"string","format":"uuid","title":"Id"},"title":{"type":"string","maxLength":256,"title":"Title"},"engine_id":{"type":"integer","title":"Engine Id"},"engine_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"string"}],"title":"Engine Options","default":{}},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"},"user_id":{"type":"string","format":"uuid","title":"User Id"},"browser_id":{"type":"string","maxLength":50,"title":"Browser Id"},"origin":{"type":"string","maxLength":256,"title":"Origin"},"visibility":{"$ref":"#/components/schemas/ChatVisibility"}},"type":"object","required":["title","engine_id","user_id","browser_id","visibility"],"title":"Chat"},"ChatEngine":{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"name":{"type":"string","maxLength":256,"title":"Name"},"engine_options":{"additionalProperties":true,"type":"object","title":"Engine Options","default":{}},"llm_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Llm Id"},"fast_llm_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fast Llm Id"},"reranker_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reranker Id"},"is_default":{"type":"boolean","title":"Is Default","default":false},"is_public":{"type":"boolean","title":"Is Public","default":false},"deleted_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Deleted At"}},"type":"object","required":["name","llm_id","fast_llm_id","reranker_id"],"title":"ChatEngine"},"ChatEngineBasedRetrieveRequest":{"properties":{"query":{"type":"string","title":"Query"},"chat_engine":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chat Engine","default":"default"},"top_k":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Top K","default":5},"similarity_top_k":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Similarity Top K"},"oversampling_factor":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Oversampling Factor","default":5},"refine_question_with_kg":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Refine Question With Kg","default":false}},"type":"object","required":["query"],"title":"ChatEngineBasedRetrieveRequest"},"ChatEngineConfig":{"properties":{"external_engine_config":{"anyOf":[{"$ref":"#/components/schemas/ExternalChatEngine"},{"type":"null"}]},"llm":{"$ref":"#/components/schemas/LLMOption","default":{"intent_graph_knowledge":"Given a list of prerequisite questions and their relevant knowledge for the user's main question, when conflicts in meaning arise, prioritize the relationship with the higher weight and the more recent version.\n\nKnowledge sub-queries:\n\n{% for sub_query, data in sub_queries.items() %}\n\nSub-query: {{ sub_query }}\n\n  - Entities:\n{% for entity in data['entities'] %}\n    - Name: {{ entity.name }}\n      Description: {{ entity.description }}\n{% endfor %}\n\n  - Relationships:\n{% for relationship in data['relationships'] %}\n    - Description: {{ relationship.rag_description }}\n      Weight: {{ relationship.weight }}\n{% endfor %}\n\n{% endfor %}\n","normal_graph_knowledge":"Given a list of relationships of a knowledge graph as follows. When there is a conflict in meaning between knowledge relationships, the relationship with the higher `weight` and newer `last_modified_at` value takes precedence.\n\n---------------------\nEntities:\n\n{% for entity in entities %}\n- Name: {{ entity.name }}\n  Description: {{ entity.description }}\n{% endfor %}\n\n---------------------\n\nKnowledge relationships:\n\n{% for relationship in relationships %}\n\n- Description: {{ relationship.rag_description }}\n- Weight: {{ relationship.weight }}\n- Last Modified At: {{ relationship.last_modified_at }}\n- Meta: {{ relationship.meta | tojson(indent=2) }}\n\n{% endfor %}\n","condense_question_prompt":"Current Date: {{current_date}}\n---------------------\nThe prerequisite questions and their relevant knowledge for the user's main question.\n---------------------\n\n{{graph_knowledges}}\n\n---------------------\n\nTask:\nGiven the conversation between the Human and Assistant, along with the follow-up message from the Human, and the provided prerequisite questions and relevant knowledge, refine the Human’s follow-up message into a standalone, detailed question.\n\nInstructions:\n1. Focus on the latest query from the Human, ensuring it is given the most weight.\n2. Incorporate Key Information:\n  - Use the prerequisite questions and their relevant knowledge to add specific details to the follow-up question.\n  - Replace ambiguous terms or references in the follow-up question with precise information from the provided knowledge. Example: Replace “latest version” with the actual version number mentioned in the knowledge.\n3. Utilize Conversation Context:\n  - Incorporate relevant context and background information from the conversation history to enhance the question's specificity.\n4. Optimize for Retrieval:\n  - Ensure the refined question emphasizes specific and relevant terms to maximize the effectiveness of a vector search for retrieving precise and comprehensive information.\n5. Grounded and Factual:\n  - Make sure the refined question is grounded in and directly based on the user's follow-up question and the provided knowledge.\n  - Do not introduce information that is not supported by the knowledge or conversation history.\n6. Give the language hint for the answer:\n  - Add a hint after the question like \"(Answer language: English)\", or \"(Answer language: Chinese)\", etc.\n  - This language hint should be exactly same with the language of the original question.\n  - If the original question has part of other language aside from English, please use the language of another language rather than English. Example: \"tidb tableread慢会是哪些原因\", it should be Chinese.\n\nExample:\n\nChat History:\n\nHuman: \"I'm interested in the performance improvements in the latest version of TiDB.\"\nAssistant: \"TiDB version 8.1 was released recently with significant performance enhancements over version 6.5.\"\n\nFollow-up Question:\n\n\"Can you tell me more about these improvements?\"\n\nPrerequisite Questions and Relevant Knowledge:\n\n- Prerequisite Question: What is the latest version of TiDB?\n- Relevant Knowledge: The latest version of TiDB is 8.1.\n\n...\n\nRefined Standalone Question:\n\n\"Can you provide detailed information about the performance improvements introduced in TiDB version 8.1 compared to version 6.5? (Answer language: English)\"\n\nYour Turn:\n\nChat history:\n\n{{chat_history}}\n\n---------------------\n\nFollowup question:\n\n{{question}}\n\n---------------------\n\nRefined standalone question:\n","clarifying_question_prompt":"---------------------\nThe prerequisite questions and their relevant knowledge for the user's main question.\n---------------------\n\n{{graph_knowledges}}\n\n---------------------\n\nTask:\nGiven the conversation between the user and ASSISTANT, along with the follow-up message from the user, and the provided prerequisite questions and relevant knowledge, determine if the user's question is clear and specific enough for a confident response. \n\nIf the question lacks necessary details or context, identify the specific ambiguities and generate a clarifying question to address them.\nIf the question is clear and answerable, return exact \"False\" as the response.\n\nInstructions:\n1. Assess Information Sufficiency:\n   - Evaluate if the user's question provides enough detail to generate a precise answer based on the prerequisite questions, relevant knowledge, and conversation history.\n   - If the user's question is too vague or lacks key information, identify what additional information would be necessary for clarity.\n\n2. Generate a Clarifying Question:\n   - If the question is clear and answerable, return exact \"False\" as the response.\n   - If clarification is needed, return a specific question to ask the user, directly addressing the information gap. Avoid general questions; focus on the specific details required for an accurate answer.\n\n3. Use the same language to ask the clarifying question as the user's original question.\n\nExample 1:\n\nuser: \"Does TiDB support foreign keys?\"\nRelevant Knowledge: TiDB supports foreign keys starting from version 6.6.0.\n\nResponse:\n\nWhich version of TiDB are you using?\n\nExample 2:\n\nuser: \"Does TiDB support nested transaction?\"\nRelevant Knowledge: TiDB supports nested transaction starting from version 6.2.0.\n\nResponse:\n\nWhich version of TiDB are you using?\n\nExample 3:\n\nuser: \"Does TiDB support foreign keys? I'm using TiDB 6.5.0.\"\nRelevant Knowledge: TiDB supports foreign keys starting from version 6.6.0.\n\nResponse:\n\nFalse\n\nYour Turn:\n\nChat history:\n\n{{chat_history}}\n\n---------------------\n\nFollow-up question:\n\n{{question}}\n\nResponse:\n","text_qa_prompt":"Current Date: {{current_date}}\n---------------------\nKnowledge graph information is below\n---------------------\n\n{{graph_knowledges}}\n\n---------------------\nContext information is below.\n---------------------\n\n{{context_str}}\n\n---------------------\n\nAnswer Format:\n\nUse markdown footnote syntax (for example: [^1]) to indicate sources you used.\nEach footnote must correspond to a unique source. Do not use the same source for multiple footnotes.\n\n### Examples of Correct Footnote Usage (no the unique sources and diverse sources):\n[^1]: [TiDB Overview | PingCAP Docs](https://docs.pingcap.com/tidb/stable/overview)\n[^2]: [TiDB Architecture | PingCAP Docs](https://docs.pingcap.com/tidb/stable/architecture)\n\n### Examples of Incorrect Footnote Usage (Avoid duplicating the same source for multiple footnotes):\n[^1]: [TiDB Introduction | PingCAP Docs](https://docs.pingcap.com/tidb/v5.4/overview)\n[^2]: [TiDB Introduction | PingCAP Docs](https://docs.pingcap.com/tidb/v5.4/overview)\n[^3]: [TiDB Introduction | PingCAP Docs](https://docs.pingcap.com/tidb/dev/overview)\n[^4]: [TiDB Introduction | PingCAP Docs](https://docs.pingcap.com/tidb/stable/overview)\n\n---------------------\n\nAnswer Language:\n\nFollow the language of the language hint after the Refined Question.\nIf the language hint is not provided, use the language that the original questions used.\n\n---------------------\n\nAs a customer support assistant, please do not fabricate any knowledge. If you cannot get knowledge from the context, please just directly state \"you do not know\", rather than constructing nonexistent and potentially fake information!!!\n\nFirst, analyze the provided context information without assuming prior knowledge. Identify all relevant aspects of knowledge contained within. Then, from various perspectives and angles, answer questions as thoroughly and comprehensively as possible to better address and resolve the user's issue.\n\nThe Original questions is:\n\n{{original_question}}\n\nThe Refined Question used to search:\n\n{{query_str}}\n\nAnswer:\n","further_questions_prompt":"The chat message content is:\n\n{{chat_message_content}}\n\n---------------------\nTask:\nBased on the provided chat message, generate 3–5 follow-up questions that are relevant to the content. Each question should explore the topic in greater detail, seek clarification, or introduce new angles for discussion.\n\nInstructions:\n1. Build upon the key information, themes, or insights within the provided chat message.\n2. Aim for variety in question type (clarifying, probing, or exploratory) to encourage a deeper conversation.\n3. Ensure each question logically follows from the context of the provided chat message.\n4. Keep questions concise yet insightful to maximize engagement.\n5. Use the same language with the chat message content.\n6. Each question should end with a question mark.\n7. Each question should be in a new line, DO NOT add any indexes or blank lines, just output the questions.\n\nNow, generate 3–5 follow-up questions below:\n","generate_goal_prompt":"Given the conversation history between the User and Assistant, along with the latest follow-up question from the User, perform the following tasks:\n\n1. **Language Detection**:\n    - Analyze the User's follow-up question to determine the language used.\n\n2. **Context Classification**:\n    - **Determine Relevance to TiDB**:\n        - Assess whether the follow-up question is related to TiDB products, support, or any TiDB-related context.\n    - **Set Background Accordingly**:\n        - **If Related to TiDB**:\n            - Set the background to encompass the relevant TiDB context. This may include aspects like TiDB features, configurations, best practices, troubleshooting, or general consulting related to TiDB.\n            - Example backgrounds:\n                - \"TiDB product configuration and optimization.\"\n                - \"TiDB troubleshooting and support.\"\n                - \"TiDB feature consultation.\"\n        - **If Unrelated to TiDB**:\n            - Set the background to \"Other topics.\"\n\n3. **Goal Generation**:\n    - **Clarify Intent to Avoid Ambiguity**:\n        - **Instructional Guidance**:\n            - If the User's question seeks guidance or a method (e.g., starts with \"How to\"), ensure the goal reflects a request for a step-by-step guide or best practices.\n        - **Information Retrieval**:\n            - If the User's question seeks specific information or confirmation (e.g., starts with \"Can you\" or \"Is it possible\"), rephrase it to focus on providing the requested information or verification without implying that the assistant should perform any actions.\n            - **Important**: Do not interpret these questions as requests for the assistant to execute operations. Instead, understand whether the user seeks to confirm certain information or requires a proposed solution, and restrict responses to information retrieval and guidance based on available documentation.\n    - **Reformulate the Latest User Follow-up Question**:\n        - Ensure the question is clear, directive, and suitable for a Q&A format.\n    - **Specify Additional Details**:\n        - **Detected Language**: Clearly indicate the language.\n        - **Desired Answer Format**: Specify if the answer should be in text, table, code snippet, etc.\n        - **Additional Requirements**: Include any other necessary instructions to tailor the response appropriately.\n\n4. **Output**:\n    - Produce a goal string in the following format:\n      \"[Refined Question] (Lang: [Detected Language], Format: [Format], Background: [Specified Goal Scenario])\"\n\n**Examples**:\n\n**Example 1**:\n\nChat history:\n\n[]\n\nFollow-up question:\n\n\"tidb encryption at rest 会影响数据压缩比例吗？\"\n\nGoal:\n\nDoes encryption at rest in TiDB affect the data compression ratio? (Lang: Chinese, Format: text, Background: TiDB product related consulting.)\n\n---------------------\n\n**Example 2**:\n\nChat history:\n\n[]\n\nFollow-up question:\n\n\"干嘛的？\"\n\nGoal:\n\nWhat can you do? (Lang: Chinese, Format: text, Background: General inquiry about the assistant's capabilities.)\n\n---------------------\n\n**Example 3**:\n\nChat history:\n\n[]\n\nFollow-up question:\n\n\"oracle 怎么样？\"\n\nGoal:\n\nHow is Oracle? (Lang: Chinese, Format: text, Background: Other topics.)\n\n---------------------\n\n**Example 4**:\n\nChat history:\n\n[]\n\nFollow-up question:\n\n\"Why is TiDB Serverless up to 70% cheaper than MySQL RDS? (use a table if possible)\"\n\nGoal:\n\nWhy is TiDB Serverless up to 70% cheaper than MySQL RDS? Please provide a comparison in a table format if possible. (Lang: English, Format: table, Background: Cost comparison between TiDB Serverless and MySQL RDS.)\n\n---------------------\n\n**Example 5 (Enhanced for Clarity and Guidance)**:\n\nChat history:\n\n[]\n\nFollow-up question:\n\n\"能否找到 tidb 中哪些视图的定义中包含已经被删除的表？\"\n\nGoal:\n\nHow to find which views in TiDB have definitions that include tables that have been deleted? (Lang: Chinese, Format: text, Background: TiDB product related consulting.)\n\n---------------------\n\n**Your Task**:\n\nChat history:\n\n{{chat_history}}\n\nFollow-up question:\n\n{{question}}\n\nGoal:\n"}},"knowledge_base":{"$ref":"#/components/schemas/KnowledgeBaseOption","default":{"linked_knowledge_bases":[]}},"knowledge_graph":{"$ref":"#/components/schemas/KnowledgeGraphOption","default":{"depth":2,"include_meta":false,"with_degree":false,"enabled":true,"using_intent_search":true}},"vector_search":{"$ref":"#/components/schemas/VectorSearchOption","default":{"top_k":10,"oversampling_factor":5}},"refine_question_with_kg":{"type":"boolean","title":"Refine Question With Kg","default":true},"clarify_question":{"type":"boolean","title":"Clarify Question","default":false},"further_questions":{"type":"boolean","title":"Further Questions","default":false},"post_verification_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Post Verification Url"},"post_verification_token":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Post Verification Token"},"hide_sources":{"type":"boolean","title":"Hide Sources","default":false}},"type":"object","title":"ChatEngineConfig"},"ChatEngineDescriptor":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"is_default":{"type":"boolean","title":"Is Default"}},"type":"object","required":["id","name","is_default"],"title":"ChatEngineDescriptor"},"ChatEngineUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"llm_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Llm Id"},"fast_llm_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fast Llm Id"},"reranker_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Reranker Id"},"engine_options":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Engine Options"},"is_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Default"},"is_public":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Public"}},"type":"object","title":"ChatEngineUpdate"},"ChatFilters":{"properties":{"created_at_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At Start"},"created_at_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At End"},"updated_at_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At Start"},"updated_at_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At End"},"chat_origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Chat Origin"},"engine_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Engine Id"}},"type":"object","title":"ChatFilters"},"ChatMessage":{"properties":{"role":{"$ref":"#/components/schemas/MessageRole","default":"user"},"additional_kwargs":{"additionalProperties":true,"type":"object","title":"Additional Kwargs"},"blocks":{"items":{"oneOf":[{"$ref":"#/components/schemas/TextBlock"},{"$ref":"#/components/schemas/ImageBlock"},{"$ref":"#/components/schemas/AudioBlock"},{"$ref":"#/components/schemas/VideoBlock"},{"$ref":"#/components/schemas/DocumentBlock"},{"$ref":"#/components/schemas/CachePoint"},{"$ref":"#/components/schemas/CitableBlock"},{"$ref":"#/components/schemas/CitationBlock"},{"$ref":"#/components/schemas/ThinkingBlock"},{"$ref":"#/components/schemas/ToolCallBlock"}],"discriminator":{"propertyName":"block_type","mapping":{"audio":"#/components/schemas/AudioBlock","cache":"#/components/schemas/CachePoint","citable":"#/components/schemas/CitableBlock","citation":"#/components/schemas/CitationBlock","document":"#/components/schemas/DocumentBlock","image":"#/components/schemas/ImageBlock","text":"#/components/schemas/TextBlock","thinking":"#/components/schemas/ThinkingBlock","tool_call":"#/components/schemas/ToolCallBlock","video":"#/components/schemas/VideoBlock"}}},"type":"array","title":"Blocks"}},"type":"object","title":"ChatMessage","description":"Chat message."},"ChatOrigin":{"properties":{"origin":{"type":"string","title":"Origin"},"chats":{"type":"integer","title":"Chats"}},"type":"object","required":["origin","chats"],"title":"ChatOrigin"},"ChatRequest":{"properties":{"messages":{"items":{"$ref":"#/components/schemas/ChatMessage"},"type":"array","title":"Messages"},"chat_engine":{"type":"string","title":"Chat Engine","default":"default"},"chat_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Chat Id"},"stream":{"type":"boolean","title":"Stream","default":true}},"type":"object","required":["messages"],"title":"ChatRequest"},"ChatStats":{"properties":{"start_date":{"type":"string","format":"date","title":"Start Date"},"end_date":{"type":"string","format":"date","title":"End Date"},"values":{"items":{},"type":"array","title":"Values"}},"type":"object","required":["start_date","end_date","values"],"title":"ChatStats"},"ChatUpdate":{"properties":{"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"visibility":{"anyOf":[{"$ref":"#/components/schemas/ChatVisibility"},{"type":"null"}]}},"type":"object","title":"ChatUpdate"},"ChatVisibility":{"type":"integer","enum":[0,1],"title":"ChatVisibility"},"ChunkItem":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"document_id":{"type":"integer","title":"Document Id"},"hash":{"type":"string","title":"Hash"},"text":{"type":"string","title":"Text"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"title":"Meta"},"embedding":{"anyOf":[{"items":{"type":"number"},"type":"array"},{"type":"null"}],"title":"Embedding"},"relations":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"title":"Relations"},"source_uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Uri"},"index_status":{"anyOf":[{"$ref":"#/components/schemas/KgIndexStatus"},{"type":"null"}]},"index_result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Index Result"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["id","document_id","hash","text","meta","embedding","relations","source_uri","index_status","index_result","created_at","updated_at"],"title":"ChunkItem"},"ChunkRetrievalConfig":{"properties":{"llm_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Llm Id"},"knowledge_base_ids":{"items":{"type":"integer"},"type":"array","title":"Knowledge Base Ids"},"use_query_decompose":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Use Query Decompose"},"full_documents":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Full Documents","default":false},"vector_search":{"$ref":"#/components/schemas/VectorSearchRetrieverConfig"}},"type":"object","required":["knowledge_base_ids","vector_search"],"title":"ChunkRetrievalConfig"},"ChunkSplitter":{"type":"string","enum":["SentenceSplitter","MarkdownNodeParser"],"title":"ChunkSplitter"},"ChunkSplitterConfig":{"properties":{"splitter":{"$ref":"#/components/schemas/ChunkSplitter","default":"SentenceSplitter"},"splitter_options":{"anyOf":[{"$ref":"#/components/schemas/SentenceSplitterOptions"},{"$ref":"#/components/schemas/MarkdownNodeParserOptions"}],"title":"Splitter Options"}},"type":"object","required":["splitter_options"],"title":"ChunkSplitterConfig"},"ChunkingMode":{"type":"string","enum":["general","advanced"],"title":"ChunkingMode"},"ChunksRetrievalRequest":{"properties":{"query":{"type":"string","title":"Query"},"retrieval_config":{"$ref":"#/components/schemas/ChunkRetrievalConfig"}},"type":"object","required":["query","retrieval_config"],"title":"ChunksRetrievalRequest"},"ChunksRetrievalResult":{"properties":{"chunks":{"items":{"$ref":"#/components/schemas/RetrievedChunk"},"type":"array","title":"Chunks"},"documents":{"anyOf":[{"items":{"anyOf":[{"$ref":"#/components/schemas/Document"},{"$ref":"#/components/schemas/RetrievedChunkDocument"}]},"type":"array"},{"type":"null"}],"title":"Documents"}},"type":"object","required":["chunks"],"title":"ChunksRetrievalResult"},"CitableBlock":{"properties":{"block_type":{"type":"string","const":"citable","title":"Block Type","default":"citable"},"title":{"type":"string","title":"Title"},"source":{"type":"string","title":"Source"},"content":{"items":{"oneOf":[{"$ref":"#/components/schemas/TextBlock"},{"$ref":"#/components/schemas/ImageBlock"},{"$ref":"#/components/schemas/DocumentBlock"}],"discriminator":{"propertyName":"block_type","mapping":{"document":"#/components/schemas/DocumentBlock","image":"#/components/schemas/ImageBlock","text":"#/components/schemas/TextBlock"}}},"type":"array","title":"Content"}},"type":"object","required":["title","source","content"],"title":"CitableBlock","description":"Supports providing citable content to LLMs that have built-in citation support."},"CitationBlock":{"properties":{"block_type":{"type":"string","const":"citation","title":"Block Type","default":"citation"},"cited_content":{"oneOf":[{"$ref":"#/components/schemas/TextBlock"},{"$ref":"#/components/schemas/ImageBlock"}],"title":"Cited Content","discriminator":{"propertyName":"block_type","mapping":{"image":"#/components/schemas/ImageBlock","text":"#/components/schemas/TextBlock"}}},"source":{"type":"string","title":"Source"},"title":{"type":"string","title":"Title"},"additional_location_info":{"additionalProperties":{"type":"integer"},"type":"object","title":"Additional Location Info"}},"type":"object","required":["cited_content","source","title","additional_location_info"],"title":"CitationBlock","description":"A representation of cited content from past messages."},"CreateApiKeyRequest":{"properties":{"description":{"type":"string","title":"Description"}},"type":"object","required":["description"],"title":"CreateApiKeyRequest"},"CreateApiKeyResponse":{"properties":{"api_key":{"type":"string","title":"Api Key"}},"type":"object","required":["api_key"],"title":"CreateApiKeyResponse"},"CreateEvaluationDataset":{"properties":{"name":{"type":"string","title":"Name"},"upload_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Upload Id"}},"type":"object","required":["name"],"title":"CreateEvaluationDataset"},"CreateEvaluationTask":{"properties":{"name":{"type":"string","title":"Name"},"evaluation_dataset_id":{"type":"integer","title":"Evaluation Dataset Id"},"chat_engine":{"type":"string","title":"Chat Engine","default":"default"},"run_size":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Run Size"}},"type":"object","required":["name","evaluation_dataset_id"],"title":"CreateEvaluationTask"},"DataSourceDescriptor":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"DataSourceDescriptor"},"DataSourceType":{"type":"string","enum":["file","web_sitemap","web_single_page"],"title":"DataSourceType"},"DocIndexTaskStatus":{"type":"string","enum":["not_started","pending","running","completed","failed"],"title":"DocIndexTaskStatus"},"Document":{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"hash":{"type":"string","maxLength":32,"title":"Hash"},"name":{"type":"string","maxLength":256,"title":"Name"},"content":{"type":"string","title":"Content"},"mime_type":{"$ref":"#/components/schemas/MimeTypes"},"source_uri":{"type":"string","maxLength":512,"title":"Source Uri"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"}],"title":"Meta","default":{}},"last_modified_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Modified At"},"index_status":{"$ref":"#/components/schemas/DocIndexTaskStatus","default":"not_started"},"index_result":{"type":"string","title":"Index Result"},"data_source_id":{"type":"integer","title":"Data Source Id"},"knowledge_base_id":{"type":"integer","title":"Knowledge Base Id"}},"type":"object","required":["hash","name","content","mime_type","source_uri","last_modified_at","index_result","data_source_id","knowledge_base_id"],"title":"Document"},"DocumentBlock":{"properties":{"block_type":{"type":"string","const":"document","title":"Block Type","default":"document"},"data":{"anyOf":[{"type":"string","format":"binary"},{"type":"null"}],"title":"Data"},"path":{"anyOf":[{"type":"string","format":"file-path"},{"type":"string"},{"type":"null"}],"title":"Path"},"url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Url"},"title":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Title"},"document_mimetype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Document Mimetype"}},"type":"object","title":"DocumentBlock","description":"A representation of a document to directly pass to the LLM."},"DocumentFilters":{"properties":{"search":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Search","description":"The search string to filter documents by name or source URI."},"knowledge_base_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Knowledge Base Id","description":"The knowledge base ID that the document belongs to."},"data_source_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Data Source Id","description":"The data source ID that the document belongs to."},"mime_type":{"anyOf":[{"$ref":"#/components/schemas/MimeTypes"},{"type":"null"}],"description":"The MIME type of the documents to filter by."},"index_status":{"anyOf":[{"$ref":"#/components/schemas/DocIndexTaskStatus"},{"type":"null"}],"description":"The status of the document index task to filter by."},"created_at":{"anyOf":[{"prefixItems":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}],"type":"array","maxItems":2,"minItems":2},{"type":"null"}],"title":"Created At","description":"The time range when the document was created."},"updated_at":{"anyOf":[{"prefixItems":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}],"type":"array","maxItems":2,"minItems":2},{"type":"null"}],"title":"Updated At","description":"The time range when the document was last updated."},"last_modified_at":{"anyOf":[{"prefixItems":[{"type":"string","format":"date-time"},{"type":"string","format":"date-time"}],"type":"array","maxItems":2,"minItems":2},{"type":"null"}],"title":"Last Modified At","description":"The time range when the document was last modified in the source system."}},"type":"object","title":"DocumentFilters"},"DocumentItem":{"properties":{"id":{"type":"integer","title":"Id"},"hash":{"type":"string","title":"Hash"},"name":{"type":"string","title":"Name"},"content":{"type":"string","title":"Content"},"mime_type":{"anyOf":[{"$ref":"#/components/schemas/MimeTypes"},{"type":"null"}]},"source_uri":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Source Uri"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"title":"Meta"},"index_status":{"anyOf":[{"$ref":"#/components/schemas/DocIndexTaskStatus"},{"type":"null"}]},"index_result":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Index Result"},"data_source":{"anyOf":[{"$ref":"#/components/schemas/DataSourceDescriptor"},{"type":"null"}]},"knowledge_base":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseDescriptor"},{"type":"null"}]},"last_modified_at":{"type":"string","format":"date-time","title":"Last Modified At"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","hash","name","content","mime_type","source_uri","meta","index_status","index_result","data_source","knowledge_base","last_modified_at","created_at","updated_at"],"title":"DocumentItem"},"EmbeddingModelCreate":{"properties":{"name":{"type":"string","title":"Name"},"provider":{"$ref":"#/components/schemas/EmbeddingProvider"},"model":{"type":"string","title":"Model"},"vector_dimension":{"type":"integer","title":"Vector Dimension"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"title":"Config"},"credentials":{"title":"Credentials"},"is_default":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Is Default","default":false}},"type":"object","required":["name","provider","model","vector_dimension","config","credentials"],"title":"EmbeddingModelCreate"},"EmbeddingModelDescriptor":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"provider":{"$ref":"#/components/schemas/EmbeddingProvider"},"model":{"type":"string","title":"Model"},"vector_dimension":{"type":"integer","title":"Vector Dimension"},"is_default":{"type":"boolean","title":"Is Default"}},"type":"object","required":["id","name","provider","model","vector_dimension","is_default"],"title":"EmbeddingModelDescriptor"},"EmbeddingModelDetail":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"provider":{"$ref":"#/components/schemas/EmbeddingProvider"},"model":{"type":"string","title":"Model"},"vector_dimension":{"type":"integer","title":"Vector Dimension"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"title":"Config"},"is_default":{"type":"boolean","title":"Is Default"},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","provider","model","vector_dimension","config","is_default","created_at","updated_at"],"title":"EmbeddingModelDetail"},"EmbeddingModelItem":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"provider":{"$ref":"#/components/schemas/EmbeddingProvider"},"model":{"type":"string","title":"Model"},"vector_dimension":{"type":"integer","title":"Vector Dimension"},"is_default":{"type":"boolean","title":"Is Default"}},"type":"object","required":["id","name","provider","model","vector_dimension","is_default"],"title":"EmbeddingModelItem"},"EmbeddingModelTestResult":{"properties":{"success":{"type":"boolean","title":"Success"},"error":{"type":"string","title":"Error","default":""}},"type":"object","required":["success"],"title":"EmbeddingModelTestResult"},"EmbeddingModelUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"title":"Config"},"credentials":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Credentials"}},"type":"object","title":"EmbeddingModelUpdate"},"EmbeddingProvider":{"type":"string","enum":["openai","jina","cohere","bedrock","ollama","giteeai","local","openai_like","azure_openai"],"title":"EmbeddingProvider"},"EmbeddingProviderOption":{"properties":{"provider":{"$ref":"#/components/schemas/EmbeddingProvider"},"provider_display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Display Name"},"provider_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Description"},"provider_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Url"},"default_embedding_model":{"type":"string","title":"Default Embedding Model"},"embedding_model_description":{"type":"string","title":"Embedding Model Description"},"default_config":{"additionalProperties":true,"type":"object","title":"Default Config","default":{}},"config_description":{"type":"string","title":"Config Description","default":""},"default_credentials":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}],"title":"Default Credentials","default":""},"credentials_display_name":{"type":"string","title":"Credentials Display Name"},"credentials_description":{"type":"string","title":"Credentials Description"},"credentials_type":{"type":"string","title":"Credentials Type","default":"str"}},"type":"object","required":["provider","default_embedding_model","embedding_model_description","credentials_display_name","credentials_description"],"title":"EmbeddingProviderOption"},"EntityPublic":{"properties":{"id":{"type":"integer","title":"Id"},"entity_type":{"$ref":"#/components/schemas/EntityType","default":"original"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"},"synopsis_info":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Synopsis Info"}},"type":"object","required":["id","name"],"title":"EntityPublic"},"EntityType":{"type":"string","enum":["original","synopsis"],"title":"EntityType"},"EntityUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"}},"type":"object","title":"EntityUpdate"},"ErrorModel":{"properties":{"detail":{"anyOf":[{"type":"string"},{"additionalProperties":{"type":"string"},"type":"object"}],"title":"Detail"}},"type":"object","required":["detail"],"title":"ErrorModel"},"EvaluationDataset":{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"name":{"type":"string","maxLength":255,"title":"Name"},"user_id":{"type":"string","format":"uuid","title":"User Id"}},"type":"object","required":["name","user_id"],"title":"EvaluationDataset"},"EvaluationDatasetItem":{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"query":{"type":"string","title":"Query"},"reference":{"type":"string","title":"Reference"},"retrieved_contexts":{"items":{"type":"string"},"type":"array","title":"Retrieved Contexts","default":[]},"extra":{"additionalProperties":true,"type":"object","title":"Extra","default":{}},"evaluation_dataset_id":{"type":"integer","title":"Evaluation Dataset Id"}},"type":"object","required":["query","reference","evaluation_dataset_id"],"title":"EvaluationDatasetItem"},"EvaluationStatus":{"type":"string","enum":["not_start","evaluating","done","error","cancel"],"title":"EvaluationStatus"},"EvaluationTask":{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"name":{"type":"string","maxLength":255,"title":"Name"},"user_id":{"type":"string","format":"uuid","title":"User Id"},"dataset_id":{"type":"integer","title":"Dataset Id"}},"type":"object","required":["name","user_id","dataset_id"],"title":"EvaluationTask"},"EvaluationTaskItem":{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"chat_engine":{"type":"string","maxLength":255,"title":"Chat Engine"},"status":{"$ref":"#/components/schemas/EvaluationStatus"},"query":{"type":"string","title":"Query"},"reference":{"type":"string","title":"Reference"},"response":{"type":"string","title":"Response"},"retrieved_contexts":{"items":{"type":"string"},"type":"array","title":"Retrieved Contexts","default":[]},"extra":{"additionalProperties":true,"type":"object","title":"Extra","default":{}},"error_msg":{"type":"string","title":"Error Msg"},"factual_correctness":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Factual Correctness"},"semantic_similarity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Semantic Similarity"},"evaluation_task_id":{"type":"integer","title":"Evaluation Task Id"}},"type":"object","required":["chat_engine","status","query","reference","response","error_msg","factual_correctness","semantic_similarity","evaluation_task_id"],"title":"EvaluationTaskItem"},"EvaluationTaskOverview":{"properties":{"not_start":{"type":"integer","title":"Not Start"},"succeed":{"type":"integer","title":"Succeed"},"errored":{"type":"integer","title":"Errored"},"progressing":{"type":"integer","title":"Progressing"},"cancel":{"type":"integer","title":"Cancel"},"avg_factual_correctness":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avg Factual Correctness"},"avg_semantic_similarity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Avg Semantic Similarity"},"min_factual_correctness":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Factual Correctness"},"min_semantic_similarity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Min Semantic Similarity"},"max_factual_correctness":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Factual Correctness"},"max_semantic_similarity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Max Semantic Similarity"},"std_factual_correctness":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Std Factual Correctness"},"std_semantic_similarity":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Std Semantic Similarity"}},"type":"object","required":["not_start","succeed","errored","progressing","cancel","avg_factual_correctness","avg_semantic_similarity","min_factual_correctness","min_semantic_similarity","max_factual_correctness","max_semantic_similarity","std_factual_correctness","std_semantic_similarity"],"title":"EvaluationTaskOverview"},"EvaluationTaskSummary":{"properties":{"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"name":{"type":"string","title":"Name"},"user_id":{"type":"string","format":"uuid","title":"User Id"},"dataset_id":{"type":"integer","title":"Dataset Id"},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"summary":{"$ref":"#/components/schemas/EvaluationTaskOverview"}},"type":"object","required":["id","name","user_id","dataset_id","created_at","updated_at","summary"],"title":"EvaluationTaskSummary"},"ExternalChatEngine":{"properties":{"stream_chat_api_url":{"type":"string","title":"Stream Chat Api Url"}},"type":"object","title":"ExternalChatEngine"},"FeedbackFilters":{"properties":{"created_at_start":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At Start"},"created_at_end":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At End"},"feedback_origin":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Feedback Origin"},"chat_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Chat Id"},"feedback_type":{"anyOf":[{"$ref":"#/components/schemas/FeedbackType"},{"type":"null"}]},"user_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"User Id"}},"type":"object","title":"FeedbackFilters"},"FeedbackOrigin":{"properties":{"origin":{"type":"string","title":"Origin"},"feedbacks":{"type":"integer","title":"Feedbacks"}},"type":"object","required":["origin","feedbacks"],"title":"FeedbackOrigin"},"FeedbackRequest":{"properties":{"feedback_type":{"$ref":"#/components/schemas/FeedbackType"},"comment":{"type":"string","title":"Comment"}},"type":"object","required":["feedback_type","comment"],"title":"FeedbackRequest"},"FeedbackType":{"type":"string","enum":["like","dislike"],"title":"FeedbackType"},"GeneralChunkingConfig":{"properties":{"mode":{"$ref":"#/components/schemas/ChunkingMode","default":"general"},"chunk_size":{"type":"integer","exclusiveMinimum":0.0,"title":"Chunk Size","default":1200},"chunk_overlap":{"type":"integer","exclusiveMinimum":0.0,"title":"Chunk Overlap","default":200},"paragraph_separator":{"type":"string","title":"Paragraph Separator","default":"\n\n\n"}},"type":"object","title":"GeneralChunkingConfig"},"GraphSearchRequest":{"properties":{"query":{"type":"string","title":"Query"},"include_meta":{"type":"boolean","title":"Include Meta","default":true},"depth":{"type":"integer","title":"Depth","default":2},"with_degree":{"type":"boolean","title":"With Degree","default":true},"relationship_meta_filters":{"additionalProperties":true,"type":"object","title":"Relationship Meta Filters","default":{}}},"type":"object","required":["query"],"title":"GraphSearchRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"ImageBlock":{"properties":{"block_type":{"type":"string","const":"image","title":"Block Type","default":"image"},"image":{"anyOf":[{"type":"string","format":"binary"},{"type":"null"}],"title":"Image"},"path":{"anyOf":[{"type":"string","format":"file-path"},{"type":"null"}],"title":"Path"},"url":{"anyOf":[{"type":"string","minLength":1,"format":"uri"},{"type":"string"},{"type":"null"}],"title":"Url"},"image_mimetype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Image Mimetype"},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail"}},"type":"object","title":"ImageBlock","description":"A representation of image data to directly pass to/from the LLM."},"IndexMethod":{"type":"string","enum":["knowledge_graph","vector"],"title":"IndexMethod"},"KBChunkRetrievalConfig":{"properties":{"vector_search":{"$ref":"#/components/schemas/VectorSearchRetrieverConfig"}},"type":"object","required":["vector_search"],"title":"KBChunkRetrievalConfig"},"KBDataSource":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"data_source_type":{"$ref":"#/components/schemas/DataSourceType"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"}],"title":"Config"}},"type":"object","required":["id","name","data_source_type","config"],"title":"KBDataSource","description":"Represents a linked data source for a knowledge base."},"KBDataSourceCreate":{"properties":{"name":{"type":"string","title":"Name"},"data_source_type":{"$ref":"#/components/schemas/DataSourceType"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"}],"title":"Config"}},"type":"object","required":["name","data_source_type","config"],"title":"KBDataSourceCreate"},"KBDataSourceUpdate":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"KBDataSourceUpdate"},"KBKnowledgeGraphRetrievalConfig":{"properties":{"knowledge_graph":{"$ref":"#/components/schemas/KnowledgeGraphRetrieverConfig"}},"type":"object","required":["knowledge_graph"],"title":"KBKnowledgeGraphRetrievalConfig"},"KBRetrieveChunksRequest":{"properties":{"query":{"type":"string","title":"Query"},"retrieval_config":{"$ref":"#/components/schemas/KBChunkRetrievalConfig"}},"type":"object","required":["query","retrieval_config"],"title":"KBRetrieveChunksRequest"},"KBRetrieveKnowledgeGraphRequest":{"properties":{"query":{"type":"string","title":"Query"},"llm_id":{"type":"integer","title":"Llm Id"},"retrieval_config":{"$ref":"#/components/schemas/KBKnowledgeGraphRetrievalConfig"}},"type":"object","required":["query","llm_id","retrieval_config"],"title":"KBRetrieveKnowledgeGraphRequest"},"KGIndexError":{"properties":{"document_id":{"type":"integer","title":"Document Id"},"document_name":{"type":"string","title":"Document Name"},"source_uri":{"type":"string","title":"Source Uri"},"chunk_id":{"type":"string","format":"uuid","title":"Chunk Id"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["document_id","document_name","source_uri","chunk_id"],"title":"KGIndexError"},"KgIndexStatus":{"type":"string","enum":["not_started","pending","running","completed","failed"],"title":"KgIndexStatus"},"KnowledgeBaseCreate":{"properties":{"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"index_methods":{"items":{"$ref":"#/components/schemas/IndexMethod"},"type":"array","title":"Index Methods"},"llm_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Llm Id"},"embedding_model_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Embedding Model Id"},"chunking_config":{"anyOf":[{"$ref":"#/components/schemas/GeneralChunkingConfig"},{"$ref":"#/components/schemas/AdvancedChunkingConfig-Input"}],"title":"Chunking Config"},"data_sources":{"items":{"$ref":"#/components/schemas/KBDataSourceCreate"},"type":"array","title":"Data Sources"}},"type":"object","required":["name"],"title":"KnowledgeBaseCreate"},"KnowledgeBaseDescriptor":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"}},"type":"object","required":["id","name"],"title":"KnowledgeBaseDescriptor"},"KnowledgeBaseDetail":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"documents_total":{"type":"integer","title":"Documents Total"},"data_sources_total":{"type":"integer","title":"Data Sources Total"},"data_sources":{"items":{"$ref":"#/components/schemas/KBDataSource"},"type":"array","title":"Data Sources"},"chunking_config":{"anyOf":[{"$ref":"#/components/schemas/GeneralChunkingConfig"},{"$ref":"#/components/schemas/AdvancedChunkingConfig-Output"},{"type":"null"}],"title":"Chunking Config"},"index_methods":{"items":{"$ref":"#/components/schemas/IndexMethod"},"type":"array","title":"Index Methods"},"llm_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Llm Id"},"llm":{"anyOf":[{"$ref":"#/components/schemas/LLMDescriptor"},{"type":"null"}]},"embedding_model_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Embedding Model Id"},"embedding_model":{"anyOf":[{"$ref":"#/components/schemas/EmbeddingModelDescriptor"},{"type":"null"}]},"creator":{"anyOf":[{"$ref":"#/components/schemas/UserDescriptor"},{"type":"null"}]},"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"}},"type":"object","required":["id","name","documents_total","data_sources_total","data_sources","index_methods"],"title":"KnowledgeBaseDetail","description":"Represents a detailed view of a knowledge base."},"KnowledgeBaseItem":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"documents_total":{"type":"integer","title":"Documents Total"},"data_sources_total":{"type":"integer","title":"Data Sources Total"},"index_methods":{"items":{"$ref":"#/components/schemas/IndexMethod"},"type":"array","title":"Index Methods"},"creator":{"anyOf":[{"$ref":"#/components/schemas/UserDescriptor"},{"type":"null"}]},"created_at":{"type":"string","format":"date-time","title":"Created At"},"updated_at":{"type":"string","format":"date-time","title":"Updated At"}},"type":"object","required":["id","name","documents_total","data_sources_total","index_methods","created_at","updated_at"],"title":"KnowledgeBaseItem","description":"Represents a simplified view of a knowledge base for list display purposes."},"KnowledgeBaseOption":{"properties":{"linked_knowledge_base":{"$ref":"#/components/schemas/LinkedKnowledgeBase"},"linked_knowledge_bases":{"anyOf":[{"items":{"$ref":"#/components/schemas/LinkedKnowledgeBase"},"type":"array"},{"type":"null"}],"title":"Linked Knowledge Bases"}},"type":"object","title":"KnowledgeBaseOption"},"KnowledgeBaseUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"chunking_config":{"anyOf":[{"$ref":"#/components/schemas/GeneralChunkingConfig"},{"$ref":"#/components/schemas/AdvancedChunkingConfig-Input"},{"type":"null"}],"title":"Chunking Config"}},"type":"object","title":"KnowledgeBaseUpdate"},"KnowledgeChunkRequest":{"properties":{"relationships_ids":{"items":{"type":"integer"},"type":"array","title":"Relationships Ids"}},"type":"object","required":["relationships_ids"],"title":"KnowledgeChunkRequest"},"KnowledgeGraphOption":{"properties":{"depth":{"type":"integer","title":"Depth","default":2},"include_meta":{"type":"boolean","title":"Include Meta","default":false},"with_degree":{"type":"boolean","title":"With Degree","default":false},"metadata_filter":{"anyOf":[{"$ref":"#/components/schemas/MetadataFilterConfig"},{"type":"null"}]},"enabled":{"type":"boolean","title":"Enabled","default":true},"using_intent_search":{"type":"boolean","title":"Using Intent Search","default":true}},"type":"object","title":"KnowledgeGraphOption"},"KnowledgeGraphRetrievalConfig":{"properties":{"llm_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Llm Id"},"knowledge_base_ids":{"items":{"type":"integer"},"type":"array","title":"Knowledge Base Ids"},"use_query_decompose":{"anyOf":[{"type":"boolean"},{"type":"null"}],"title":"Use Query Decompose"},"knowledge_graph":{"$ref":"#/components/schemas/KnowledgeGraphRetrieverConfig"}},"type":"object","required":["knowledge_base_ids","knowledge_graph"],"title":"KnowledgeGraphRetrievalConfig"},"KnowledgeGraphRetrievalRequest":{"properties":{"query":{"type":"string","title":"Query"},"retrieval_config":{"$ref":"#/components/schemas/KnowledgeGraphRetrievalConfig"}},"type":"object","required":["query","retrieval_config"],"title":"KnowledgeGraphRetrievalRequest"},"KnowledgeGraphRetrieverConfig":{"properties":{"depth":{"type":"integer","title":"Depth","default":2},"include_meta":{"type":"boolean","title":"Include Meta","default":false},"with_degree":{"type":"boolean","title":"With Degree","default":false},"metadata_filter":{"anyOf":[{"$ref":"#/components/schemas/MetadataFilterConfig"},{"type":"null"}]}},"type":"object","title":"KnowledgeGraphRetrieverConfig"},"KnowledgeNeighborRequest":{"properties":{"entities_ids":{"items":{"type":"integer"},"type":"array","title":"Entities Ids"},"query":{"type":"string","title":"Query"},"max_depth":{"type":"integer","title":"Max Depth","default":1},"max_neighbors":{"type":"integer","title":"Max Neighbors","default":20},"similarity_threshold":{"type":"number","title":"Similarity Threshold","default":0.55}},"type":"object","required":["entities_ids","query"],"title":"KnowledgeNeighborRequest"},"KnowledgeRequest":{"properties":{"query":{"type":"string","title":"Query"},"similarity_threshold":{"type":"number","title":"Similarity Threshold","default":0.55},"top_k":{"type":"integer","title":"Top K","default":10}},"type":"object","required":["query"],"title":"KnowledgeRequest"},"LLM":{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","maxLength":64,"title":"Name"},"provider":{"$ref":"#/components/schemas/LLMProvider"},"model":{"type":"string","maxLength":256,"title":"Model"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"title":"Config","default":{}},"is_default":{"type":"boolean","title":"Is Default","default":false},"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"credentials":{"title":"Credentials"}},"type":"object","required":["name","provider","model","credentials"],"title":"LLM"},"LLMDescriptor":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"provider":{"$ref":"#/components/schemas/LLMProvider"},"model":{"type":"string","title":"Model"},"is_default":{"type":"boolean","title":"Is Default"}},"type":"object","required":["id","name","provider","model","is_default"],"title":"LLMDescriptor"},"LLMOption":{"properties":{"intent_graph_knowledge":{"type":"string","title":"Intent Graph Knowledge","default":"Given a list of prerequisite questions and their relevant knowledge for the user's main question, when conflicts in meaning arise, prioritize the relationship with the higher weight and the more recent version.\n\nKnowledge sub-queries:\n\n{% for sub_query, data in sub_queries.items() %}\n\nSub-query: {{ sub_query }}\n\n  - Entities:\n{% for entity in data['entities'] %}\n    - Name: {{ entity.name }}\n      Description: {{ entity.description }}\n{% endfor %}\n\n  - Relationships:\n{% for relationship in data['relationships'] %}\n    - Description: {{ relationship.rag_description }}\n      Weight: {{ relationship.weight }}\n{% endfor %}\n\n{% endfor %}\n"},"normal_graph_knowledge":{"type":"string","title":"Normal Graph Knowledge","default":"Given a list of relationships of a knowledge graph as follows. When there is a conflict in meaning between knowledge relationships, the relationship with the higher `weight` and newer `last_modified_at` value takes precedence.\n\n---------------------\nEntities:\n\n{% for entity in entities %}\n- Name: {{ entity.name }}\n  Description: {{ entity.description }}\n{% endfor %}\n\n---------------------\n\nKnowledge relationships:\n\n{% for relationship in relationships %}\n\n- Description: {{ relationship.rag_description }}\n- Weight: {{ relationship.weight }}\n- Last Modified At: {{ relationship.last_modified_at }}\n- Meta: {{ relationship.meta | tojson(indent=2) }}\n\n{% endfor %}\n"},"condense_question_prompt":{"type":"string","title":"Condense Question Prompt","default":"Current Date: {{current_date}}\n---------------------\nThe prerequisite questions and their relevant knowledge for the user's main question.\n---------------------\n\n{{graph_knowledges}}\n\n---------------------\n\nTask:\nGiven the conversation between the Human and Assistant, along with the follow-up message from the Human, and the provided prerequisite questions and relevant knowledge, refine the Human’s follow-up message into a standalone, detailed question.\n\nInstructions:\n1. Focus on the latest query from the Human, ensuring it is given the most weight.\n2. Incorporate Key Information:\n  - Use the prerequisite questions and their relevant knowledge to add specific details to the follow-up question.\n  - Replace ambiguous terms or references in the follow-up question with precise information from the provided knowledge. Example: Replace “latest version” with the actual version number mentioned in the knowledge.\n3. Utilize Conversation Context:\n  - Incorporate relevant context and background information from the conversation history to enhance the question's specificity.\n4. Optimize for Retrieval:\n  - Ensure the refined question emphasizes specific and relevant terms to maximize the effectiveness of a vector search for retrieving precise and comprehensive information.\n5. Grounded and Factual:\n  - Make sure the refined question is grounded in and directly based on the user's follow-up question and the provided knowledge.\n  - Do not introduce information that is not supported by the knowledge or conversation history.\n6. Give the language hint for the answer:\n  - Add a hint after the question like \"(Answer language: English)\", or \"(Answer language: Chinese)\", etc.\n  - This language hint should be exactly same with the language of the original question.\n  - If the original question has part of other language aside from English, please use the language of another language rather than English. Example: \"tidb tableread慢会是哪些原因\", it should be Chinese.\n\nExample:\n\nChat History:\n\nHuman: \"I'm interested in the performance improvements in the latest version of TiDB.\"\nAssistant: \"TiDB version 8.1 was released recently with significant performance enhancements over version 6.5.\"\n\nFollow-up Question:\n\n\"Can you tell me more about these improvements?\"\n\nPrerequisite Questions and Relevant Knowledge:\n\n- Prerequisite Question: What is the latest version of TiDB?\n- Relevant Knowledge: The latest version of TiDB is 8.1.\n\n...\n\nRefined Standalone Question:\n\n\"Can you provide detailed information about the performance improvements introduced in TiDB version 8.1 compared to version 6.5? (Answer language: English)\"\n\nYour Turn:\n\nChat history:\n\n{{chat_history}}\n\n---------------------\n\nFollowup question:\n\n{{question}}\n\n---------------------\n\nRefined standalone question:\n"},"clarifying_question_prompt":{"type":"string","title":"Clarifying Question Prompt","default":"---------------------\nThe prerequisite questions and their relevant knowledge for the user's main question.\n---------------------\n\n{{graph_knowledges}}\n\n---------------------\n\nTask:\nGiven the conversation between the user and ASSISTANT, along with the follow-up message from the user, and the provided prerequisite questions and relevant knowledge, determine if the user's question is clear and specific enough for a confident response. \n\nIf the question lacks necessary details or context, identify the specific ambiguities and generate a clarifying question to address them.\nIf the question is clear and answerable, return exact \"False\" as the response.\n\nInstructions:\n1. Assess Information Sufficiency:\n   - Evaluate if the user's question provides enough detail to generate a precise answer based on the prerequisite questions, relevant knowledge, and conversation history.\n   - If the user's question is too vague or lacks key information, identify what additional information would be necessary for clarity.\n\n2. Generate a Clarifying Question:\n   - If the question is clear and answerable, return exact \"False\" as the response.\n   - If clarification is needed, return a specific question to ask the user, directly addressing the information gap. Avoid general questions; focus on the specific details required for an accurate answer.\n\n3. Use the same language to ask the clarifying question as the user's original question.\n\nExample 1:\n\nuser: \"Does TiDB support foreign keys?\"\nRelevant Knowledge: TiDB supports foreign keys starting from version 6.6.0.\n\nResponse:\n\nWhich version of TiDB are you using?\n\nExample 2:\n\nuser: \"Does TiDB support nested transaction?\"\nRelevant Knowledge: TiDB supports nested transaction starting from version 6.2.0.\n\nResponse:\n\nWhich version of TiDB are you using?\n\nExample 3:\n\nuser: \"Does TiDB support foreign keys? I'm using TiDB 6.5.0.\"\nRelevant Knowledge: TiDB supports foreign keys starting from version 6.6.0.\n\nResponse:\n\nFalse\n\nYour Turn:\n\nChat history:\n\n{{chat_history}}\n\n---------------------\n\nFollow-up question:\n\n{{question}}\n\nResponse:\n"},"text_qa_prompt":{"type":"string","title":"Text Qa Prompt","default":"Current Date: {{current_date}}\n---------------------\nKnowledge graph information is below\n---------------------\n\n{{graph_knowledges}}\n\n---------------------\nContext information is below.\n---------------------\n\n{{context_str}}\n\n---------------------\n\nAnswer Format:\n\nUse markdown footnote syntax (for example: [^1]) to indicate sources you used.\nEach footnote must correspond to a unique source. Do not use the same source for multiple footnotes.\n\n### Examples of Correct Footnote Usage (no the unique sources and diverse sources):\n[^1]: [TiDB Overview | PingCAP Docs](https://docs.pingcap.com/tidb/stable/overview)\n[^2]: [TiDB Architecture | PingCAP Docs](https://docs.pingcap.com/tidb/stable/architecture)\n\n### Examples of Incorrect Footnote Usage (Avoid duplicating the same source for multiple footnotes):\n[^1]: [TiDB Introduction | PingCAP Docs](https://docs.pingcap.com/tidb/v5.4/overview)\n[^2]: [TiDB Introduction | PingCAP Docs](https://docs.pingcap.com/tidb/v5.4/overview)\n[^3]: [TiDB Introduction | PingCAP Docs](https://docs.pingcap.com/tidb/dev/overview)\n[^4]: [TiDB Introduction | PingCAP Docs](https://docs.pingcap.com/tidb/stable/overview)\n\n---------------------\n\nAnswer Language:\n\nFollow the language of the language hint after the Refined Question.\nIf the language hint is not provided, use the language that the original questions used.\n\n---------------------\n\nAs a customer support assistant, please do not fabricate any knowledge. If you cannot get knowledge from the context, please just directly state \"you do not know\", rather than constructing nonexistent and potentially fake information!!!\n\nFirst, analyze the provided context information without assuming prior knowledge. Identify all relevant aspects of knowledge contained within. Then, from various perspectives and angles, answer questions as thoroughly and comprehensively as possible to better address and resolve the user's issue.\n\nThe Original questions is:\n\n{{original_question}}\n\nThe Refined Question used to search:\n\n{{query_str}}\n\nAnswer:\n"},"further_questions_prompt":{"type":"string","title":"Further Questions Prompt","default":"The chat message content is:\n\n{{chat_message_content}}\n\n---------------------\nTask:\nBased on the provided chat message, generate 3–5 follow-up questions that are relevant to the content. Each question should explore the topic in greater detail, seek clarification, or introduce new angles for discussion.\n\nInstructions:\n1. Build upon the key information, themes, or insights within the provided chat message.\n2. Aim for variety in question type (clarifying, probing, or exploratory) to encourage a deeper conversation.\n3. Ensure each question logically follows from the context of the provided chat message.\n4. Keep questions concise yet insightful to maximize engagement.\n5. Use the same language with the chat message content.\n6. Each question should end with a question mark.\n7. Each question should be in a new line, DO NOT add any indexes or blank lines, just output the questions.\n\nNow, generate 3–5 follow-up questions below:\n"},"generate_goal_prompt":{"type":"string","title":"Generate Goal Prompt","default":"Given the conversation history between the User and Assistant, along with the latest follow-up question from the User, perform the following tasks:\n\n1. **Language Detection**:\n    - Analyze the User's follow-up question to determine the language used.\n\n2. **Context Classification**:\n    - **Determine Relevance to TiDB**:\n        - Assess whether the follow-up question is related to TiDB products, support, or any TiDB-related context.\n    - **Set Background Accordingly**:\n        - **If Related to TiDB**:\n            - Set the background to encompass the relevant TiDB context. This may include aspects like TiDB features, configurations, best practices, troubleshooting, or general consulting related to TiDB.\n            - Example backgrounds:\n                - \"TiDB product configuration and optimization.\"\n                - \"TiDB troubleshooting and support.\"\n                - \"TiDB feature consultation.\"\n        - **If Unrelated to TiDB**:\n            - Set the background to \"Other topics.\"\n\n3. **Goal Generation**:\n    - **Clarify Intent to Avoid Ambiguity**:\n        - **Instructional Guidance**:\n            - If the User's question seeks guidance or a method (e.g., starts with \"How to\"), ensure the goal reflects a request for a step-by-step guide or best practices.\n        - **Information Retrieval**:\n            - If the User's question seeks specific information or confirmation (e.g., starts with \"Can you\" or \"Is it possible\"), rephrase it to focus on providing the requested information or verification without implying that the assistant should perform any actions.\n            - **Important**: Do not interpret these questions as requests for the assistant to execute operations. Instead, understand whether the user seeks to confirm certain information or requires a proposed solution, and restrict responses to information retrieval and guidance based on available documentation.\n    - **Reformulate the Latest User Follow-up Question**:\n        - Ensure the question is clear, directive, and suitable for a Q&A format.\n    - **Specify Additional Details**:\n        - **Detected Language**: Clearly indicate the language.\n        - **Desired Answer Format**: Specify if the answer should be in text, table, code snippet, etc.\n        - **Additional Requirements**: Include any other necessary instructions to tailor the response appropriately.\n\n4. **Output**:\n    - Produce a goal string in the following format:\n      \"[Refined Question] (Lang: [Detected Language], Format: [Format], Background: [Specified Goal Scenario])\"\n\n**Examples**:\n\n**Example 1**:\n\nChat history:\n\n[]\n\nFollow-up question:\n\n\"tidb encryption at rest 会影响数据压缩比例吗？\"\n\nGoal:\n\nDoes encryption at rest in TiDB affect the data compression ratio? (Lang: Chinese, Format: text, Background: TiDB product related consulting.)\n\n---------------------\n\n**Example 2**:\n\nChat history:\n\n[]\n\nFollow-up question:\n\n\"干嘛的？\"\n\nGoal:\n\nWhat can you do? (Lang: Chinese, Format: text, Background: General inquiry about the assistant's capabilities.)\n\n---------------------\n\n**Example 3**:\n\nChat history:\n\n[]\n\nFollow-up question:\n\n\"oracle 怎么样？\"\n\nGoal:\n\nHow is Oracle? (Lang: Chinese, Format: text, Background: Other topics.)\n\n---------------------\n\n**Example 4**:\n\nChat history:\n\n[]\n\nFollow-up question:\n\n\"Why is TiDB Serverless up to 70% cheaper than MySQL RDS? (use a table if possible)\"\n\nGoal:\n\nWhy is TiDB Serverless up to 70% cheaper than MySQL RDS? Please provide a comparison in a table format if possible. (Lang: English, Format: table, Background: Cost comparison between TiDB Serverless and MySQL RDS.)\n\n---------------------\n\n**Example 5 (Enhanced for Clarity and Guidance)**:\n\nChat history:\n\n[]\n\nFollow-up question:\n\n\"能否找到 tidb 中哪些视图的定义中包含已经被删除的表？\"\n\nGoal:\n\nHow to find which views in TiDB have definitions that include tables that have been deleted? (Lang: Chinese, Format: text, Background: TiDB product related consulting.)\n\n---------------------\n\n**Your Task**:\n\nChat history:\n\n{{chat_history}}\n\nFollow-up question:\n\n{{question}}\n\nGoal:\n"}},"type":"object","title":"LLMOption"},"LLMProvider":{"type":"string","enum":["openai","gemini","vertex_ai","anthropic_vertex","openai_like","bedrock","ollama","giteeai","azure_openai"],"title":"LLMProvider"},"LLMProviderOption":{"properties":{"provider":{"$ref":"#/components/schemas/LLMProvider"},"provider_display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Display Name"},"provider_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Description"},"provider_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Url"},"default_llm_model":{"type":"string","title":"Default Llm Model"},"llm_model_description":{"type":"string","title":"Llm Model Description"},"default_config":{"additionalProperties":true,"type":"object","title":"Default Config","default":{}},"config_description":{"type":"string","title":"Config Description","default":""},"default_credentials":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}],"title":"Default Credentials","default":""},"credentials_display_name":{"type":"string","title":"Credentials Display Name"},"credentials_description":{"type":"string","title":"Credentials Description"},"credentials_type":{"type":"string","title":"Credentials Type","default":"str"}},"type":"object","required":["provider","default_llm_model","llm_model_description","credentials_display_name","credentials_description"],"title":"LLMProviderOption"},"LLMTestResult":{"properties":{"success":{"type":"boolean","title":"Success"},"error":{"type":"string","title":"Error","default":""}},"type":"object","required":["success"],"title":"LLMTestResult"},"LLMUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Config"},"credentials":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Credentials"}},"type":"object","title":"LLMUpdate"},"LangfuseSetting":{"properties":{"host":{"type":"string","title":"Host","default":"https://us.cloud.langfuse.com"},"public_key":{"type":"string","title":"Public Key"},"secret_key":{"type":"string","title":"Secret Key"}},"type":"object","required":["public_key","secret_key"],"title":"LangfuseSetting"},"LangfuseTestResult":{"properties":{"success":{"type":"boolean","title":"Success"},"error":{"type":"string","title":"Error","default":""}},"type":"object","required":["success"],"title":"LangfuseTestResult"},"LinkedKnowledgeBase":{"properties":{"id":{"type":"integer","title":"Id"}},"type":"object","required":["id"],"title":"LinkedKnowledgeBase"},"MarkdownNodeParserOptions":{"properties":{"chunk_size":{"type":"integer","exclusiveMinimum":0.0,"title":"Chunk Size","description":"The token chunk size for each chunk.","default":1000},"chunk_header_level":{"type":"integer","maximum":6.0,"minimum":1.0,"title":"Chunk Header Level","description":"The header level to split on","default":2}},"type":"object","title":"MarkdownNodeParserOptions"},"MessageRole":{"type":"string","enum":["system","developer","user","assistant","function","tool","chatbot","model"],"title":"MessageRole","description":"Message role."},"MetadataFilterConfig":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":true},"filters":{"additionalProperties":true,"type":"object","title":"Filters"}},"type":"object","title":"MetadataFilterConfig"},"MimeTypes":{"type":"string","enum":["text/plain","text/markdown","application/pdf","application/vnd.openxmlformats-officedocument.wordprocessingml.document","application/vnd.openxmlformats-officedocument.presentationml.presentation","application/vnd.openxmlformats-officedocument.spreadsheetml.sheet","text/csv"],"title":"MimeTypes"},"ModifyEvaluationDatasetItem":{"properties":{"query":{"type":"string","title":"Query"},"reference":{"type":"string","title":"Reference"},"retrieved_contexts":{"items":{"type":"string"},"type":"array","title":"Retrieved Contexts"},"extra":{"additionalProperties":true,"type":"object","title":"Extra"},"evaluation_dataset_id":{"type":"integer","title":"Evaluation Dataset Id"}},"type":"object","required":["query","reference","retrieved_contexts","extra","evaluation_dataset_id"],"title":"ModifyEvaluationDatasetItem"},"NeedMigrationStatus":{"properties":{"chat_engines_without_kb_configured":{"items":{"type":"integer"},"type":"array","title":"Chat Engines Without Kb Configured"}},"type":"object","required":["chat_engines_without_kb_configured"],"title":"NeedMigrationStatus"},"NodeRelationship":{"type":"string","enum":["1","2","3","4","5"],"title":"NodeRelationship","description":"Node relationships used in `BaseNode` class.\n\nAttributes:\n    SOURCE: The node is the source document.\n    PREVIOUS: The node is the previous node in the document.\n    NEXT: The node is the next node in the document.\n    PARENT: The node is the parent node in the document.\n    CHILD: The node is a child node in the document."},"NodeWithScore":{"additionalProperties":true,"type":"object"},"ObjectType":{"type":"string","enum":["1","2","3","4","5"],"title":"ObjectType"},"OptionalConfigStatus":{"properties":{"langfuse":{"type":"boolean","title":"Langfuse"},"default_reranker":{"type":"boolean","title":"Default Reranker"}},"type":"object","required":["langfuse","default_reranker"],"title":"OptionalConfigStatus"},"Page_AdminFeedbackPublic_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AdminFeedbackPublic"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[AdminFeedbackPublic]"},"Page_AdminLLM_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AdminLLM"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[AdminLLM]"},"Page_AdminRerankerModel_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/AdminRerankerModel"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[AdminRerankerModel]"},"Page_ChatEngine_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ChatEngine"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[ChatEngine]"},"Page_ChatOrigin_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/ChatOrigin"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[ChatOrigin]"},"Page_Chat_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/Chat"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[Chat]"},"Page_DocumentItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/DocumentItem"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[DocumentItem]"},"Page_EmbeddingModelItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EmbeddingModelItem"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[EmbeddingModelItem]"},"Page_EvaluationDatasetItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EvaluationDatasetItem"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[EvaluationDatasetItem]"},"Page_EvaluationDataset_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EvaluationDataset"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[EvaluationDataset]"},"Page_EvaluationTaskItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EvaluationTaskItem"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[EvaluationTaskItem]"},"Page_EvaluationTaskSummary_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/EvaluationTaskSummary"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[EvaluationTaskSummary]"},"Page_FeedbackOrigin_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/FeedbackOrigin"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[FeedbackOrigin]"},"Page_KBDataSource_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/KBDataSource"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[KBDataSource]"},"Page_KGIndexError_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/KGIndexError"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[KGIndexError]"},"Page_KnowledgeBaseItem_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/KnowledgeBaseItem"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[KnowledgeBaseItem]"},"Page_PublicApiKey_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/PublicApiKey"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[PublicApiKey]"},"Page_UserDescriptor_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/UserDescriptor"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[UserDescriptor]"},"Page_VectorIndexError_":{"properties":{"items":{"items":{"$ref":"#/components/schemas/VectorIndexError"},"type":"array","title":"Items"},"total":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Total"},"page":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Page"},"size":{"anyOf":[{"type":"integer","minimum":1.0},{"type":"null"}],"title":"Size"},"pages":{"anyOf":[{"type":"integer","minimum":0.0},{"type":"null"}],"title":"Pages"}},"type":"object","required":["items","total","page","size"],"title":"Page[VectorIndexError]"},"PublicApiKey":{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"description":{"type":"string","maxLength":100,"title":"Description"},"api_key_display":{"type":"string","maxLength":100,"title":"Api Key Display"},"is_active":{"type":"boolean","title":"Is Active","default":true},"user_id":{"type":"string","format":"uuid","title":"User Id"},"id":{"type":"integer","title":"Id"}},"type":"object","required":["description","api_key_display","user_id","id"],"title":"PublicApiKey"},"RebuildIndexResult":{"properties":{"reindex_document_ids":{"items":{"type":"integer"},"type":"array","title":"Reindex Document Ids"},"ignore_document_ids":{"items":{"type":"integer"},"type":"array","title":"Ignore Document Ids"},"reindex_chunk_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Reindex Chunk Ids"},"ignore_chunk_ids":{"items":{"type":"string","format":"uuid"},"type":"array","title":"Ignore Chunk Ids"}},"type":"object","title":"RebuildIndexResult"},"RelatedNodeInfo":{"additionalProperties":true,"type":"object"},"RelationshipPublic":{"properties":{"id":{"type":"integer","title":"Id"},"description":{"type":"string","title":"Description"},"source_entity_id":{"type":"integer","title":"Source Entity Id"},"target_entity_id":{"type":"integer","title":"Target Entity Id"},"meta":{"additionalProperties":true,"type":"object","title":"Meta"},"weight":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Weight","default":0},"last_modified_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Modified At"},"document_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Document Id"},"chunk_id":{"anyOf":[{"type":"string","format":"uuid"},{"type":"null"}],"title":"Chunk Id"}},"type":"object","required":["id","description","source_entity_id","target_entity_id"],"title":"RelationshipPublic"},"RelationshipUpdate":{"properties":{"description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Description"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta"},"weight":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Weight"}},"type":"object","title":"RelationshipUpdate"},"RequiredConfigStatus":{"properties":{"default_llm":{"type":"boolean","title":"Default Llm"},"default_embedding_model":{"type":"boolean","title":"Default Embedding Model"},"default_chat_engine":{"type":"boolean","title":"Default Chat Engine"},"knowledge_base":{"type":"boolean","title":"Knowledge Base"}},"type":"object","required":["default_llm","default_embedding_model","default_chat_engine","knowledge_base"],"title":"RequiredConfigStatus"},"RerankerConfig":{"properties":{"enabled":{"type":"boolean","title":"Enabled","default":true},"model_id":{"type":"integer","title":"Model Id"},"top_n":{"type":"integer","title":"Top N","default":10}},"type":"object","title":"RerankerConfig"},"RerankerModel":{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"name":{"type":"string","maxLength":64,"title":"Name"},"provider":{"$ref":"#/components/schemas/RerankerProvider"},"model":{"type":"string","maxLength":256,"title":"Model"},"top_n":{"type":"integer","title":"Top N","default":10},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"title":"Config","default":{}},"is_default":{"type":"boolean","title":"Is Default","default":false},"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"credentials":{"title":"Credentials"}},"type":"object","required":["name","provider","model","credentials"],"title":"RerankerModel"},"RerankerModelUpdate":{"properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Name"},"config":{"anyOf":[{"additionalProperties":true,"type":"object"},{"items":{},"type":"array"},{"type":"null"}],"title":"Config"},"credentials":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Credentials"},"top_n":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Top N"}},"type":"object","title":"RerankerModelUpdate"},"RerankerProvider":{"type":"string","enum":["jina","cohere","baisheng","local","vllm","xinference","bedrock"],"title":"RerankerProvider"},"RerankerProviderOption":{"properties":{"provider":{"$ref":"#/components/schemas/RerankerProvider"},"provider_display_name":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Display Name"},"provider_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Description"},"provider_url":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Provider Url"},"default_reranker_model":{"type":"string","title":"Default Reranker Model"},"reranker_model_description":{"type":"string","title":"Reranker Model Description"},"default_top_n":{"type":"integer","title":"Default Top N","default":10},"default_credentials":{"anyOf":[{"type":"string"},{"additionalProperties":true,"type":"object"}],"title":"Default Credentials","default":""},"default_config":{"additionalProperties":true,"type":"object","title":"Default Config","default":{}},"config_description":{"type":"string","title":"Config Description","default":""},"credentials_display_name":{"type":"string","title":"Credentials Display Name"},"credentials_description":{"type":"string","title":"Credentials Description"},"credentials_type":{"type":"string","title":"Credentials Type","default":"str"}},"type":"object","required":["provider","default_reranker_model","reranker_model_description","credentials_display_name","credentials_description"],"title":"RerankerProviderOption"},"RetrievedChunk":{"properties":{"id":{"type":"string","title":"Id"},"text":{"type":"string","title":"Text"},"metadata":{"additionalProperties":true,"type":"object","title":"Metadata"},"document_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Document Id"},"score":{"type":"number","title":"Score"}},"type":"object","required":["id","text","metadata","document_id","score"],"title":"RetrievedChunk"},"RetrievedChunkDocument":{"properties":{"id":{"type":"integer","title":"Id"},"name":{"type":"string","title":"Name"},"source_uri":{"type":"string","title":"Source Uri"}},"type":"object","required":["id","name","source_uri"],"title":"RetrievedChunkDocument"},"RetrievedEntity":{"properties":{"id":{"type":"integer","title":"Id","description":"ID of the entity"},"knowledge_base_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Knowledge Base Id","description":"ID of the knowledge base"},"entity_type":{"anyOf":[{"$ref":"#/components/schemas/EntityType"},{"type":"null"}],"description":"Type of the entity","default":"original"},"name":{"type":"string","title":"Name","description":"Name of the entity"},"description":{"type":"string","title":"Description","description":"Description of the entity","default":""},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta","description":"Metadata of the entity","default":{}}},"type":"object","required":["id","name"],"title":"RetrievedEntity"},"RetrievedKnowledgeGraph":{"properties":{"query":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Query","description":"List of queries that are used to retrieve the knowledge graph"},"knowledge_base":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseDescriptor"},{"type":"null"}],"description":"The knowledge base that the knowledge graph is retrieved from"},"entities":{"items":{"$ref":"#/components/schemas/RetrievedEntity"},"type":"array","title":"Entities","description":"List of entities in the knowledge graph"},"relationships":{"items":{"$ref":"#/components/schemas/RetrievedRelationship"},"type":"array","title":"Relationships","description":"List of relationships in the knowledge graph"},"knowledge_bases":{"anyOf":[{"items":{"$ref":"#/components/schemas/KnowledgeBaseDescriptor"},"type":"array"},{"type":"null"}],"title":"Knowledge Bases","description":"List of knowledge bases that the knowledge graph is retrieved from"},"subgraphs":{"anyOf":[{"items":{"$ref":"#/components/schemas/RetrievedSubGraph"},"type":"array"},{"type":"null"}],"title":"Subgraphs","description":"List of subgraphs of the knowledge graph"}},"type":"object","title":"RetrievedKnowledgeGraph","description":"RetrievedKnowledgeGraph represents the structure of the knowledge graph retrieved\nfrom the knowledge base."},"RetrievedRelationship":{"properties":{"id":{"type":"integer","title":"Id","description":"ID of the relationship"},"knowledge_base_id":{"type":"integer","title":"Knowledge Base Id","description":"ID of the knowledge base"},"source_entity_id":{"type":"integer","title":"Source Entity Id","description":"ID of the source entity"},"target_entity_id":{"type":"integer","title":"Target Entity Id","description":"ID of the target entity"},"description":{"type":"string","title":"Description","description":"Description of the relationship"},"meta":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Meta","description":"Metadata of the relationship"},"rag_description":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Rag Description","description":"RAG description of the relationship"},"weight":{"anyOf":[{"type":"number"},{"type":"null"}],"title":"Weight","description":"Weight of the relationship"},"last_modified_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Last Modified At","description":"Last modified at of the relationship"}},"type":"object","required":["id","source_entity_id","target_entity_id","description","meta","rag_description","weight"],"title":"RetrievedRelationship"},"RetrievedSubGraph":{"properties":{"query":{"anyOf":[{"type":"string"},{"items":{"type":"string"},"type":"array"},{"type":"null"}],"title":"Query","description":"List of queries that are used to retrieve the knowledge graph"},"knowledge_base":{"anyOf":[{"$ref":"#/components/schemas/KnowledgeBaseDescriptor"},{"type":"null"}],"description":"The knowledge base that the knowledge graph is retrieved from"},"entities":{"items":{"$ref":"#/components/schemas/RetrievedEntity"},"type":"array","title":"Entities","description":"List of entities in the knowledge graph"},"relationships":{"items":{"$ref":"#/components/schemas/RetrievedRelationship"},"type":"array","title":"Relationships","description":"List of relationships in the knowledge graph"}},"type":"object","title":"RetrievedSubGraph"},"SentenceSplitterOptions":{"properties":{"chunk_size":{"type":"integer","exclusiveMinimum":0.0,"title":"Chunk Size","description":"The token chunk size for each chunk.","default":1000},"chunk_overlap":{"type":"integer","exclusiveMinimum":0.0,"title":"Chunk Overlap","description":"The overlap size for each chunk.","default":200},"paragraph_separator":{"type":"string","title":"Paragraph Separator","description":"The paragraph separator for splitting the text.","default":"\n\n\n"}},"type":"object","title":"SentenceSplitterOptions"},"SettingUpdate":{"properties":{"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"integer"},{"type":"number"},{"items":{},"type":"array"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Value"}},"type":"object","required":["value"],"title":"SettingUpdate"},"SettingValue":{"properties":{"name":{"type":"string","title":"Name"},"default":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"integer"},{"type":"number"},{"items":{},"type":"array"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Default"},"data_type":{"type":"string","title":"Data Type"},"description":{"type":"string","title":"Description"},"group":{"type":"string","title":"Group"},"client":{"type":"boolean","title":"Client","default":false},"value":{"anyOf":[{"type":"boolean"},{"type":"string"},{"type":"integer"},{"type":"number"},{"items":{},"type":"array"},{"additionalProperties":true,"type":"object"},{"type":"null"}],"title":"Value"}},"type":"object","required":["name","default","data_type","description","group"],"title":"SettingValue"},"SynopsisEntityCreate":{"properties":{"name":{"type":"string","title":"Name"},"description":{"type":"string","title":"Description"},"topic":{"type":"string","title":"Topic"},"meta":{"additionalProperties":true,"type":"object","title":"Meta"},"entities":{"items":{"type":"integer"},"type":"array","title":"Entities"}},"type":"object","required":["name","description","topic","meta","entities"],"title":"SynopsisEntityCreate"},"SystemConfigStatusResponse":{"properties":{"required":{"$ref":"#/components/schemas/RequiredConfigStatus"},"optional":{"$ref":"#/components/schemas/OptionalConfigStatus"},"need_migration":{"$ref":"#/components/schemas/NeedMigrationStatus"}},"type":"object","required":["required","optional","need_migration"],"title":"SystemConfigStatusResponse"},"TextBlock":{"properties":{"block_type":{"type":"string","const":"text","title":"Block Type","default":"text"},"text":{"type":"string","title":"Text"}},"type":"object","required":["text"],"title":"TextBlock","description":"A representation of text data to directly pass to/from the LLM."},"ThinkingBlock":{"properties":{"block_type":{"type":"string","const":"thinking","title":"Block Type","default":"thinking"},"content":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Content","description":"Content of the reasoning/thinking process, if available"},"num_tokens":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Num Tokens","description":"Number of token used for reasoning/thinking, if available"},"additional_information":{"additionalProperties":true,"type":"object","title":"Additional Information","description":"Additional information related to the thinking/reasoning process, if available"}},"type":"object","title":"ThinkingBlock","description":"A representation of the content streamed from reasoning/thinking processes by LLMs"},"ToolCallBlock":{"properties":{"block_type":{"type":"string","const":"tool_call","title":"Block Type","default":"tool_call"},"tool_call_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Tool Call Id","description":"ID of the tool call, if provided"},"tool_name":{"type":"string","title":"Tool Name","description":"Name of the called tool"},"tool_kwargs":{"anyOf":[{"additionalProperties":true,"type":"object"},{"type":"string"}],"title":"Tool Kwargs","description":"Arguments provided to the tool, if available"}},"type":"object","required":["tool_name"],"title":"ToolCallBlock"},"UpdateEvaluationDataset":{"properties":{"name":{"type":"string","title":"Name"}},"type":"object","required":["name"],"title":"UpdateEvaluationDataset"},"Upload":{"properties":{"created_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Created At"},"updated_at":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"title":"Updated At"},"id":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Id"},"name":{"type":"string","maxLength":255,"title":"Name"},"size":{"type":"integer","title":"Size","default":0},"path":{"type":"string","maxLength":255,"title":"Path"},"mime_type":{"$ref":"#/components/schemas/MimeTypes"},"user_id":{"type":"string","format":"uuid","title":"User Id"}},"type":"object","required":["name","path","mime_type","user_id"],"title":"Upload"},"UserDescriptor":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"email":{"type":"string","title":"Email"}},"type":"object","required":["id","email"],"title":"UserDescriptor"},"UserRead":{"properties":{"id":{"type":"string","format":"uuid","title":"Id"},"email":{"type":"string","format":"email","title":"Email"},"is_active":{"type":"boolean","title":"Is Active","default":true},"is_superuser":{"type":"boolean","title":"Is Superuser","default":false},"is_verified":{"type":"boolean","title":"Is Verified","default":false}},"type":"object","required":["id","email"],"title":"UserRead"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"},"VectorIndexError":{"properties":{"document_id":{"type":"integer","title":"Document Id"},"document_name":{"type":"string","title":"Document Name"},"source_uri":{"type":"string","title":"Source Uri"},"error":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Error"}},"type":"object","required":["document_id","document_name","source_uri"],"title":"VectorIndexError"},"VectorSearchOption":{"properties":{"top_k":{"type":"integer","title":"Top K","default":10},"similarity_top_k":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Similarity Top K"},"oversampling_factor":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Oversampling Factor","default":5},"reranker":{"anyOf":[{"$ref":"#/components/schemas/RerankerConfig"},{"type":"null"}]},"metadata_filter":{"anyOf":[{"$ref":"#/components/schemas/MetadataFilterConfig"},{"type":"null"}]}},"type":"object","title":"VectorSearchOption"},"VectorSearchRetrieverConfig":{"properties":{"top_k":{"type":"integer","title":"Top K","default":10},"similarity_top_k":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Similarity Top K"},"oversampling_factor":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Oversampling Factor","default":5},"reranker":{"anyOf":[{"$ref":"#/components/schemas/RerankerConfig"},{"type":"null"}]},"metadata_filter":{"anyOf":[{"$ref":"#/components/schemas/MetadataFilterConfig"},{"type":"null"}]}},"type":"object","title":"VectorSearchRetrieverConfig"},"VideoBlock":{"properties":{"block_type":{"type":"string","const":"video","title":"Block Type","default":"video"},"video":{"anyOf":[{"type":"string","format":"binary"},{"type":"null"}],"title":"Video"},"path":{"anyOf":[{"type":"string","format":"file-path"},{"type":"null"}],"title":"Path"},"url":{"anyOf":[{"type":"string","minLength":1,"format":"uri"},{"type":"string"},{"type":"null"}],"title":"Url"},"video_mimetype":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Video Mimetype"},"detail":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Detail"},"fps":{"anyOf":[{"type":"integer"},{"type":"null"}],"title":"Fps"}},"type":"object","title":"VideoBlock","description":"A representation of video data to directly pass to/from the LLM."},"login":{"properties":{"grant_type":{"anyOf":[{"type":"string","pattern":"^password$"},{"type":"null"}],"title":"Grant Type"},"username":{"type":"string","title":"Username"},"password":{"type":"string","title":"Password"},"scope":{"type":"string","title":"Scope","default":""},"client_id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Id"},"client_secret":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Client Secret"}},"type":"object","required":["username","password"],"title":"Body_auth-auth:database.login"}},"securitySchemes":{"APIKeyCookie":{"type":"apiKey","in":"cookie","name":"session"}}}}