h2oGPTe
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
This node operation allows you to add files from Google Cloud Storage (GCS) into a specified document collection. It is designed for ingesting documents stored in GCS buckets or directories directly into a collection for further processing, indexing, or querying within the system.
Common scenarios where this node is beneficial include:
- Automating the ingestion of large volumes of documents stored in GCS into a knowledge base or document management system.
- Integrating cloud storage with AI-powered search or analysis workflows.
- Periodically syncing or updating collections with new or updated files from GCS.
Practical example:
- A company stores scanned contracts and reports in GCS. Using this node, they can automatically ingest these files into a collection that powers an internal search assistant, enabling employees to query contract details efficiently.
Properties
| Name | Meaning |
|---|---|
| Collection ID | String ID of the collection to add the ingested documents into. This identifies the target collection where files will be added. |
| URLs | The path or list of paths of GCS files or directories to ingest. Supports specifying multiple files or folders in GCS. |
| Additional Options | A set of optional parameters to customize the ingestion process: |
| - Audio Input Language | Language of 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. |
| - Credentials | JSON object holding the Google Cloud service account key. If omitted, only public buckets are accessible. |
| - 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 document summaries using LLM. |
| - Handwriting Check | Boolean flag to check pages for handwriting and use specialized models if handwriting is detected. |
| - Ingest Mode | Mode of ingestion: "standard" (files ingested for retrieval-augmented generation) or "agent_only" (bypasses standard ingestion, used for agent-specific workflows). |
| - 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 ingested documents. |
| - Ocr Model | Method to extract text from images using AI-enabled OCR models. Default is "auto". |
| - Tesseract Lang | Language code to use when OCR model is set to "tesseract". |
| - Timeout | Timeout in seconds for the ingestion request. Default is 0 (no timeout). |
Output
The node outputs a JSON response representing the result of the ingestion request. This typically includes information about the ingestion job status, any errors encountered, and metadata about the ingested documents or collection update.
If the ingestion involves binary data (e.g., files), the node handles it internally but does not output raw binary data directly. Instead, it provides references or statuses related to the ingestion process.
Dependencies
- Requires access to Google Cloud Storage, optionally authenticated via a Google Cloud service account JSON key provided in the credentials property.
- The node communicates with an external API endpoint
/ingest/gcsto perform the ingestion. - Proper permissions on the GCS bucket and the target collection are necessary.
- Network connectivity to the API and GCS endpoints is required.
- No additional environment variables are explicitly required beyond the credentials passed.
Troubleshooting
- Authentication Errors: If the credentials JSON is missing or invalid, the node may fail to access private GCS buckets. Ensure the service account key is correct and has appropriate permissions.
- Timeouts: Large file sets or slow network connections may cause timeouts. Adjust the
timeoutproperty accordingly. - Invalid Paths: Incorrect or inaccessible GCS paths in the
URLsproperty will cause ingestion failures. Verify the paths exist and are accessible. - Permission Denied: Lack of permission on the target collection or GCS bucket will result in errors. Confirm user and service account permissions.
- Unsupported File Types: Some file types may not be supported by the ingestion backend. Check documentation for supported formats.
- Handwriting Check Issues: Enabling handwriting check may increase processing time or require specific models; disable if unnecessary.
Links and References
- Google Cloud Storage Documentation
- Google Cloud Service Account Keys
- Optical Character Recognition (OCR) Models
- Retrieval-Augmented Generation (RAG) Concepts
This summary is based solely on static analysis of the provided source code and property definitions without runtime execution.