Interface: SummarizeAdapter<TModel, TProviderOptions>#
Defined in: packages/typescript/ai/src/activities/summarize/adapter.ts:28
Summarize adapter interface with pre-resolved generics.
An adapter is created by a provider function: provider('model') → adapter
All type resolution happens at the provider call site, not in this interface.
Generic parameters:
- TModel: The specific model name (e.g., 'gpt-4o')
- TProviderOptions: Provider-specific options (already resolved)
Type Parameters#
TModel#
TModel extends string = string
TProviderOptions#
TProviderOptions extends object = Record<string, unknown>
Properties#
~types#
~types: object;
Defined in: packages/typescript/ai/src/activities/summarize/adapter.ts:42
Internal
Type-only properties for inference. Not assigned at runtime.
providerOptions#
providerOptions: TProviderOptions;
kind#
readonly kind: "summarize";
Defined in: packages/typescript/ai/src/activities/summarize/adapter.ts:33
Discriminator for adapter kind - used by generate() to determine API shape
model#
readonly model: TModel;
Defined in: packages/typescript/ai/src/activities/summarize/adapter.ts:37
The model this adapter is configured for
name#
readonly name: string;
Defined in: packages/typescript/ai/src/activities/summarize/adapter.ts:35
Adapter name identifier
summarize()#
summarize: (options) => Promise<SummarizationResult>;
Defined in: packages/typescript/ai/src/activities/summarize/adapter.ts:49
Summarize the given text
Parameters#
options#
SummarizationOptions<TProviderOptions>
Returns#
Promise<SummarizationResult>
summarizeStream()?#
optional summarizeStream: (options) => AsyncIterable<AGUIEvent>;
Defined in: packages/typescript/ai/src/activities/summarize/adapter.ts:58
Stream summarization of the given text. Optional - if not implemented, the activity layer will fall back to non-streaming summarize and yield the result as a single chunk.
Parameters#
options#
SummarizationOptions<TProviderOptions>
Returns#
AsyncIterable<AGUIEvent>