Literal AI icon

Literal AI

Use the Literal AI API

Actions41

Overview

This node integrates with the Literal AI API to update an existing score entity. It allows users to modify the value and comment of a specific score identified by its unique ID. This operation is useful in scenarios where scores related to steps or evaluations need to be adjusted after initial creation, such as updating performance metrics, feedback scores, or evaluation results.

Practical examples include:

  • Adjusting a machine learning model's evaluation score after re-assessment.
  • Updating user feedback scores on generated content.
  • Modifying quality scores associated with specific processing steps in a workflow.

Properties

Name Meaning
Score ID The unique identifier of the score to update.
Value The new numeric value to assign to the score.
Comment An optional textual comment providing context or notes about the updated score.

Output

The node outputs a JSON object under the content field containing the updated score data returned from the Literal AI API. This typically includes the updated fields of the score such as its ID, value, comment, and any other metadata the API provides.

No binary data output is produced by this operation.

Example output structure (simplified):

{
  "content": {
    "id": "score-id",
    "value": 42,
    "comment": "Updated comment",
    // ... other score properties
  }
}

Dependencies

  • Requires an API key credential for the Literal AI service to authenticate requests.
  • The node depends on the @literalai/client library to interact with the Literal AI API.
  • Proper configuration of the API key credential within n8n is necessary before use.

Troubleshooting

  • Common issues:

    • Invalid or missing Score ID will cause the API call to fail.
    • Providing non-numeric values for the "Value" property may result in validation errors.
    • Network or authentication failures if the API key is incorrect or expired.

  • Error messages:

    • "Score not found": Indicates the provided Score ID does not exist; verify the ID.
    • "Unauthorized" or "Invalid API key": Check that the API key credential is correctly configured.
    • "Validation error": Ensure all required fields are provided and correctly formatted.

To resolve these issues, verify input parameters, ensure the API key is valid, and check network connectivity.

Links and References

Discussion