h2oGPTe
h2oGPTe is an AI-powered search assistant for your internal teams to answer questions gleaned from large volumes of documents, websites and workplace content.
Actions198
- Agent Actions
- API Key Actions
- Chat Actions
- Asks Question in a Given Chat Session. If Stream Is Enabled, the Server Sends Stream of Delta Messages. The Stream Is te...
- Changes the Vote Value of a Chat Message
- Creates Chat Session
- Creates Job to Delete Chat Sessions
- Deletes Agent Server Directories
- Deletes Agent Server Files
- Deletes Collection
- Deletes Specific Chat Messages
- Fetches Chat Message and Metadata for Messages in a Chat Session
- Fetches Chat Message Meta Information
- Fetches Metadata for References of a Chat Message
- Finds a Chat Session by ID
- Gets Stats of a Agent Server Directory
- List Chat Sessions
- List Suggested Questions for a Given Chat Session
- Lists Agent Server Files
- Lists Stats of Agent Server Directories
- Lists User's Questions and Answers that Have a Feedback
- Removes a Collection Reference From the Chat Session
- Removes a Prompt Template Reference From the Chat Session
- Update Feedback for a Specific Answer to a Question
- Updates a Collection Reference of a Chat Session
- Updates a Prompt Template Reference of a Chat Session
- Updates the Name of a Chat Session
- Collection Actions
- Archives a Collection Along with Its Associated Data
- Counts a Number of Chat Sessions with the Collection
- Counts a Number of Documents in the Collection
- Create a Collection
- Creates a Job to Delete Collection Thumbnail
- Creates a Job to Delete Collections
- Creates a Job to Update Collection Thumbnail
- Creates Job to Import Collection to the Collection
- Creates Job to Insert Document to the Collection
- Creates Job to Remove Documents From the Collection
- Deletes Collection
- Deletes Collection Thumbnail
- Fetches All Users' Collection Metadata Sorted by Last Update Time by Default
- Fetches Collection Chat Settings
- Fetches Collection Metadata
- Fetches Collection Settings
- Finds Chunks Related to a Message Using Lexical Search
- Finds Chunks Related to a Message Using Semantic Search
- Get a Collection
- Import an Already Stored Document to an Existing Collection
- List a Collection's Documents
- List Chat Sessions for a Given Collection
- List Collections
- List Suggested Questions for a Given Collection
- Removes a Prompt Template Reference From the Collection
- Removes a Size Limit for a Collection
- Removes an Expiry Date From a Collection
- Removes an Inactivity Interval From the Collection
- Removes Sharing of a Collection to a User
- Removes Sharing of a Collection to All Other Users Except the Original Owner
- Removes the Document From the Collection
- Updates Collection Settings
- Resets the Prompt Settings for a Given Collection
- Restores an Archived Collection to an Active Status
- Returns a List of Access Permissions for a Given Collection
- Returns a List of Group Access Permissions for a Given Collection
- Returns Specific Chunks in a Collection
- Sets a Maximum Limit on the Total Size of Documents (Sum) Added to a Collection
- Shares a Collection to a Group
- Shares a Collection to a User
- Updates a Flag Specifying Whether a Collection Is Private or Public
- Updates a Prompt Template Reference of a Collection
- Updates an Expiry Date of a Collection
- Updates an Inactivity Interval of a Collection
- Updates Attributes of an Existing Collection
- Updates Collection Chat Settings
- Updates Collection Metadata
- Updates Collection Thumbnail
- Configuration Actions
- Deletes Global Configuration Items
- Deletes Role Configuration Items
- Deletes User Configuration Items
- Gets Configurations for a Given Role
- Gets Global Configurations
- Gets User Configurations
- Resets User Configuration Item
- Sets Configuration Item for a Given Role
- Sets Global Configuration Item
- Sets User Configuration Item
- Document Actions
- Assigns a Tag to the Document
- Counts a Number of Chat Sessions with the Document
- Counts a Number of Documents
- Creates Job to Delete Documents
- Creates Job to Process Document
- Deletes a Document
- Deletes Document Summaries
- Fetches Document Guardrails Settings
- Fetches Document Internal Metadata
- Fetches Document Metadata
- Fetches Document Page Layout
- Fetches Document Page Ocr Model
- Fetches Document Summary
- Fetches Document User Source File
- Fetches Recent Document Summaries/extractions/transformations
- Finds a Document by ID
- List Chat Sessions for a Given Document
- List Documents
- Lists Collections for Containing a Given Document
- Removes a Tag From a Document
- Returns All Chunks for a Specific Document
- Updates Attributes of an Existing Document
- Updates Document Metadata
- Document Ingestion Actions
- Adds Files From the AWS S3 Storage Into a Collection
- Adds Files From the Azure Blob Storage Into a Collection
- Adds Files From the Google Cloud Storage Into a Collection
- Adds Files From the Local System Into a Collection
- Adds Plain Text to a Collection
- Converts Files Uploaded in "Agent_only" Ingest Mode to PDF and Parses Them
- Crawls and Ingest a URL Into a Collection
- Creates a Job to Add Files From the AWS S3 Storage Into a Collection
- Creates a Job to Add Files From the Azure Blob Storage Into a Collection
- Creates a Job to Add Files From the Google Cloud Storage Into a Collection
- Creates a Job to Add Files From the Local System Into a Collection
- Creates a Job to Add Plain Text to a Collection
- Creates a Job to Crawl and Ingest a URL Into a Collection
- Creates a Job to Ingest Uploaded Document
- Creates a Job to Parse Files Uploaded in "Agent_only" Ingest Mode
- Ingest Uploaded Document
- Uploads File to H2OGPTe Instance
- Job Actions
- Model Actions
- Creates a Topic Model on the Collection
- Creates Job for Creation of a Topic Model
- Encode Texts for Semantic Searching
- Extract Information From One or More Contexts Using an LLM
- Helper to Get Reasonable (Easy to Use) Defaults for Guardrails/PII Settings
- Returns Performance Statistics Grouped by Models
- Returns Usage Statistics for All Models
- Returns Usage Statistics Grouped by Models
- Returns Usage Statistics Grouped by Models and Users
- Returns Usage Statistics Grouped by Users
- Runs a Self-Test for a Given Model
- Send a Message and Get a Response From an LLM
- Summarize One or More Contexts Using an LLM
- Permission Actions
- Deletes Roles for Given Unique Identifiers
- Assigns Permission to a Given Role
- Assigns Roles to a Given Group
- Assigns Roles to a Given User
- Associates a User with a Document They Have Permission On
- Checks if Collection Permission Is Granted for a Given User
- Checks if Permission Is Granted for a Given User
- Creates a Role
- Creates a User Group
- Deletes Groups for Given Group Names
- Deletes Groups for Given Unique Identifiers
- Deletes Roles for Given Role Names
- Finds Role for a Given Unique Identifier
- Finds Roles Associated with a Given Group
- Finds Roles Associated with a Given User
- Finds User for a Given Unique Identifier
- Lists Permissions of a Given Group
- Lists Permissions of a Given Role
- Lists Permissions of a Given User
- Removes Permission From a Given Role
- Removes Roles From a Given Group
- Removes Roles From a Given User
- Resets Group Roles
- Resets User Roles
- Returns a List of All Registered Users for the System
- Returns System Permissions
- Sets a New Set of Permissions for a Given Role
- Sets Priority for a Given Role
- Prompt Template Actions
- Creates a New Prompt Template
- Deletes a Prompt Template
- Finds a Prompt Template by ID
- List Prompt Templates
- Lists Prompt Templates, Including Hidden Default Templates
- Removes Access to a Prompt Template for a Group
- Removes Sharing of a Prompt Template to a User
- Removes Sharing of a Prompt Template to All Other Users Except the Original Owner
- Resets and Shares a Prompt Template to a New List of Groups
- Resets and Shares a Prompt Template to a New List of Users
- Returns a List of Access Permissions for a Given Prompt Template
- Returns a List of Group Access Permissions for a Given Prompt Template
- Shares a Prompt Template to a User
- Shares a Prompt Template with a Group
- Updates a Flag Specifying Whether a Default Prompt Template Is Visible or Hidden to Users
- Updates Attributes of a Given Prompt Template
- Tag Actions
Overview
The "Ingest Uploaded Document" operation of the Document Ingestion resource allows users to ingest documents that have already been uploaded into a specified collection. This process involves taking one or more uploaded document IDs and adding their content into a target collection for further processing, indexing, or retrieval.
This node is beneficial in scenarios where documents are first uploaded separately (e.g., via an upload interface or API) and then need to be ingested into a system for search, analysis, or AI-powered querying. For example, after uploading PDF files or audio transcripts, you can use this operation to ingest those files into a knowledge base collection to enable semantic search or question answering.
Practical examples:
- Ingesting scanned contracts or reports into a legal document collection.
- Adding transcribed audio files into a media archive collection.
- Importing research papers into a scientific literature database.
Properties
| Name | Meaning |
|---|---|
| Upload IDs | ID(s) of the uploaded document(s) to ingest. Multiple IDs can be provided as a string. |
| Collection ID | The unique identifier of the collection where the ingested documents will be added. |
| Additional Options | A set of optional parameters to customize ingestion behavior: |
| - Audio Input Language | Language code for audio files; default is "auto" for automatic detection. |
| - Chunk By Page | Boolean flag indicating whether each page should be treated as a separate chunk. If true, keep_tables_as_one_chunk is ignored. |
| - Gen Doc Questions | Boolean flag to auto-generate sample questions for each document using a large language model (LLM). |
| - Gen Doc Summaries | Boolean flag to auto-generate summaries for each document using LLM. |
| - Handwriting Check | Boolean flag to check pages for handwriting and use specialized models if found. |
| - Ingest Mode | Mode of ingestion: "standard" (default) for regular ingestion suitable for retrieval-augmented generation (RAG), or "agent_only" which bypasses standard ingestion. |
| - Keep Tables As One Chunk | Boolean flag indicating whether tables identified by the parser should be kept as a single chunk. |
| - Metadata | JSON object containing metadata to associate with the document. |
| - Ocr Model | Method to extract text from images using AI-enabled OCR models; default is "auto". |
| - Permissions | String listing usernames who have permissions to access the document. |
| - Restricted | Boolean flag indicating if the document should be restricted to certain users only. |
| - Tesseract Lang | Language code used when OCR model is set to "tesseract". |
| - Timeout | Timeout in seconds for the ingestion request; 0 means no timeout. |
Output
The output of this operation is the full HTTP response from the ingestion API endpoint. The main data returned is typically a JSON object representing the status or result of the ingestion job, such as confirmation of successful ingestion or details about the ingested documents.
If the ingestion involves binary data (e.g., files), it is handled during upload prior to this step, so this operation focuses on triggering ingestion rather than returning binary content.
Dependencies
- Requires an API key credential for authentication with the backend service.
- The node sends a POST request to an endpoint structured as
/uploads/{upload_ids}/ingestwith query parameters and body as per the additional options. - Proper configuration of the API URL and credentials in n8n is necessary.
- The ingestion backend must support the specified ingestion modes and options.
Troubleshooting
- Invalid Upload IDs: If the provided upload IDs do not exist or are incorrect, the API may return an error. Verify that the upload IDs are correct and correspond to previously uploaded documents.
- Collection Not Found: Ensure the collection ID exists and is accessible with the provided credentials.
- Timeouts: If ingestion takes too long, consider increasing the timeout property or checking backend performance.
- Permission Errors: If the user lacks permission to add documents to the collection or access the uploaded files, errors will occur. Confirm user permissions and roles.
- Incorrect Option Values: Passing invalid values for options like
ingest_mode,ocr_model, or language codes may cause failures. Use documented valid values. - Handwriting Check Failures: Enabling handwriting check requires specialized models; if these are unavailable, ingestion might fail or fallback.
Links and References
- No direct external links are provided in the source code.
- Users should refer to the backend API documentation for detailed information on ingestion options and supported features.
- For OCR and language options, consult relevant AI model documentation or service provider guides.