Skip to content

Fix: Propagate Generic Type to GenerateStreamResponse.stream #3627

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Fix: Propagate Generic Type to GenerateStreamResponse.stream #3627

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9db32c4
fix(typings): propagate generic type O to GenerateStreamResponse.stream
Dinesh-Gautam Sep 22, 2025
e2dcc1f
fix(typing): specify generic type for Channel in genkit
Dinesh-Gautam Sep 22, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions js/ai/src/generate.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -156,7 +156,7 @@ export interface GenerateOptions<
/** Maximum number of tool call iterations that can be performed in a single generate call (default 5). */
maxTurns?: number;
/** When provided, models supporting streaming will call the provided callback with chunks as generation progresses. */
onChunk?: StreamingCallback<GenerateResponseChunk>;
onChunk?: StreamingCallback<GenerateResponseChunk<z.infer<O>>>;
/**
* When provided, models supporting streaming will call the provided callback with chunks as generation progresses.
*
Expand Down Expand Up @@ -298,7 +298,10 @@ async function toolsToActionRefs(
return tools;
}

function messagesFromOptions(options: GenerateOptions): MessageData[] {
function messagesFromOptions<
O extends z.ZodTypeAny = z.ZodTypeAny,
CustomOptions extends z.ZodTypeAny = z.ZodType,
>(options: GenerateOptions<O, CustomOptions>): MessageData[] {
const messages: MessageData[] = [];
if (options.system) {
messages.push({
Expand Down Expand Up @@ -549,7 +552,7 @@ export type GenerateStreamOptions<
> = Omit<GenerateOptions<O, CustomOptions>, 'streamingCallback'>;

export interface GenerateStreamResponse<O extends z.ZodTypeAny = z.ZodTypeAny> {
get stream(): AsyncIterable<GenerateResponseChunk>;
get stream(): AsyncIterable<GenerateResponseChunk<O>>;
get response(): Promise<GenerateResponse<O>>;
}

Expand All @@ -562,7 +565,7 @@ export function generateStream<
| GenerateOptions<O, CustomOptions>
| PromiseLike<GenerateOptions<O, CustomOptions>>
): GenerateStreamResponse<O> {
const channel = new Channel<GenerateResponseChunk>();
const channel = new Channel<GenerateResponseChunk<O>>();

const generated = Promise.resolve(options).then((resolvedOptions) =>
generate<O, CustomOptions>(registry, {
Expand Down
2 changes: 1 addition & 1 deletion js/genkit/src/genkit.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -358,7 +358,7 @@ export class Genkit implements HasRegistry {
input?: I,
opts?: PromptGenerateOptions<O, CustomOptions>
): GenerateStreamResponse<O> => {
let channel = new Channel<GenerateResponseChunk>();
let channel = new Channel<GenerateResponseChunk<O>>();

const generated = runInNewSpan(
this.registry,
Expand Down