struct AI::Provider::RerankingModel::Result

• AI::Provider::RerankingModel::Result
• Struct
• Value
• Object

Overview

The result of a reranking model doRerank call.

Included Modules

• JSON::Serializable

Defined in:

ai/provider/reranking_model/reranking_model.cr

Constructors

• .new(pull : JSON::PullParser)
• .new(ranking : Array(RankedDocument), provider_metadata : ProviderMetadata | Nil = nil, warnings : Array(Shared::Warning) | Nil = nil, response : ResultResponse | Nil = nil)
• .new(*, __pull_for_json_serializable pull : JSON::PullParser)

Instance Method Summary

• #provider_metadata : ProviderMetadata | Nil

  Additional provider-specific metadata.

• #ranking : Array(RankedDocument)

  Ordered list of reranked documents (by descending relevance score).

• #response : ResultResponse | Nil

  Optional response information for debugging purposes.

• #warnings : Array(Shared::Warning) | Nil

  Warnings for the call, e.g.

Constructor Detail

Instance Method Detail