ItemType

type ItemType<TData> = {
  agent?: {
     render?: (data) => string | undefined;
  };
  data: TData;
  description?: string;
  id: string;
  name: string;
};

Defined in: item/item.types.ts:8

A registered kind of conversation item (see promptOutputItemSchema): the schema its data must satisfy, plus how it is presented. Follows the same registry pattern as EntityType and ProviderType.

Type Parameters

Type Parameter	Default type
TData extends z.ZodType	z.ZodType

Properties

agent?

optional agent?: {
  render?: (data) => string | undefined;
};

Defined in: item/item.types.ts:18

How items of this type are exposed to the agent. Omit it for presentation-only artifacts (e.g. UI widgets): those stay in the transcript for hosts and UIs to consume, but never enter the model’s context.

render?

optional render?: (data) => string | undefined;

Render an item of this type into the model’s context. Return undefined to keep a specific item out even though the type is exposed. Omit to use the default rendering (a name-labelled JSON dump).

Parameters

Parameter	Type
data	z.infer<TData>

Returns

string | undefined

---

data

data: TData;

Defined in: item/item.types.ts:12

---

description?

optional description?: string;

Defined in: item/item.types.ts:11

---

id

id: string;

Defined in: item/item.types.ts:9

---

name

name: string;

Defined in: item/item.types.ts:10