admin/retrieve_old

Legacy Retrieve Documents

get/api/v1/admin/retrieve/documents

Request

  • Base URL: https://tidb.ai (the document declares no server; this is the origin it was published from)
  • URL: https://tidb.ai/api/v1/admin/retrieve/documents
  • Auth: API key in cookie session

Query parameters

questionstring required
chat_enginestring
top_kinteger nullable
similarity_top_kinteger nullable
oversampling_factorinteger nullable
refine_question_with_kgboolean nullable

Response

Successful Response

created_atstring date-time nullable
updated_atstring date-time nullable
idinteger nullable
hashstring required
namestring required
contentstring required
mime_type'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' required
source_uristring required
last_modified_atstring date-time nullable required
index_status'not_started' | 'pending' | 'running' | 'completed' | 'failed'
index_resultstring required
data_source_idinteger required
knowledge_base_idinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.