Overview
This node enables users to interact with a chat model provided by the UnderstandTech API. It sends a prompt message to a specified model and retrieves the model's chat responses. This is useful for scenarios such as generating AI-driven conversational replies, automating customer support interactions, or integrating intelligent chat capabilities into workflows.
Practical examples include:
- Sending user queries to an AI model and receiving contextual answers.
- Automating chat-based data collection or decision-making processes.
- Integrating multilingual chatbots by selecting language preferences.
Properties
Name | Meaning |
---|---|
Base URL | The base URL of the UnderstandTech API. Must be a valid URL starting with http:// or https://. |
Model Name | The name of the chat model to interact with. |
Prompt | The message or prompt text sent to the model for generating a response. |
Secret | An optional secret string used for the chat session (e.g., session token or password). |
Language Preference | The language header (Accept-Language ) to specify the preferred language for the response. Options: En-US , Fr-FR . |
History Period | The timeframe of chat history to include in the request. Options: Today , Yesterday , Last Week , Last 30 Days . |
Output
The node outputs a JSON object containing the full response from the UnderstandTech API under the json
field. The key part of the response is expected to be an array named reponses
(note the spelling), which holds the chat messages returned by the model.
Example output structure:
{
"reponses": [
{
"message": "Response text from the model",
...
},
...
],
...
}
No binary data output is produced by this node.
Dependencies
- Requires an API key credential for authenticating requests to the UnderstandTech API.
- The node makes HTTP POST requests to the
/api/v1/chat
endpoint of the specified base URL. - The
Accept-Language
header is set based on the selected language preference. - The node expects the base URL to be a valid HTTP or HTTPS URL.
Troubleshooting
- Missing API Key: If the API key credential is not provided or invalid, the node will throw an error stating that the API key is required. Ensure you have configured the API key credential properly.
- Invalid Base URL: If the base URL is not a valid URL starting with
http://
orhttps://
, the node will throw an error indicating the base URL must be valid. Double-check the URL format. - Unexpected Response Structure: If the API response does not contain the expected
reponses
array, the node throws an error about unexpected response structure. This could indicate an API change or an error response from the server. Verify the API status and your request parameters. - Network Issues: Connectivity problems or incorrect base URLs can cause HTTP request failures. Confirm network access and correct endpoint configuration.