Orq Deployment icon

Orq Deployment

Invoke Orq AI deployment

Orq Deployment

AI-generated

Overview

This node invokes an Orq AI deployment using a specified deployment key. It allows users to send messages with various roles (user, assistant, system) and content types (text, image) along with context and input key-value pairs to the deployment. The node is useful for integrating Orq AI deployments into workflows, enabling dynamic interaction with AI models based on deployment routing and input variables.

Use Case Examples

  1. Sending a text message as a user role to an Orq AI deployment to get a response.
  2. Providing image data along with optional text to the deployment for processing.
  3. Using context key-value pairs to route the request to specific deployment environments or configurations.

Properties

Name Meaning
Deployment Key The identifier of the Orq AI deployment to invoke, chosen from a list or specified via expression.
Context Key-value pairs used for deployment routing, allowing dynamic selection of deployment environment or configuration.
Inputs Key-value pairs representing input variables used in deployment messages, allowing dynamic content substitution.
Messages A collection of messages to send to the deployment, each with a role (user, assistant, system), content type (text or image), and associated content such as text or image data.

Output

JSON

  • id - Unique identifier of the deployment invocation response.
  • created - Timestamp when the response was created.
  • object - Type of the returned object.
  • model - Model used in the deployment.
  • provider - Provider of the deployment service.
  • isFinal - Indicates if the response is final.
  • integrationId - Integration identifier related to the deployment.
  • finalized - Indicates if the deployment process is finalized.
  • systemFingerprint - Fingerprint of the system state.
  • retrievals - Additional retrieval data from the deployment.
  • providerResponse - Raw response from the provider.
  • choices - Choices or outputs generated by the deployment.

Dependencies

  • Requires an API key credential for Orq AI service authentication.

Troubleshooting

  • Ensure the deployment key is valid and correctly specified; invalid keys will cause validation errors.
  • Validate that messages conform to expected formats and roles; improper message structure may cause request failures.
  • Check API credentials are correctly configured and valid; invalid or missing credentials will cause authentication errors.
  • If the node fails and 'Continue On Fail' is not enabled, the workflow will stop; enabling it allows partial success handling with error details in output.

Links

Discussion