NAME

OpenAPI::Client::OpenAI::Path::embeddings - Documentation for the /embeddings path.

DESCRIPTION

This document describes the API endpoint at /embeddings.

See the examples/ directory in the distribution for examples of how to use this.

POST /embeddings

Creates an embedding vector representing the input text.

Operation ID

createEmbedding

$client->createEmbedding( ... );

Request Body

Content Type: application/json

Example:

{
   "user" : "user-1234",
   "model" : "text-embedding-3-small",
   "encoding_format" : "float",
   "input" : "The quick brown fox jumped over the lazy dog"
}

Responses

Status Code: 200

OK

Content Types:

• application/json

  Example:

  {
     "usage" : null,
     "data" : [
        {
           "embedding" : [
              null
           ]
        }
     ]
  }

SEE ALSO

OpenAPI::Client::OpenAI::Path

COPYRIGHT AND LICENSE

Copyright (C) 2023-2025 by Nelson Ferraz

This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself, either Perl version 5.14.0 or, at your option, any later version of Perl 5 you may have available.