View Source GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Candidate (google_api_ai_platform v0.13.0)

A response candidate generated from the model.

Attributes

avgLogprobs (type: float(), default: nil) - Output only. Average log probability score of the candidate.
citationMetadata (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1CitationMetadata.t, default: nil) - Output only. Source attribution of the generated content.
content (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Content.t, default: nil) - Output only. Content parts of the candidate.
finishMessage (type: String.t, default: nil) - Output only. Describes the reason the mode stopped generating tokens in more detail. This is only filled when finish_reason is set.
finishReason (type: String.t, default: nil) - Output only. The reason why the model stopped generating tokens. If empty, the model has not stopped generating the tokens.
groundingMetadata (type: GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1GroundingMetadata.t, default: nil) - Output only. Metadata specifies sources used to ground generated content.
index (type: integer(), default: nil) - Output only. Index of the candidate.
safetyRatings (type: list(GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1SafetyRating.t), default: nil) - Output only. List of ratings for the safety of a response candidate. There is at most one rating per category.

Summary

Types

t()

Functions

decode(value, options)

Unwrap a decoded JSON object into its complex fields.

Types

t()

@type t() :: %GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Candidate{
  avgLogprobs: float() | nil,
  citationMetadata:
    GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1CitationMetadata.t()
    | nil,
  content:
    GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1Content.t() | nil,
  finishMessage: String.t() | nil,
  finishReason: String.t() | nil,
  groundingMetadata:
    GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1GroundingMetadata.t()
    | nil,
  index: integer() | nil,
  safetyRatings:
    [GoogleApi.AIPlatform.V1.Model.GoogleCloudAiplatformV1SafetyRating.t()]
    | nil
}

Functions

decode(value, options)

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

Unwrap a decoded JSON object into its complex fields.