Upsert embeddings

Upserts a set of embeddings into the database (insert and update embedding if it already exists).

PUT /api/v1/embeddings/{indexName}/upsert

Upsert embeddings

cURL

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

import requests

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

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

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

print(response.text)

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

fetch('https://api.example.com/api/v1/embeddings/{indexName}/upsert', 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}/upsert",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS => json_encode([
    'embeddings' => [
        [
                'data' => [
                                123
                ],
                'id' => 123,
                'metadata' => [
                                
                ]
        ]
    ]
  ]),
  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}/upsert"

	payload := strings.NewReader("{\n  \"embeddings\": [\n    {\n      \"data\": [\n        123\n      ],\n      \"id\": 123,\n      \"metadata\": {}\n    }\n  ]\n}")

	req, _ := http.NewRequest("PUT", 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.put("https://api.example.com/api/v1/embeddings/{indexName}/upsert")
  .header("X-Eigen-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"embeddings\": [\n    {\n      \"data\": [\n        123\n      ],\n      \"id\": 123,\n      \"metadata\": {}\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

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

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

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

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

200

{
  "status": 200,
  "message": "50/50 embeddings successfully upserted."
}

{
  "status": 500,
  "message": "49/50 embeddings successfully upserted.",
  "error": {
    "code": "EMBEDDINGS_SKIPPED",
    "description": "detailed description of the error..."
  }
}

Authorizations

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

Path Parameters

indexName · string · required

Name of the index

Body

application/json

embeddings · object[] · required

Embeddings to be upserted.

Show child attributes

Response

200

application/json

Embedding successfully upserted.

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