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
This node operation updates attributes of an existing prompt template in the system. Prompt templates are reusable configurations that define how AI models generate responses based on various prompts and settings. Updating a prompt template allows users to modify its descriptive text, language, query prompts, summaries, reflection templates, and other advanced options related to document processing and AI model behavior.
Typical use cases include:
- Refining or correcting the wording of prompts used for generating AI responses.
- Adjusting language or localization settings.
- Customizing prompts for document summarization or question generation.
- Modifying system or self-reflection prompts to improve AI output quality.
For example, a user might update the "description" and "name" of a prompt template to better reflect its purpose or change the "pre_prompt_query" to prepend specific context before user queries.
Properties
| Name | Meaning |
|---|---|
| Prompt Template ID | The unique identifier of the prompt template to update (required). |
| Auto Gen Description Prompt | A prompt used to automatically create a description of the collection. |
| Auto Gen Document Sample Questions Prompt | A prompt to generate sample questions for a newly imported document if enabled. |
| Auto Gen Document Summary Pre Prompt Summary | A pre-prompt summary text for freshly imported documents if enabled. |
| Auto Gen Document Summary Prompt Summary | A prompt summary for freshly imported documents if enabled. |
| Default Sample Questions | Default sample questions used when no auto-generated questions are available. |
| Description | A textual description of the prompt template. |
| Hyde No Rag Llm Prompt Extension | An extension prompt for LLMs without retrieval-augmented generation (RAG). |
| Image Batch Final Prompt | A prompt applied to each image batch for vision models. |
| Image Batch Image Prompt | A prompt for each image batch for vision models. |
| Lang | Language code specifying the language of the prompt template. |
| Name | The name of the prompt template. |
| Pre Prompt Query | Text prepended before contextual document chunks in queries. |
| Pre Prompt Summary | A prompt placed before large text blocks to summarize them. |
| Prompt Query | Text appended at the beginning of the user's message. |
| Prompt Reflection | A self-reflection template requiring two placeholders for previous prompts. |
| Prompt Summary | A prompt placed after large text blocks to summarize them. |
| System Prompt | A system-level prompt providing overall context to the AI model. |
| System Prompt Reflection | A system prompt used for self-reflection by the AI model. |
Output
The node outputs the response from the API call that updates the prompt template. This typically includes the updated prompt template object with all its attributes reflecting the changes made. The output is structured as JSON data containing the updated fields of the prompt template.
If the API supports it, the output may also include metadata such as timestamps, IDs, and status messages confirming the update.
No binary data output is expected from this operation.
Dependencies
- Requires an API key credential for authentication with the external service managing prompt templates.
- The base URL for API requests is configured via credentials and environment variables.
- The node sends HTTP PATCH requests to the endpoint
/prompt_templates/{prompt_template_id}with JSON body containing updated attributes.
Troubleshooting
- Missing or invalid Prompt Template ID: The operation requires a valid prompt template ID. Ensure the ID is correct and exists in the system.
- Invalid property values: Some properties have constraints (e.g., prompt reflection must contain two
%splaceholders). Validate inputs accordingly. - Authentication errors: Verify that the API key credential is correctly configured and has permissions to update prompt templates.
- Network or timeout issues: Check connectivity to the API endpoint and adjust timeout settings if necessary.
- API validation errors: The API may reject updates if required fields are missing or if the payload format is incorrect. Review error messages returned by the API for guidance.
Links and References
- Refer to the external API documentation for prompt templates for detailed information on each attribute and update semantics.
- Consult the platform's authentication guide for setting up API key credentials.
- For best practices on prompt engineering, see relevant AI model provider resources.