Retrieve embeddings

Retrieve a set of embeddings using IDs.

POST /api/v1/embeddings/{indexName}/retrieve

Retrieve embeddings

cURL

curl --request POST \
  --url https://api.example.com/api/v1/embeddings/{indexName}/retrieve \
  --header 'Content-Type: application/json' \
  --header 'X-Eigen-API-Key: <api-key>' \
  --data '
{
  "ids": [
    123
  ]
}
'

import requests

url = "https://api.example.com/api/v1/embeddings/{indexName}/retrieve"

payload = { "ids": [123] }
headers = {
    "X-Eigen-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'X-Eigen-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({ids: [123]})
};

fetch('https://api.example.com/api/v1/embeddings/{indexName}/retrieve', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.example.com/api/v1/embeddings/{indexName}/retrieve",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'ids' => [
        123
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "X-Eigen-API-Key: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.example.com/api/v1/embeddings/{indexName}/retrieve"

	payload := strings.NewReader("{\n  \"ids\": [\n    123\n  ]\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("X-Eigen-API-Key", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.example.com/api/v1/embeddings/{indexName}/retrieve")
  .header("X-Eigen-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"ids\": [\n    123\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.example.com/api/v1/embeddings/{indexName}/retrieve")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["X-Eigen-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"ids\": [\n    123\n  ]\n}"

response = http.request(request)
puts response.read_body

200

{
  "status": 200,
  "message": "2/2 embeddings successfully retrieved.",
  "data": {
    "embeddings": [
      {
        "data": [
          0.1,
          -0.2,
          0.45
        ],
        "id": 23,
        "metadata": {
          "foo": "bar"
        }
      },
      {
        "data": [
          0.2,
          -0.7,
          0.32
        ],
        "id": 67,
        "metadata": {}
      }
    ]
  }
}

{
  "status": 500,
  "message": "1/2 embeddings successfully retrieved.",
  "data": {
    "embeddings": [
      {
        "data": [
          0.1,
          -0.2,
          0.45
        ],
        "id": 23,
        "metadata": {
          "foo": "bar"
        }
      }
    ]
  },
  "error": {
    "code": "EMBEDDINGS_SKIPPED",
    "description": [
      "embedding with ID 87 was not retrieved - embedding with ID 87 does not exist"
    ]
  }
}

Authorizations

X-Eigen-API-Key · string · header · required

Path Parameters

indexName · string · required

Name of the index

Body

application/json

ids · number<integer>[] · required

IDs of embedding to retrieve

Response

200

application/json

Embeddings successfully retrieved.

status · integer · required

Status code of the response

message · string · required

Message giving basic information on the response

data · object

Important data to be given to the caller

error · object

An error that has occured

Show child attributes