AiTurnRequest ai.turn-request@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-request.v1.json

ai.turn-request@1: one conversational turn. Files are Media references, never inline bytes.

Fields

FieldTypeRequiredDescriptionConstraints
messagesarray of objectyes
  • minItems 1
  • items: no other fields
messages[].roleenumyes
  • one of "user", "assistant"
messages[].contentstringyes
  • maxLength 200000
messages[].filesai.file
filesai.fileFiles attached by the person for this turn.

Examples

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

Valid: attached-file
{
  "messages": [
    {
      "role": "user",
      "content": "Summarize this",
      "files": [
        {
          "id": "med_file_01",
          "name": "notes.txt",
          "media_type": "text/plain",
          "size": 12,
          "storage": {
            "provider": "media",
            "key": "files/usr_01/med_file_01"
          },
          "access": {
            "readers": [
              "usr_01"
            ]
          },
          "read": {
            "method": "text",
            "content": "hello world"
          },
          "role": "input"
        }
      ]
    }
  ],
  "files": []
}
Rejected: missing-messages
{
  "files": []
}

Validate

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