Get embedding

veryfront__get_file_chunk_embedding

Requires project.knowledge.read.

Access

No external-service connection is required. Use a Veryfront credential with access to the requested resources.

Call type: Read-only.

Arguments

FieldTypeRequiredDescription and constraints
project_referencestringNoProject identifier or slug that scopes the tool call.
chunk_idstringYesProvide the chunk id. Format: uuid.
environmentstringNoDeployment index to read. Omit all scope selectors for project-wide stored embeddings, including branch, release, historical, and legacy indexes. PREVIEW explicitly selects current main or the selected branch. Values: "PREVIEW", "PRODUCTION", "RELEASE".
branch_idstring or nullNoSelect a current preview branch. Use null to explicitly select current main; when PREVIEW is set, an omitted branch also selects main.
release_idstringNoSelect a frozen release by ID. RELEASE is inferred when environment is omitted. Format: uuid.
release_versionstringNoSelect a frozen release by version when no release ID is supplied. RELEASE is inferred when environment is omitted.
dimensionstringYesVector dimension to retrieve. Values: "768", "1024", "1536", "3072", "4096".
include_vectorbooleanNoInclude raw vector data. Defaults to true. Default: true.

Example request

Send this JSON-RPC request through an initialized MCP client. Replace sample identifiers and values before calling the tool. See MCP client setup.

json
{
  "jsonrpc": "2.0",
  "id": 1,
  "method": "tools/call",
  "params": {
    "name": "veryfront__get_file_chunk_embedding",
    "arguments": {
      "chunk_id": "00000000-0000-4000-8000-000000000000",
      "dimension": "768"
    }
  }
}

Result

The published output shape is summarized below. Inspect both the MCP response content and isError when handling a call.

FieldTypeRequiredDescription and constraints
idstringYesEmbedding ID.
chunk_idstringYesFile chunk ID associated with the embedding.
modelobjectYesEmbedding model that produced the vector. Not an agent chat model.
statusstringYesEmbedding lifecycle status. Values: "ready", "stale", "missing".
vectornumber[]NoRaw embedding vector when requested.
created_atstringYesEmbedding creation timestamp in ISO 8601 format.

Full schemas

json
{
  "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."
    },
    "environment": {
      "type": "string",
      "enum": [
        "PREVIEW",
        "PRODUCTION",
        "RELEASE"
      ],
      "description": "Deployment index to read. Omit all scope selectors for project-wide stored embeddings, including branch, release, historical, and legacy indexes. PREVIEW explicitly selects current main or the selected branch."
    },
    "branch_id": {
      "anyOf": [
        {
          "type": "string",
          "format": "uuid",
          "description": "Branch identifier. Use null for the main branch when the tool supports it."
        },
        {
          "type": "null",
          "description": "Branch identifier. Use null for the main branch when the tool supports it."
        }
      ],
      "description": "Select a current preview branch. Use null to explicitly select current main; when PREVIEW is set, an omitted branch also selects main."
    },
    "release_id": {
      "type": "string",
      "format": "uuid",
      "description": "Select a frozen release by ID. RELEASE is inferred when environment is omitted."
    },
    "release_version": {
      "type": "string",
      "description": "Select a frozen release by version when no release ID is supplied. RELEASE is inferred when environment is omitted."
    },
    "dimension": {
      "type": "string",
      "enum": [
        "768",
        "1024",
        "1536",
        "3072",
        "4096"
      ],
      "description": "Vector dimension to retrieve."
    },
    "include_vector": {
      "type": "boolean",
      "description": "Include raw vector data. Defaults to true.",
      "default": true
    }
  },
  "required": [
    "chunk_id",
    "dimension"
  ],
  "additionalProperties": false,
  "description": "Arguments for the get_file_chunk_embedding tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}
json
{
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Embedding ID."
    },
    "chunk_id": {
      "type": "string",
      "description": "File chunk ID associated with the embedding."
    },
    "model": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string",
          "description": "Embedding model name."
        },
        "provider": {
          "type": "string",
          "description": "Embedding provider name."
        },
        "dimension": {
          "type": "number",
          "description": "Embedding vector dimension."
        }
      },
      "required": [
        "name",
        "provider",
        "dimension"
      ],
      "additionalProperties": false,
      "description": "Embedding model that produced the vector. Not an agent chat model."
    },
    "status": {
      "type": "string",
      "enum": [
        "ready",
        "stale",
        "missing"
      ],
      "description": "Embedding lifecycle status."
    },
    "vector": {
      "type": "array",
      "items": {
        "type": "number"
      },
      "description": "Raw embedding vector when requested."
    },
    "created_at": {
      "type": "string",
      "description": "Embedding creation timestamp in ISO 8601 format."
    }
  },
  "required": [
    "id",
    "chunk_id",
    "model",
    "status",
    "created_at"
  ],
  "additionalProperties": false,
  "description": "Structured result returned by the get_file_chunk_embedding tool.",
  "$schema": "http://json-schema.org/draft-07/schema#"
}