Skip to main content

๐Ÿ”ข Embed

Use the Represent endpoint to obtain a vector representation of a string (see embeddings).

Available at https://api.lighton.ai/muse/v1/represent.

๐Ÿ’ธ๏ธ Pricing

Pricing for the Understand endpoints is not final, values returned by cost and total_cost are placeholders.


Example#

Request
curl -X 'POST' \  'https://api.lighton.ai/muse/v1/represent' \  -H 'Content-Type: application/json' \  -H 'Accept: application/json' \  -H 'X-API-KEY: YOUR_API_KEY' \  -H 'X-Model: orion-fr' \  -d '{"text": "Il รฉtait une fois en Laponie"}'
Response (JSON)
{   {   "request_id":"22360153-dd3c-49c1-8794-0deb84794175",   "outputs":[      [         {            "execution_metadata":{               "cost":1            },            "txt":"Il รฉtait une fois en Laponie",            "embedding":[               -1.8401802778244019,               0.03995080664753914,               ...               0.7565141916275024,               0.3985326290130615            ]         }      ]   ],   "total_cost":1}

Parameters#

text string/array[string] โš ๏ธ required#

The input(s) that will be represented.

Response (outputs)#

An array of outputs shaped like your batch.

txt string#

The text that was represented, from the provided text parameter.

embedding array[float]#

Vector representation of the provided text. The size of the representation depends on the model used, see models for details.