Skip to main content
Get embedding for a chunk.

Tool details

FieldValue
Nameget_file_chunk_embedding
GroupSearch

Playground

Input schema

Input schema
{
  "type": "object",
  "properties": {
    "project_reference": {
      "type": "string",
      "description": "Project identifier or slug that scopes the tool call."
    },
    "chunk_id": {
      "type": "string",
      "format": "uuid",
      "description": "Provide the chunk id."
    },
    "dimension": {
      "type": "string",
      "enum": [
        "768",
        "1024",
        "1536",
        "3072",
        "4096"
      ],
      "description": "Embedding vector dimension to use when indexing or querying semantic search content."
    },
    "include_vector": {
      "type": "boolean",
      "description": "Provide the include vector."
    }
  },
  "required": [
    "project_reference",
    "chunk_id",
    "dimension"
  ],
  "additionalProperties": false,
  "description": "Input schema for the get_file_chunk_embedding tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}

Output schema

Output schema
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier for the returned record."
    },
    "chunk_id": {
      "type": "string",
      "description": "The chunk id associated with this tool result."
    },
    "model": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Human-readable name for the returned record."
        },
        "provider": {
          "type": "string",
          "description": "The provider associated with this tool result."
        },
        "dimension": {
          "type": "number",
          "description": "The dimension associated with this tool result."
        }
      },
      "required": [
        "name",
        "provider",
        "dimension"
      ],
      "additionalProperties": false,
      "description": "Structured model details associated with this tool result."
    },
    "status": {
      "type": "string",
      "enum": [
        "ready",
        "stale",
        "missing"
      ],
      "description": "Lifecycle status for the returned record."
    },
    "vector": {
      "anyOf": [
        {
          "type": "array",
          "items": {
            "type": "number",
            "description": "One vector item associated with this tool result."
          },
          "description": "List of vector associated with this tool result."
        },
        {
          "type": "null",
          "description": "The vector returned by the tool."
        }
      ],
      "description": "The vector associated with this tool result."
    },
    "created_at": {
      "type": "string",
      "description": "Creation timestamp in ISO 8601 format."
    }
  },
  "required": [
    "id",
    "chunk_id",
    "model",
    "status",
    "vector",
    "created_at"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_file_chunk_embedding tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}