Skip to main content
POST
/
ai
/
embeddings
/
similarity-search
JavaScript
import Telnyx from 'telnyx';

const client = new Telnyx({
  apiKey: 'My API Key',
});

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

console.log(response.data);
{
  "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

Successful Response

​
data
EmbeddingSimilaritySearchDocument · object[]
required