Creates a job to ingest uploaded document
Creates a job to ingest uploaded document identified to a given collection
Request
- Base URLhttps://h2ogpte.genai.h2o.ai/api/v1
- AuthHTTP bearer
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
Id of uploaded document
Query parameters
String id of the collection to add the ingested documents into.
Whether to auto-generate document summaries (uses LLM).
Whether to auto-generate sample questions for each document (uses LLM).
Language of audio files.
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).
Which language to use when using ocr_model="tesseract".
When tables are identified by the table parser the table tokens will be kept in a single chunk.
Each page will be a chunk. keep_tables_as_one_chunk will be ignored if this is true.
Check pages for handwriting. Will use specialized models if handwriting is found.
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.
Whether the document should be restricted only to certain users.
The list of usernames having permissions to the document.
Whether to encrypt the document files at rest in object storage.
Timeout in seconds
Request body
Response
Successful operation
Changes
No recorded changes to this operation across all 1 revision of this API.