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.



12648
12649
12650
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12648

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) 


12596
12597
12598
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12596

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


12601
12602
12603
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12601

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:



12608
12609
12610
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12608

def grounding_metadata
  @grounding_metadata
end

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

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

Returns:



12613
12614
12615
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12613

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) 


12619
12620
12621
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12619

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


12627
12628
12629
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12627

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:



12632
12633
12634
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12632

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) 


12638
12639
12640
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12638

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) 


12645
12646
12647
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12645

def turn_complete
  @turn_complete
end

Instance Method Details

#update!(**args) ⇒ Object

Update properties of this object



12653
12654
12655
12656
12657
12658
12659
12660
12661
12662
12663
 
# File 'lib/google/apis/aiplatform_v1/classes.rb', line 12653

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