POST
/
v1
/
tune
curl --location --request POST 'https://api.getmetal.io/v1/tune' \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \
--data-raw '{
    "index": "index-id",
    "idA": "embedding-1",
    "idB": "embedding-2",
    "label": -1
}'

{
  "data": {
    "id": "1",
    "index": "index-id",
    "idA": "embedding-1",
    "idB": "embedding-2",
    "label": -1
  }
}

​
Auth Headers

​
x-metal-api-key
string
required

An API key for your org.

​
x-metal-client-id
string
required

A Client ID for your org.

​
Body

​
index
string
required

Index ID

​
idA
string
required

Document ID A

​
idB
string
required

Document ID B

​
label
number
required

Closeness score. Either -1, 0, or 1

​
Response

​
data
Tuning Object
curl --location --request POST 'https://api.getmetal.io/v1/tune' \
--header 'Content-Type: application/json' \
--header 'x-metal-api-key: <api-key>' \
--header 'x-metal-client-id: <client-id>' \
--data-raw '{
    "index": "index-id",
    "idA": "embedding-1",
    "idB": "embedding-2",
    "label": -1
}'

{
  "data": {
    "id": "1",
    "index": "index-id",
    "idA": "embedding-1",
    "idB": "embedding-2",
    "label": -1
  }
}