EmbeddingSimilaritySearchResponse

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/telnyx/main/json-schema/telnyx-embedding-similarity-search-response-schema.json",
  "title": "EmbeddingSimilaritySearchResponse",
  "x-generated": "2026-10-08",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-embeddings-api-openapi.yml#/components/schemas/EmbeddingSimilaritySearchResponse",
  "properties": {
    "data": {
      "items": {
        "$ref": "#/$defs/EmbeddingSimilaritySearchDocument"
      },
      "title": "Data",
      "type": "array"
    }
  },
  "required": [
    "data"
  ],
  "type": "object",
  "$defs": {
    "EmbeddingMetadata": {
      "properties": {
        "certainty": {
          "title": "Certainty",
          "type": "number"
        },
        "checksum": {
          "title": "Checksum",
          "type": "string"
        },
        "embedding": {
          "title": "Embedding",
          "type": "string"
        },
        "filename": {
          "title": "Filename",
          "type": "string"
        },
        "loader_metadata": {
          "additionalProperties": true,
          "title": "Loader Metadata",
          "type": "object"
        },
        "source": {
          "title": "Source",
          "type": "string"
        }
      },
      "required": [
        "source",
        "checksum",
        "embedding",
        "filename"
      ],
      "title": "EmbeddingMetadata",
      "type": "object"
    },
    "EmbeddingSimilaritySearchDocument": {
      "description": "Example document response from embedding service\n{\n  \"document_chunk\": \"your status? This is Vanessa Bloome...\",\n  \"distance\": 0.18607724,\n  \"metadata\": {\n    \"source\": \"https://us-central-1.telnyxstorage.com/scripts/bee_movie_script.txt\",\n    \"checksum\": \"343054dd19bab39bbf6761a3d20f1daa\",\n    \"embedding\": \"openai/text-embedding-ada-002\",\n    \"filename\": \"bee_movie_script.txt\",\n    \"certainty\": 0.9069613814353943,\n    \"loader_metadata\": {}\n  }\n}",
      "properties": {
        "distance": {
          "title": "Distance",
          "type": "number"
        },
        "document_chunk": {
          "title": "Document Chunk",
          "type": "string"
        },
        "metadata": {
          "$ref": "#/$defs/EmbeddingMetadata"
        }
      },
      "required": [
        "document_chunk",
        "distance",
        "metadata"
      ],
      "title": "EmbeddingSimilaritySearchDocument",
      "type": "object"
    }
  }
}