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.



18024
18025
18026
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18024

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) 


17972
17973
17974
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17972

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>) 


17977
17978
17979
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17977

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:



17984
17985
17986
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17984

def grounding_metadata
  @grounding_metadata
end

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

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

Returns:



17989
17990
17991
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17989

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) 


17995
17996
17997
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 17995

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>) 


18003
18004
18005
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18003

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:



18008
18009
18010
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18008

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) 


18014
18015
18016
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18014

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) 


18021
18022
18023
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18021

def turn_complete
  @turn_complete
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



18029
18030
18031
18032
18033
18034
18035
18036
18037
18038
18039
 
# File 'lib/google/apis/aiplatform_v1beta1/classes.rb', line 18029

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