Search for documents

Perform a similarity search on a Telnyx Storage Bucket, returning the most similar num_docs document chunks to the query.

Currently the only available distance metric is cosine similarity which will return a distance between 0 and 1. The lower the distance, the more similar the returned document chunks are to the query. A certainty will also be returned, which is a value between 0 and 1 where the higher the certainty, the more similar the document. You can read more about Weaviate distance metrics here: Weaviate Docs

If a bucket was embedded using a custom loader, such as intercom, the additional metadata will be returned in the loader_metadata field.

POST /ai/embeddings/similarity-search

JavaScript

JavaScript

import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: process.env['TELNYX_API_KEY'], // This is the default and can be omitted
});

const response = await client.ai.embeddings.similaritySearch({
  bucket_name: 'bucket_name',
  query: 'query',
});

console.log(response.data);

200

{
  "data": [
    {
      "document_chunk": "<string>",
      "distance": 123,
      "metadata": {
        "source": "<string>",
        "checksum": "<string>",
        "embedding": "<string>",
        "filename": "<string>",
        "certainty": 123,
        "loader_metadata": {}
      }
    }
  ]
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

bucket_name · string · required

query · string · required

num_of_docs · integer · default: 3

Response

200

application/json

Successful Response

data · EmbeddingSimilaritySearchDocument · object[] · required

Show child attributes