View Source GoogleApi.AIPlatform.V1.Model.LearningGenaiRecitationSegmentResult (google_api_ai_platform v0.5.0)

The recitation result for each segment in a given input.

Attributes

  • attributionDataset (type: String.t, default: nil) - The dataset the segment came from.
  • displayAttributionMessage (type: String.t, default: nil) - human-friendly string that contains information from doc_attribution which could be shown by clients
  • docAttribution (type: GoogleApi.AIPlatform.V1.Model.LearningGenaiRecitationDocAttribution.t, default: nil) - populated when recitation_action == CITE
  • docOccurrences (type: integer(), default: nil) - number of documents that contained this segment
  • endIndex (type: integer(), default: nil) -
  • rawText (type: String.t, default: nil) - The raw text in the given input that is corresponding to the segment. It will be available only when 'return_segment_raw_text' is enabled in the request options.
  • segmentRecitationAction (type: String.t, default: nil) -
  • startIndex (type: integer(), default: nil) - The segment boundary start (inclusive) and end index (exclusive) in the given text. In the streaming RPC, the indexes always start from the beginning of the first text in the entire stream. The indexes are measured in UTF-16 code units.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() :: %GoogleApi.AIPlatform.V1.Model.LearningGenaiRecitationSegmentResult{
  attributionDataset: String.t() | nil,
  displayAttributionMessage: String.t() | nil,
  docAttribution:
    GoogleApi.AIPlatform.V1.Model.LearningGenaiRecitationDocAttribution.t()
    | nil,
  docOccurrences: integer() | nil,
  endIndex: integer() | nil,
  rawText: String.t() | nil,
  segmentRecitationAction: String.t() | nil,
  startIndex: integer() | nil
}

Functions

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

Unwrap a decoded JSON object into its complex fields.