Class: Google::Apis::AiplatformV1::GoogleCloudAiplatformV1EventMetadata

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

Overview

Metadata relating to a LLM response event.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(**args) ⇒ GoogleCloudAiplatformV1EventMetadata

Returns a new instance of GoogleCloudAiplatformV1EventMetadata.



11142
11143
11144
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11142

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) 


11090
11091
11092
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11090

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


11095
11096
11097
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11095

def custom_metadata
  @custom_metadata
end

#grounding_metadata ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1GroundingMetadata

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:



11102
11103
11104
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11102

def grounding_metadata
  @grounding_metadata
end

#input_transcription ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Transcription

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

Returns:



11107
11108
11109
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11107

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) 


11113
11114
11115
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11113

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


11121
11122
11123
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11121

def long_running_tool_ids
  @long_running_tool_ids
end

#output_transcription ⇒ Google::Apis::AiplatformV1::GoogleCloudAiplatformV1Transcription

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

Returns:



11126
11127
11128
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11126

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) 


11132
11133
11134
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11132

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) 


11139
11140
11141
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11139

def turn_complete
  @turn_complete
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



11147
11148
11149
11150
11151
11152
11153
11154
11155
11156
11157
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 11147

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