struct AI::Provider::EmbeddingModel::Result

Overview

The result of an embedding model doEmbed call.

Included Modules

Defined in:

ai/provider/embedding_model/embedding_model.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(embeddings : Array(Embedding), warnings : Array(Shared::Warning), usage : Usage | Nil = nil, provider_metadata : Shared::ProviderMetadata | Nil = nil, response : ResultResponse | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def embeddings : Array(Embedding) #

Generated embeddings. They are in the same order as the input values.


[View source]
def provider_metadata : Shared::ProviderMetadata | Nil #

Additional provider-specific metadata.


[View source]
def response : ResultResponse | Nil #

Optional response information for debugging purposes.


[View source]
def usage : Usage | Nil #

Token usage. We only have input tokens for embeddings.


[View source]
def warnings : Array(Shared::Warning) #

Warnings for the call, e.g. unsupported settings.


[View source]