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.



10228
10229
10230
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10228

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) 


10186
10187
10188
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10186

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


10191
10192
10193
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10191

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:



10198
10199
10200
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10198

def grounding_metadata
  @grounding_metadata
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) 


10204
10205
10206
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10204

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


10212
10213
10214
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10212

def long_running_tool_ids
  @long_running_tool_ids
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) 


10218
10219
10220
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10218

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) 


10225
10226
10227
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10225

def turn_complete
  @turn_complete
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



10233
10234
10235
10236
10237
10238
10239
10240
10241
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 10233

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)
  @interrupted = args[:interrupted] if args.key?(:interrupted)
  @long_running_tool_ids = args[:long_running_tool_ids] if args.key?(:long_running_tool_ids)
  @partial = args[:partial] if args.key?(:partial)
  @turn_complete = args[:turn_complete] if args.key?(:turn_complete)
end