Opik icon

Opik

Interact with the Opik API
Join our community

Actions6

Overview

This node interacts with the Opik API to log feedback related to traces or spans within a project. It allows users to submit a feedback score with details such as the target entity type (trace or span), entity ID, score name, score value, and an optional reason. This is useful for scenarios where users want to provide quality or performance feedback on specific traces or spans in their projects, such as rating accuracy or relevance of a trace.

Use Case Examples

  1. Logging a feedback score of 0.85 for a specific trace ID in a project to indicate high accuracy.
  2. Submitting a relevance score of 7 out of 10 for a span within a project, along with a reason explaining the score.

Properties

Name Meaning
Project Name or ID Select the project or specify its ID where the feedback will be logged.
Entity Type Specifies whether the feedback is attached to a trace or a span.
Entity ID Identifier of the trace or span to which the feedback score applies.
Score Name Name of the metric being scored, e.g., accuracy or relevance.
Score Value Numeric value of the score, e.g., between 0-1 or 0-10.
Reason Optional explanation or comment for the score.
Request Options Settings for request behavior such as batching, SSL validation, proxy, and timeout.

Output

JSON

  • feedbackId - Identifier of the logged feedback entry.
  • status - Status of the feedback logging operation.
  • message - Additional information or confirmation message from the API.

Dependencies

  • Requires an API key credential for the Opik API to authenticate requests.

Troubleshooting

  • Ensure the project ID and entity ID are correct and exist in the Opik system to avoid errors related to invalid references.
  • Verify that the API key credential is valid and has sufficient permissions to log feedback.
  • If SSL certificate validation errors occur, consider enabling the 'Ignore SSL Issues' option cautiously.
  • Batching settings should be configured properly to avoid request throttling or timeouts.
  • Timeouts can occur if the server is slow to respond; increase the timeout setting if needed.

Links

Discussion