GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1RankingRecord (google_api_discovery_engine v0.28.0)

Record message for RankService.Rank method.

Attributes

content (type: String.t, default: nil) - The content of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.
id (type: String.t, default: nil) - The unique ID to represent the record.
score (type: number(), default: nil) - The score of this record based on the given query and selected model. The score will be rounded to 2 decimal places. If the score is close to 0, it will be rounded to 0.0001 to avoid returning unset.
title (type: String.t, default: nil) - The title of the record. Empty by default. At least one of title or content should be set otherwise an INVALID_ARGUMENT error is thrown.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() ::
  %GoogleApi.DiscoveryEngine.V1.Model.GoogleCloudDiscoveryengineV1RankingRecord{
    content: String.t() | nil,
    id: String.t() | nil,
    score: number() | nil,
    title: String.t() | nil
  }

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.