Class: Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1EventMetadata

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

Metadata relating to a LLM response event.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1beta1EventMetadata

Returns a new instance of GoogleCloudAiplatformV1beta1EventMetadata.



20760
20761
20762
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 20760

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

Instance Attribute Details

#branch ⇒ String

Optional. The branch of the event. The format is like agent_1.agent_2.agent_3, where agent_1 is the parent of agent_2, and agent_2 is the parent of agent_3. Branch is used when multiple child agents shouldn't see their siblings' conversation history. Corresponds to the JSON property branch

Returns:

  • (String) 


20708
20709
20710
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 20708

def branch
  @branch
end

#custom_metadata ⇒ Hash<String,Object>

The custom metadata of the LlmResponse. Corresponds to the JSON property customMetadata

Returns:

  • (Hash<String,Object>) 


20713
20714
20715
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 20713

def custom_metadata
  @custom_metadata
end

#grounding_metadata ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1GroundingMetadata

Information about the sources that support the content of a response. When grounding is enabled, the model returns citations for claims in the response. This object contains the retrieved sources. Corresponds to the JSON property groundingMetadata

Returns:



20720
20721
20722
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 20720

def grounding_metadata
  @grounding_metadata
end

#input_transcription ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Transcription

Audio transcription in Server Content. Corresponds to the JSON property inputTranscription

Returns:



20725
20726
20727
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 20725

def input_transcription
  @input_transcription
end

#interrupted ⇒ Boolean Also known as: interrupted?

Optional. Flag indicating that LLM was interrupted when generating the content. Usually it's due to user interruption during a bidi streaming. Corresponds to the JSON property interrupted

Returns:

  • (Boolean) 


20731
20732
20733
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 20731

def interrupted
  @interrupted
end

#long_running_tool_ids ⇒ Array<String>

Optional. Set of ids of the long running function calls. Agent client will know from this field about which function call is long running. Only valid for function call event. Corresponds to the JSON property longRunningToolIds

Returns:

  • (Array<String>) 


20739
20740
20741
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 20739

def long_running_tool_ids
  @long_running_tool_ids
end

#output_transcription ⇒ Google::Apis::AiplatformV1beta1::GoogleCloudAiplatformV1beta1Transcription

Audio transcription in Server Content. Corresponds to the JSON property outputTranscription

Returns:



20744
20745
20746
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 20744

def output_transcription
  @output_transcription
end

#partial ⇒ Boolean Also known as: partial?

Optional. Indicates whether the text content is part of a unfinished text stream. Only used for streaming mode and when the content is plain text. Corresponds to the JSON property partial

Returns:

  • (Boolean) 


20750
20751
20752
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 20750

def partial
  @partial
end

#turn_complete ⇒ Boolean Also known as: turn_complete?

Optional. Indicates whether the response from the model is complete. Only used for streaming mode. Corresponds to the JSON property turnComplete

Returns:

  • (Boolean) 


20757
20758
20759
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 20757

def turn_complete
  @turn_complete
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



20765
20766
20767
20768
20769
20770
20771
20772
20773
20774
20775
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 20765

def update!(**args)
  @branch = args[:branch] if args.key?(:branch)
  @custom_metadata = args[:custom_metadata] if args.key?(:custom_metadata)
  @grounding_metadata = args[:grounding_metadata] if args.key?(:grounding_metadata)
  @input_transcription = args[:input_transcription] if args.key?(:input_transcription)
  @interrupted = args[:interrupted] if args.key?(:interrupted)
  @long_running_tool_ids = args[:long_running_tool_ids] if args.key?(:long_running_tool_ids)
  @output_transcription = args[:output_transcription] if args.key?(:output_transcription)
  @partial = args[:partial] if args.key?(:partial)
  @turn_complete = args[:turn_complete] if args.key?(:turn_complete)
end