H2h2o
Collections

Creates job to insert document to the collection.

Creates job to insert document to the collection.

post/collections/{collection_id}/documents/insert_job

Request

Path parameters

collection_idstring required

Id of the collection where the document will be inserted into.

Query parameters

copy_documentboolean

Whether to save a new copy of the document

preserve_metadataboolean

Whether to preserve document metadata when copying documents.

gen_doc_summariesboolean

Whether to auto-generate document summaries (uses LLM).

gen_doc_questionsboolean

Whether to auto-generate sample questions for each document (uses LLM).

ocr_modelstring

Which method to use to extract text from images using AI-enabled optical character recognition (OCR) models. docTR is best for Latin text, PaddleOCR is best for certain non-Latin languages, Tesseract covers a wide range of languages. Mississippi works well on handwriting. - auto - Automatic will auto-select the best OCR model for every page. - off - Disable OCR for speed, but all images will then be skipped (also no image captions will be made).

tesseract_langstring

Which language to use when using ocr_model="tesseract".

keep_tables_as_one_chunkboolean

When tables are identified by the table parser the table tokens will be kept in a single chunk.

chunk_by_pageboolean

Each page will be a chunk. keep_tables_as_one_chunk will be ignored if this is true.

handwriting_checkboolean

Check pages for handwriting. Will use specialized models if handwriting is found.

ingest_mode'standard' | 'agent_only'

Ingest mode to use. - standard - Files will be ingested for use with RAG - agent_only - Bypasses standard ingestion. Files can only be used with agents.

timeoutnumber double

Timeout in seconds

Request body

document_idstring required

Id of the document to be inserted.

Response

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

Changes

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