glopenai/embedding

Types

CreateEmbeddingRequest

Request to create embeddings.

pub type CreateEmbeddingRequest {
  CreateEmbeddingRequest(
    model: String,
    input: EmbeddingInput,
    encoding_format: option.Option(EncodingFormat),
    user: option.Option(String),
    dimensions: option.Option(Int),
  )
}

Constructors

CreateEmbeddingRequest(
  model: String,
  input: EmbeddingInput,
  encoding_format: option.Option(EncodingFormat),
  user: option.Option(String),
  dimensions: option.Option(Int),
)

CreateEmbeddingResponse

</>

Response from creating embeddings.

pub type CreateEmbeddingResponse {
  CreateEmbeddingResponse(
    object: String,
    model: String,
    data: List(Embedding),
    usage: EmbeddingUsage,
  )
}

Constructors

CreateEmbeddingResponse(
  object: String,
  model: String,
  data: List(Embedding),
  usage: EmbeddingUsage,
)

Embedding

</>

A single embedding vector returned by the API.

pub type Embedding {
  Embedding(index: Int, object: String, embedding: List(Float))
}

Constructors

Embedding(index: Int, object: String, embedding: List(Float))

EmbeddingInput

</>

Input for embedding requests. Mirrors the Rust EmbeddingInput untagged enum.

pub type EmbeddingInput {
  StringInput(String)
  StringArrayInput(List(String))
  IntegerArrayInput(List(Int))
  ArrayOfIntegerArrayInput(List(List(Int)))
}

Constructors

```
StringInput(String)
```
```
StringArrayInput(List(String))
```
```
IntegerArrayInput(List(Int))
```

ArrayOfIntegerArrayInput(List(List(Int)))

EmbeddingUsage

</>

Usage statistics for an embedding request.

pub type EmbeddingUsage {
  EmbeddingUsage(prompt_tokens: Int, total_tokens: Int)
}

Constructors

EmbeddingUsage(prompt_tokens: Int, total_tokens: Int)

EncodingFormat

</>

pub type EncodingFormat {
  Float
  Base64
}

Constructors

```
Float
```
```
Base64
```

Values

create_embedding_request_to_json

</>

pub fn create_embedding_request_to_json(
  request: CreateEmbeddingRequest,
) -> json.Json

create_request

</>

pub fn create_request(
  config: config.Config,
  params: CreateEmbeddingRequest,
) -> request.Request(String)

Build a request to create embeddings.

create_response

</>

pub fn create_response(
  response: response.Response(String),
) -> Result(CreateEmbeddingResponse, error.GlopenaiError)

Parse the response from creating embeddings.

embedding_decoder

</>

pub fn embedding_decoder() -> decode.Decoder(Embedding)

embedding_input_decoder

</>

pub fn embedding_input_decoder() -> decode.Decoder(EmbeddingInput)

embedding_input_to_json

</>

pub fn embedding_input_to_json(
  input: EmbeddingInput,
) -> json.Json

embedding_usage_decoder

</>

pub fn embedding_usage_decoder() -> decode.Decoder(EmbeddingUsage)

encoding_format_decoder

</>

pub fn encoding_format_decoder() -> decode.Decoder(EncodingFormat)

encoding_format_to_json

</>

pub fn encoding_format_to_json(
  format: EncodingFormat,
) -> json.Json

new_create_request

</>

pub fn new_create_request(
  model model: String,
  input input: EmbeddingInput,
) -> CreateEmbeddingRequest

Create a new embedding request with required fields and defaults.

with_dimensions

</>

pub fn with_dimensions(
  request: CreateEmbeddingRequest,
  dimensions: Int,
) -> CreateEmbeddingRequest

Set the output dimensions.

with_encoding_format

</>

pub fn with_encoding_format(
  request: CreateEmbeddingRequest,
  format: EncodingFormat,
) -> CreateEmbeddingRequest

Set the encoding format for the request.

with_user

</>

pub fn with_user(
  request: CreateEmbeddingRequest,
  user: String,
) -> CreateEmbeddingRequest

Set the user identifier.