Class: A2A::Artifact

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

Overview

Represents a file, data structure, or other resource generated by an agent during a task.

Instance Method Summary collapse

Methods included from Extensions::CaseTransformation

#camelize, included, #to_json

Instance Method Details

#artifact_id ⇒ String

Returns A unique identifier (e.g. UUID) for the artifact within the scope of the task.

Returns:

  • (String) —

    A unique identifier (e.g. UUID) for the artifact within the scope of the task.



7
 
# File 'lib/a2a/types/artifact.rb', line 7

attribute :artifact_id, Types::String

#description ⇒ String?

Returns An optional, human-readable description of the artifact.

Returns:

  • (String, nil) —

    An optional, human-readable description of the artifact.



13
 
# File 'lib/a2a/types/artifact.rb', line 13

attribute? :description, Types::String.optional

#extensions ⇒ Array<String>?

Returns The URIs of extensions that are relevant to this artifact.

Returns:

  • (Array<String>, nil) —

    The URIs of extensions that are relevant to this artifact.



22
 
# File 'lib/a2a/types/artifact.rb', line 22

attribute? :extensions, Types::Array.of(Types::String).optional

#metadata ⇒ Hash?

Returns Optional metadata for extensions. The key is an extension-specific identifier.

Returns:

  • (Hash, nil) —

    Optional metadata for extensions. The key is an extension-specific identifier.



19
 
# File 'lib/a2a/types/artifact.rb', line 19

attribute? :metadata, Types::Hash.optional

#name ⇒ String?

Returns An optional, human-readable name for the artifact.

Returns:

  • (String, nil) —

    An optional, human-readable name for the artifact.



10
 
# File 'lib/a2a/types/artifact.rb', line 10

attribute? :name, Types::String.optional

#parts ⇒ Array<Part>

Returns An array of content parts that make up the artifact.

Returns:

  • (Array<Part>) —

    An array of content parts that make up the artifact.



16
 
# File 'lib/a2a/types/artifact.rb', line 16

attribute :parts, Types::Array.of(Types::Constructor(Part))