Collections

Creates job to remove documents from the collection.

post/collections/{collection_id}/documents/delete_job

Request

Base URL
https://h2ogpte.genai.h2o.ai/api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/h2o/apis/h2ogpte-rest-api/docs/collections/:collection_id/documents/delete_job/post.ts
A function with typed inputs. Its response is checked against the schema.

collection_idstring required

Id of the collection to remove the document from.

document_idsstring[] required

Ids of documents to be deleted.

Successful operation

idstring required

namestring required

overall_status'in progress' | 'completed' | 'failed' | 'canceled' required

statusstring

passed_percentagenumber double required

failed_percentagenumber double required

progressnumber double required

created_atstring date-time required

updated_atstring date-time required

kindstring required

errorsstring[] required

durationstring required

duration_secondsnumber double required

canceled_bystring

cancel_reasonstring

timeoutnumber double

start_timenumber double

files_totalinteger

files_failedinteger

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