Class: A2A::TaskArtifactUpdateEvent

Inherits:
ProtocolStruct
  • Object
show all
Defined in:
lib/a2a/types/task_artifact_update_event.rb

Overview

An event sent by the agent to notify the client that an artifact has been generated or updated. This is typically used in streaming models.

Instance Method Summary collapse

Methods included from Extensions::CaseTransformation

#camelize, included, #to_json

Instance Method Details

#append ⇒ Boolean?

Returns If true, the content of this artifact should be appended to a previously sent artifact with the same ID.

Returns:

  • (Boolean, nil) —

    If true, the content of this artifact should be appended to a previously sent artifact with the same ID.



21
 
# File 'lib/a2a/types/task_artifact_update_event.rb', line 21

attribute? :append, Types::Bool.optional

#artifact ⇒ Artifact

Returns The artifact that was generated or updated.

Returns:

  • (Artifact) —

    The artifact that was generated or updated.



17
 
# File 'lib/a2a/types/task_artifact_update_event.rb', line 17

attribute :artifact, Types::Constructor(Artifact)

#context_id ⇒ String

Returns The context ID associated with the task.

Returns:

  • (String) —

    The context ID associated with the task.



11
 
# File 'lib/a2a/types/task_artifact_update_event.rb', line 11

attribute :context_id, Types::String

#kind ⇒ String

Returns The type of this event, used as a discriminator. Always ‘artifact-update’.

Returns:

  • (String) —

    The type of this event, used as a discriminator. Always ‘artifact-update’.



14
 
# File 'lib/a2a/types/task_artifact_update_event.rb', line 14

attribute :kind, Types::String.constant('artifact-update')

#last_chunk ⇒ Boolean?

Returns If true, this is the final chunk of the artifact.

Returns:

  • (Boolean, nil) —

    If true, this is the final chunk of the artifact.



24
 
# File 'lib/a2a/types/task_artifact_update_event.rb', line 24

attribute? :last_chunk, Types::Bool.optional

#metadata ⇒ Hash?

Returns Optional metadata for extensions.

Returns:

  • (Hash, nil) —

    Optional metadata for extensions.



27
 
# File 'lib/a2a/types/task_artifact_update_event.rb', line 27

attribute? :metadata, Types::Hash.optional

#task_id ⇒ String

Returns The ID of the task this artifact belongs to.

Returns:

  • (String) —

    The ID of the task this artifact belongs to.



8
 
# File 'lib/a2a/types/task_artifact_update_event.rb', line 8

attribute :task_id, Types::String