AiTurnResult ai.turn-result@1

Generated at from openvibe-contracts v0.419.0 and openvibe-sdk v0.161.0.

Version
1.0.0
Owner
ai
Visibility
first-party
Status
active
Compatibility
backward
Schema
https://openvibe.network/contracts/ai/turn-result.v1.json

ai.turn-result@1: conversational response and any model-produced files, stored by Media.

Fields

FieldTypeRequiredDescriptionConstraints
contentstringyes
artifactsai.fileyes

Examples

From the contract's own test fixtures: valid ones validate, rejected ones must fail.

Valid: with-artifact
{
  "content": "Here is the file.",
  "artifacts": [
    {
      "id": "med_file_02",
      "name": "answer.csv",
      "media_type": "text/csv",
      "size": 8,
      "storage": {
        "provider": "media",
        "key": "files/usr_01/med_file_02"
      },
      "access": {
        "readers": [
          "usr_01"
        ]
      },
      "read": {
        "method": "text",
        "content": "a,b\n1,2\n"
      },
      "role": "artifact"
    }
  ]
}
Rejected: no-artifacts
{
  "content": "Done"
}

Validate

const contracts = require('openvibe-contracts');
contracts.validate('ai.turn-result@1', value);   // { valid, errors: [{ path, message }] }