Rivier/ Reference/ models

Embeddings for one text or a list, in the OpenAI embeddings format

post/models/v1/embeddings

Embeddings for one text or a list, in the OpenAI embeddings format. model is an embeddings route name from the model list. Say input_type: "query" for a search query; texts to be searched are the default. Where the route takes pictures, an item may be { type: "image", mime, data } with the picture in base64. The answer carries cost.usd; purpose is a short tag of your own that the day's usage is counted under.

Before you call

Credential
Authorization: Bearer $KEY
Scope
models:write
Graphql
Mutation.modelsEmbeddingCreate
Sdk
models.embedding.create
Cli
models embedding create

Request bodyapplication/json, required

  • modelstringrequired
    At most 80 characters.
  • inputstring or object or list of string or objectrequired
  • dimensionsinteger or null
  • encoding_formatstring or null
  • input_typestring or null
  • purposestring or null

Responses

  • 200application/json
    Success
    • objectlistrequired
    • datalist of objectrequired
      • objectembeddingrequired
      • indexnumberrequired
      • embeddinglist of number or stringrequired
    • modelstringrequired
    • usageobjectrequired
      • prompt_tokensnumberrequired
      • total_tokensnumberrequired
    • costobjectrequired
      • usdnumberrequired
  • 400application/json
    The request was malformed
    • errorstringrequired
    • messagestring
  • 401application/json
    No valid credential
    • errorstringrequired
    • messagestring
  • 403application/json
    The credential lacks the scope, origin or address
    • errorstringrequired
    • messagestring
  • 429application/json
    Over the key's rate limit; see Retry-After
    • errorstringrequired
    • messagestring

This page as Markdown