View Source GoogleApi.AIPlatform.V1.Model.CloudAiNlLlmProtoServiceCandidate (google_api_ai_platform v0.3.0)

Attributes

  • citationMetadata (type: GoogleApi.AIPlatform.V1.Model.CloudAiNlLlmProtoServiceCitationMetadata.t, default: nil) - Source attribution of the generated content.
  • content (type: GoogleApi.AIPlatform.V1.Model.CloudAiNlLlmProtoServiceContent.t, default: nil) - Content of the candidate.
  • finishMessage (type: String.t, default: nil) - A string that describes the filtering behavior in more detail. Only filled when reason is set.
  • finishReason (type: String.t, default: nil) - The reason why the model stopped generating tokens.
  • groundingMetadata (type: GoogleApi.AIPlatform.V1.Model.LearningGenaiRootGroundingMetadata.t, default: nil) - Grounding metadata. Combine with the facts list from response to generate grounding citations for this choice.
  • index (type: integer(), default: nil) - Index of the candidate.
  • safetyRatings (type: list(GoogleApi.AIPlatform.V1.Model.CloudAiNlLlmProtoServiceSafetyRating.t), default: nil) - Safety ratings of the generated content.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.AIPlatform.V1.Model.CloudAiNlLlmProtoServiceCandidate{
  citationMetadata:
    GoogleApi.AIPlatform.V1.Model.CloudAiNlLlmProtoServiceCitationMetadata.t()
    | nil,
  content:
    GoogleApi.AIPlatform.V1.Model.CloudAiNlLlmProtoServiceContent.t() | nil,
  finishMessage: String.t() | nil,
  finishReason: String.t() | nil,
  groundingMetadata:
    GoogleApi.AIPlatform.V1.Model.LearningGenaiRootGroundingMetadata.t() | nil,
  index: integer() | nil,
  safetyRatings:
    [GoogleApi.AIPlatform.V1.Model.CloudAiNlLlmProtoServiceSafetyRating.t()]
    | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.