class

OpenAI::CreateEmbeddingRequest

Inherits JSON::Serializable < Reference < Object

Constructors

new(input : CreateEmbeddingRequestInput = "", model : CreateEmbeddingRequestModel = "", encoding_format : CreateEmbeddingRequestEncodingFormat | Nil = nil, dimensions : Int64 | Nil = nil, user : String | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

dimensions

The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.

Source
dimensions=(dimensions : Int64 | Nil)

The number of dimensions the resulting output embeddings should have. Only supported in text-embedding-3 and later models.

Source
encoding_format

The format to return the embeddings in. Can be either float or base64.

Source
encoding_format=(encoding_format : CreateEmbeddingRequestEncodingFormat | Nil)

The format to return the embeddings in. Can be either float or base64.

Source
input

Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for all embedding models), cannot be an empty string, and any array must be 2048 dimensions or less. Example Python code for counting tokens. In addition to the per-input token limit, all embedding models enforce a maximum of 300,000 tokens summed across all inputs in a single request.

Source
input=(input : CreateEmbeddingRequestInput)

Input text to embed, encoded as a string or array of tokens. To embed multiple inputs in a single request, pass an array of strings or array of token arrays. The input must not exceed the max input tokens for the model (8192 tokens for all embedding models), cannot be an empty string, and any array must be 2048 dimensions or less. Example Python code for counting tokens. In addition to the per-input token limit, all embedding models enforce a maximum of 300,000 tokens summed across all inputs in a single request.

Source
model

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

Source
model=(model : CreateEmbeddingRequestModel)

ID of the model to use. You can use the List models API to see all of your available models, or see our Model overview for descriptions of them.

Source
user

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Source
user=(user : String | Nil)

A unique identifier representing your end-user, which can help OpenAI to monitor and detect abuse. Learn more.

Source