Class: Google::Apis::AiplatformV1beta1::LearningGenaiRecitationSegmentResult

Inherits:
Object
  • Object
show all
Includes:
Core::Hashable, Core::JsonObjectSupport
Defined in:
lib/google/apis/aiplatform_v1beta1/classes.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb,
lib/google/apis/aiplatform_v1beta1/representations.rb

Overview

The recitation result for each segment in a given input.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ LearningGenaiRecitationSegmentResult

Returns a new instance of LearningGenaiRecitationSegmentResult.



32132
32133
32134
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32132

def initialize(**args)
   update!(**args)
end

Instance Attribute Details

#attribution_dataset ⇒ String

The dataset the segment came from. Corresponds to the JSON property attributionDataset

Returns:

  • (String) 


32086
32087
32088
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32086

def attribution_dataset
  @attribution_dataset
end

#display_attribution_message ⇒ String

human-friendly string that contains information from doc_attribution which could be shown by clients Corresponds to the JSON property displayAttributionMessage

Returns:

  • (String) 


32092
32093
32094
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32092

def display_attribution_message
  @display_attribution_message
end

#doc_attribution ⇒ Google::Apis::AiplatformV1beta1::LearningGenaiRecitationDocAttribution

The proto defines the attribution information for a document using whatever fields are most applicable for that document's datasource. For example, a Wikipedia article's attribution is in the form of its article title, a website is in the form of a URL, and a Github repo is in the form of a repo name. Next id: 30 Corresponds to the JSON property docAttribution

Returns:



32101
32102
32103
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32101

def doc_attribution
  @doc_attribution
end

#doc_occurrences ⇒ Fixnum

number of documents that contained this segment Corresponds to the JSON property docOccurrences

Returns:

  • (Fixnum) 


32106
32107
32108
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32106

def doc_occurrences
  @doc_occurrences
end

#end_index ⇒ Fixnum

Corresponds to the JSON property endIndex

Returns:

  • (Fixnum) 


32111
32112
32113
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32111

def end_index
  @end_index
end

#raw_text ⇒ String

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. Corresponds to the JSON property rawText

Returns:

  • (String) 


32118
32119
32120
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32118

def raw_text
  @raw_text
end

#segment_recitation_action ⇒ String

Corresponds to the JSON property segmentRecitationAction

Returns:

  • (String) 


32123
32124
32125
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32123

def segment_recitation_action
  @segment_recitation_action
end

#start_index ⇒ Fixnum

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. Corresponds to the JSON property startIndex

Returns:

  • (Fixnum) 


32130
32131
32132
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32130

def start_index
  @start_index
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



32137
32138
32139
32140
32141
32142
32143
32144
32145
32146
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 32137

def update!(**args)
  @attribution_dataset = args[:attribution_dataset] if args.key?(:attribution_dataset)
  @display_attribution_message = args[:display_attribution_message] if args.key?(:display_attribution_message)
  @doc_attribution = args[:doc_attribution] if args.key?(:doc_attribution)
  @doc_occurrences = args[:doc_occurrences] if args.key?(:doc_occurrences)
  @end_index = args[:end_index] if args.key?(:end_index)
  @raw_text = args[:raw_text] if args.key?(:raw_text)
  @segment_recitation_action = args[:segment_recitation_action] if args.key?(:segment_recitation_action)
  @start_index = args[:start_index] if args.key?(:start_index)
end