RetrievedChunkSchema

Fields

8 fields

canonical_url

string or null

chunk_text · required

string

relevance_score · required

number

requirement_id

string or null

section_heading

string or null

source_id · required

string (uuid)

source_title · required

string

vector_id · required

string

Raw schema (JSON)

{
  "properties": {
    "canonical_url": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Canonical Url"
    },
    "chunk_text": {
      "title": "Chunk Text",
      "type": "string"
    },
    "relevance_score": {
      "title": "Relevance Score",
      "type": "number"
    },
    "requirement_id": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Requirement Id"
    },
    "section_heading": {
      "anyOf": [
        {
          "type": "string"
        },
        {
          "type": "null"
        }
      ],
      "title": "Section Heading"
    },
    "source_id": {
      "format": "uuid",
      "title": "Source Id",
      "type": "string"
    },
    "source_title": {
      "title": "Source Title",
      "type": "string"
    },
    "vector_id": {
      "title": "Vector Id",
      "type": "string"
    }
  },
  "required": [
    "vector_id",
    "source_id",
    "source_title",
    "chunk_text",
    "relevance_score"
  ],
  "title": "RetrievedChunkSchema",
  "type": "object"
}

Used by endpoints

One endpoint sends or returns this schema, on its own or inside another schema.

• POST /api/v1/test-management/cases/rag-retrieve — Rag Retrieve

Used by schemas

• RagRetrieveResponse

More details

• Specification: OpenAPI JSON