View Source GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaRankRequest (google_api_discovery_engine v0.7.0)

Request message for RankService.Rank method.

Attributes

  • ignoreRecordDetailsInResponse (type: boolean(), default: nil) - If true, the response will contain only record ID and score. By default, it is false, the response will contain record details.
  • model (type: String.t, default: nil) - The identifier of the model to use. It is one of: * semantic-ranker-512@latest: Semantic ranking model with maxiumn input token size 512. It is set to semantic-ranker-512@latest by default if unspecified.
  • query (type: String.t, default: nil) - The query to use.
  • records (type: list(GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaRankingRecord.t), default: nil) - Required. A list of records to rank. At most 100 records to rank.
  • topN (type: integer(), default: nil) - The number of results to return. If this is unset or no bigger than zero, returns all results.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaRankRequest{
    ignoreRecordDetailsInResponse: boolean() | nil,
    model: String.t() | nil,
    query: String.t() | nil,
    records:
      [
        GoogleApi.DiscoveryEngine.V1beta.Model.GoogleCloudDiscoveryengineV1betaRankingRecord.t()
      ]
      | nil,
    topN: integer() | nil
  }

Functions

@spec decode(struct(), keyword()) :: struct()

Unwrap a decoded JSON object into its complex fields.