EmbeddedResource class final

The contents of a resource, embedded into a prompt or tool call result.

It is up to the client how best to render embedded resources for the benefit of the LLM and/or the user.

Revisions: 2024-11-05, 2025-03-26, 2025-06-18, 2025-11-25, 2026-07-28, ext-tasks/2026-07-28.

Inheritance

Implemented types

Constructors

EmbeddedResource({Annotations? annotations, required ResourceContents resource, Map<String, Object?>? meta, Map<String, Object?>? extra})
EmbeddedResource.fromJson(Map<String, Object?> json): Wraps json as received; nothing is dropped.

annotations → Annotations?: Optional annotations for the client.
no setter
extra → Map<String, Object?>: Keys outside the schema (newer revisions, extensions, applications).
no setterinherited
hashCode → int: The hash code for this object.
no setterinherited
meta → Map<String, Object?>?: no setter
resource → ResourceContents: no setter
runtimeType → Type: A representation of the runtime type of the object.
no setterinherited
schemaKeys → Set<String>: Property names the schema defines for this type.
no setteroverride
type → String: no setter

$optional<T>(String key, T? read(Object? value, String path)) → T?: Optional property key, converted by read; null when absent or null.
inherited
$required<T>(String key, T read(Object? value, String path)) → T: Required property key, converted by read.
inherited
check() → List<String>: Reads every property this type defines and returns what could not be read (missing required properties, wrong types), nested types included. Empty = the JSON matches the schema's shape for this type.
override
copyWith({Annotations? annotations, ResourceContents? resource, Map<String, Object?>? meta}) → EmbeddedResource: A copy with the given properties replaced; everything else, unknown keys included, is kept.
has(String key) → bool: Whether key is present (a null value counts as present).
inherited
noSuchMethod(Invocation invocation) → dynamic: Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, Object?>: The JSON form of this value.
inherited
toString() → String: A string representation of this object.
inherited

operator ==(Object other) → bool: Equal when the JSON is equal; key order does not matter.
inherited
operator [](String key) → Object?: The raw JSON value of key.
inherited