h2oGPTeInstall

Overview

This node operation updates attributes of an existing collection in the h2oGPTe system. It allows users to modify key properties such as the collection's name, description, and RAG (Retrieval-Augmented Generation) type. This is useful for maintaining and organizing collections of documents or data groups by keeping their metadata up-to-date.

Typical use cases include:

• Renaming a collection to better reflect its contents.
• Updating the description to provide clearer context or details.
• Adjusting the RAG type to control how queries are answered using the collection (e.g., automatic selection, LLM-only responses).

Example: You have a collection grouping research papers and want to update its name and description after adding new documents or changing its focus.

Properties

Output

The output will contain the JSON response from the API representing the updated collection object. This typically includes the updated attributes such as the collection ID, name, description, rag_type, and other metadata fields returned by the server.

If the operation is successful, the output JSON confirms the changes made to the collection.

Dependencies

• Requires connection to the h2oGPTe API endpoint with a valid base URL and authentication credentials (an API key credential).
• The node uses HTTP PATCH method to send updates to the /collections/{collection_id} endpoint.
• Proper permissions and access rights to modify the specified collection are required.

Troubleshooting

• Invalid Collection ID: If the provided collection ID does not exist or is incorrect, the API will return an error indicating the collection was not found. Verify the collection ID.
• Missing Required Fields: The collection ID is mandatory; ensure it is provided.
• Permission Denied: Insufficient permissions to update the collection will result in authorization errors. Check API key permissions.
• Invalid RAG Type: Providing an unsupported rag_type value may cause validation errors. Use only supported values (auto, llm_only).
• Network Issues: Connectivity problems with the API endpoint can cause request failures. Ensure network access and correct base URL configuration.

Links and References

• h2oGPTe API Documentation
• RAG (Retrieval-Augmented Generation) Concepts

This summary is based on static analysis of the node's properties and routing configuration for the "Updates Attributes of an Existing Collection" operation under the "Collection" resource.