Create Embeddings

Computes an embedding vector that encodes the input text.

POST /api/v1/embeddings

Create Embedding

cURL

curl --request POST \
  --url https://api.intelligence.io.solutions/api/v1/embeddings \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "model": "<string>",
  "input": [
    123
  ],
  "encoding_format": "float",
  "dimensions": 123,
  "user": "<string>",
  "truncate_prompt_tokens": 2,
  "additional_data": null,
  "add_special_tokens": true,
  "priority": 0
}
'

import requests

url = "https://api.intelligence.io.solutions/api/v1/embeddings"

payload = {
    "model": "<string>",
    "input": [123],
    "encoding_format": "float",
    "dimensions": 123,
    "user": "<string>",
    "truncate_prompt_tokens": 2,
    "additional_data": None,
    "add_special_tokens": True,
    "priority": 0
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    model: '<string>',
    input: [123],
    encoding_format: 'float',
    dimensions: 123,
    user: '<string>',
    truncate_prompt_tokens: 2,
    additional_data: null,
    add_special_tokens: true,
    priority: 0
  })
};

fetch('https://api.intelligence.io.solutions/api/v1/embeddings', 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.intelligence.io.solutions/api/v1/embeddings",
  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([
    'model' => '<string>',
    'input' => [
        123
    ],
    'encoding_format' => 'float',
    'dimensions' => 123,
    'user' => '<string>',
    'truncate_prompt_tokens' => 2,
    'additional_data' => null,
    'add_special_tokens' => true,
    'priority' => 0
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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.intelligence.io.solutions/api/v1/embeddings"

	payload := strings.NewReader("{\n  \"model\": \"<string>\",\n  \"input\": [\n    123\n  ],\n  \"encoding_format\": \"float\",\n  \"dimensions\": 123,\n  \"user\": \"<string>\",\n  \"truncate_prompt_tokens\": 2,\n  \"additional_data\": null,\n  \"add_special_tokens\": true,\n  \"priority\": 0\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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.intelligence.io.solutions/api/v1/embeddings")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"model\": \"<string>\",\n  \"input\": [\n    123\n  ],\n  \"encoding_format\": \"float\",\n  \"dimensions\": 123,\n  \"user\": \"<string>\",\n  \"truncate_prompt_tokens\": 2,\n  \"additional_data\": null,\n  \"add_special_tokens\": true,\n  \"priority\": 0\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.intelligence.io.solutions/api/v1/embeddings")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"model\": \"<string>\",\n  \"input\": [\n    123\n  ],\n  \"encoding_format\": \"float\",\n  \"dimensions\": 123,\n  \"user\": \"<string>\",\n  \"truncate_prompt_tokens\": 2,\n  \"additional_data\": null,\n  \"add_special_tokens\": true,\n  \"priority\": 0\n}"

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

422

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>"
    }
  ]
}

Authorizations

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

token · string

JWT token

Authorization · string

io.net provided API Key

x-api-key · string

API key set by an SDK client

Body

application/json

EmbeddingCompletionRequest

EmbeddingChatRequest

model · string · required

input · integer[] integer[][] string string[] · required

encoding_format · enum<string> · default: float

Available options: float, base64

dimensions · integer | null

user · string | null

truncate_prompt_tokens · integer | null

Required range: x >= 1

additional_data · unknown

add_special_tokens · boolean · default: true

If true (the default), special tokens (e.g. BOS) will be added to the prompt.

priority · integer · default: 0

The priority of the request (lower means earlier handling; default: 0). Any priority other than 0 will raise an error if the served model does not use priority scheduling.

Response

200

application/json

Successful Response