ExBifrost.Api.Rerank (ex_bifrost v0.1.0)

Copy Markdown View Source

API calls for all endpoints tagged Rerank.

Summary

Functions

rerank_documents(connection, rerank_request, opts \\ [])

Rerank documents Reorders input documents by relevance to a query.

Functions

rerank_documents(connection, rerank_request, opts \\ [])

@spec rerank_documents(
  Tesla.Env.client(),
  ExBifrost.Model.RerankRequest.t(),
  keyword()
) ::
  {:ok, ExBifrost.Model.RerankResponse.t()}
  | {:ok, ExBifrost.Model.BifrostError.t()}
  | {:error, Tesla.Env.t()}

Rerank documents Reorders input documents by relevance to a query.

Parameters

  • connection (ExBifrost.Connection): Connection to server
  • rerank_request (RerankRequest):
  • opts (keyword): Optional parameters

Returns

  • {:ok, ExBifrost.Model.RerankResponse.t} on success
  • {:error, Tesla.Env.t} on failure