Chunk

A Chunk is a subset of a Message. Annotations at the Chunk level directly apply to that part of the Message. For example, a single sentence in a paragraph could be a Chunk with its own Annotations.

type

string

required

The type of chunked data.

annotations

object[]

required

Annotations for a chunk of the message.

Represents a generic annotation.

annotations.id

string

required

Unique identifier for the annotation.

Example:

"an_abc123efg456"

annotations.key

string

required

Key for the annotation.

Example:

"formatting"

annotations.type

string

required

The type of the value and the possible_values, if they exist.

annotations.title

string

Title of the annotation.

Example:

"Response Formatting"

annotations.description

string

Further details about the question.

Example:

"Does the response contain issues with formatting?"

annotations.labels

string[]

String representation of the possible options.

A string representation of the annotation.

Example:

["Major Issues", "Minor Issues", "No Issues"]

annotations.metadata

object

annotations.value

integer

Integer type annotation value.

Example:

3

annotations.possible_values

integer[]

The possible values for this annotation.

Integer type annotation value.

text

string

required

A plain text field.

Message Annotation

{
  "type": "<string>",
  "annotations": [
    {
      "id": "an_abc123efg456",
      "key": "formatting",
      "type": "<string>",
      "title": "Response Formatting",
      "description": "Does the response contain issues with formatting?",
      "labels": [
        "Major Issues",
        "Minor Issues",
        "No Issues"
      ],
      "metadata": {
        "criteria": "overall_quality"
      },
      "value": 3,
      "possible_values": [
        [
          1,
          2,
          3
        ]
      ]
    }
  ],
  "text": "<string>"
}

Get Started

API Reference

Project Archetypes

Endpoints