Class Chat

Chat encapsulates a statful execution environment for chat. Chat session executed within a session in this environment will have acesss to session convesation history.

const ai = genkit({...});
const chat = ai.chat(); // create a Chat
let response = await chat.send('hi, my name is Genkit');
response = await chat.send('what is my name?'); // chat history aware conversation

Index

Constructors

constructor

new Chat(
    session: Session,
    requestBase: Promise<BaseGenerateOptions<z.ZodTypeAny, z.ZodTypeAny>>,
    options: {
        id: string;
        messages?: {
            content: (
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text: string;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media: { contentType?: string; url: string };
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest: {
                        input?: unknown;
                        name: string;
                        partial?: boolean;
                        ref?: string;
                    };
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse: { name: string; output?: unknown; ref?: string } & {
                        content?: (...)[];
                    };
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom: Record<string, any>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning: string;
                    resource?: undefined;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    reasoning?: undefined;
                    resource: { uri: string };
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
            )[];
            metadata?: Record<string, unknown>;
            role: "user" | "model" | "tool" | "system";
        }[];
        thread: string;
    },
): Chat
Parameters
- session: Session
- requestBase: Promise<BaseGenerateOptions<z.ZodTypeAny, z.ZodTypeAny>>
- options: {
      id: string;
      messages?: {
          content: (
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  reasoning?: undefined;
                  resource?: undefined;
                  text: string;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media: { contentType?: string; url: string };
                  metadata?: Record<string, unknown>;
                  reasoning?: undefined;
                  resource?: undefined;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  reasoning?: undefined;
                  resource?: undefined;
                  text?: undefined;
                  toolRequest: {
                      input?: unknown;
                      name: string;
                      partial?: boolean;
                      ref?: string;
                  };
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  reasoning?: undefined;
                  resource?: undefined;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse: { name: string; output?: unknown; ref?: string } & {
                      content?: (...)[];
                  };
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  reasoning?: undefined;
                  resource?: undefined;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom: Record<string, any>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  reasoning?: undefined;
                  resource?: undefined;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  reasoning: string;
                  resource?: undefined;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  reasoning?: undefined;
                  resource: { uri: string };
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
          )[];
          metadata?: Record<string, unknown>;
          role: "user" | "model" | "tool" | "system";
      }[];
      thread: string;
  }
Returns Chat
- Defined in ai/lib/session.d.ts:209

Properties

`Readonly`session

session: Session

`Readonly`sessionId

sessionId: string

Accessors

messages

get messages(): {
    content: (
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text: string;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media: { contentType?: string; url: string };
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest: {
                input?: unknown;
                name: string;
                partial?: boolean;
                ref?: string;
            };
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse: { name: string; output?: unknown; ref?: string } & {
                content?: (
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                )[];
            };
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom: Record<string, any>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning: string;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource: { uri: string };
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
    )[];
    metadata?: Record<string, unknown>;
    role: "user" | "model" | "tool" | "system";
}[]
Returns {
    content: (
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text: string;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media: { contentType?: string; url: string };
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest: {
                input?: unknown;
                name: string;
                partial?: boolean;
                ref?: string;
            };
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse: { name: string; output?: unknown; ref?: string } & {
                content?: (
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning: ...;
                        resource?: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                    | {
                        custom?: ...;
                        data?: ...;
                        media?: ...;
                        metadata?: ...;
                        reasoning?: ...;
                        resource: ...;
                        text?: ...;
                        toolRequest?: ...;
                        toolResponse?: ...;
                    }
                )[];
            };
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom: Record<string, any>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning: string;
            resource?: undefined;
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
        | {
            custom?: Record<string, unknown>;
            data?: unknown;
            media?: undefined;
            metadata?: Record<string, unknown>;
            reasoning?: undefined;
            resource: { uri: string };
            text?: undefined;
            toolRequest?: undefined;
            toolResponse?: undefined;
        }
    )[];
    metadata?: Record<string, unknown>;
    role: "user" | "model" | "tool" | "system";
}[]
- Defined in ai/lib/session.d.ts:216

Methods

send

send<
    O extends z.ZodTypeAny = z.ZodTypeAny,
    CustomOptions extends
        z.ZodTypeAny = z.ZodObject<
        {
            apiKey: z.ZodOptional<z.ZodString>;
            maxOutputTokens: z.ZodOptional<z.ZodNumber>;
            stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
            temperature: z.ZodOptional<z.ZodNumber>;
            topK: z.ZodOptional<z.ZodNumber>;
            topP: z.ZodOptional<z.ZodNumber>;
            version: z.ZodOptional<z.ZodString>;
        },
        "passthrough",
        z.ZodTypeAny,
        z.objectOutputType<
            {
                apiKey: z.ZodOptional<z.ZodString>;
                maxOutputTokens: z.ZodOptional<z.ZodNumber>;
                stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
                temperature: z.ZodOptional<z.ZodNumber>;
                topK: z.ZodOptional<z.ZodNumber>;
                topP: z.ZodOptional<z.ZodNumber>;
                version: z.ZodOptional<z.ZodString>;
            },
            z.ZodTypeAny,
            "passthrough",
        >,
        z.objectInputType<
            {
                apiKey: z.ZodOptional<z.ZodString>;
                maxOutputTokens: z.ZodOptional<z.ZodNumber>;
                stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
                temperature: z.ZodOptional<z.ZodNumber>;
                topK: z.ZodOptional<z.ZodNumber>;
                topP: z.ZodOptional<z.ZodNumber>;
                version: z.ZodOptional<z.ZodString>;
            },
            z.ZodTypeAny,
            "passthrough",
        >,
    >,
>(
    options:
        | string
        | (
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text: string;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media: { contentType?: string; url: string };
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest: {
                    input?: unknown;
                    name: string;
                    partial?: boolean;
                    ref?: string;
                };
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse: { name: string; output?: unknown; ref?: string } & {
                    content?: ({ text: string; custom?: Record<string, unknown> | undefined; metadata?: Record<string, unknown> | undefined; media?: undefined; toolRequest?: undefined; toolResponse?: undefined; data?: unknown; reasoning?: undefined; resource?: undefined; } | ... 6 more ... | { ...; })[];
                };
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom: Record<string, any>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning: string;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource: { uri: string };
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
        )[]
        | ChatGenerateOptions<O, CustomOptions>,
): Promise<GenerateResponse<z.TypeOf<O>>>
Type Parameters
- O extends z.ZodTypeAny = z.ZodTypeAny
- CustomOptions extends z.ZodTypeAny = z.ZodObject<
      {
          apiKey: z.ZodOptional<z.ZodString>;
          maxOutputTokens: z.ZodOptional<z.ZodNumber>;
          stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
          temperature: z.ZodOptional<z.ZodNumber>;
          topK: z.ZodOptional<z.ZodNumber>;
          topP: z.ZodOptional<z.ZodNumber>;
          version: z.ZodOptional<z.ZodString>;
      },
      "passthrough",
      z.ZodTypeAny,
      z.objectOutputType<
          {
              apiKey: z.ZodOptional<z.ZodString>;
              maxOutputTokens: z.ZodOptional<z.ZodNumber>;
              stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
              temperature: z.ZodOptional<z.ZodNumber>;
              topK: z.ZodOptional<z.ZodNumber>;
              topP: z.ZodOptional<z.ZodNumber>;
              version: z.ZodOptional<z.ZodString>;
          },
          z.ZodTypeAny,
          "passthrough",
      >,
      z.objectInputType<
          {
              apiKey: z.ZodOptional<z.ZodString>;
              maxOutputTokens: z.ZodOptional<z.ZodNumber>;
              stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
              temperature: z.ZodOptional<z.ZodNumber>;
              topK: z.ZodOptional<z.ZodNumber>;
              topP: z.ZodOptional<z.ZodNumber>;
              version: z.ZodOptional<z.ZodString>;
          },
          z.ZodTypeAny,
          "passthrough",
      >,
  >
Parameters
- options:
      | string
      | (
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text: string;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media: { contentType?: string; url: string };
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest: {
                  input?: unknown;
                  name: string;
                  partial?: boolean;
                  ref?: string;
              };
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse: { name: string; output?: unknown; ref?: string } & {
                  content?: ({ text: string; custom?: Record<string, unknown> | undefined; metadata?: Record<string, unknown> | undefined; media?: undefined; toolRequest?: undefined; toolResponse?: undefined; data?: unknown; reasoning?: undefined; resource?: undefined; } | ... 6 more ... | { ...; })[];
              };
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom: Record<string, any>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning: string;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource: { uri: string };
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
      )[]
      | ChatGenerateOptions<O, CustomOptions>
Returns Promise<GenerateResponse<z.TypeOf<O>>>
- Defined in ai/lib/session.d.ts:214

sendStream

sendStream<
    O extends z.ZodTypeAny = z.ZodTypeAny,
    CustomOptions extends
        z.ZodTypeAny = z.ZodObject<
        {
            apiKey: z.ZodOptional<z.ZodString>;
            maxOutputTokens: z.ZodOptional<z.ZodNumber>;
            stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
            temperature: z.ZodOptional<z.ZodNumber>;
            topK: z.ZodOptional<z.ZodNumber>;
            topP: z.ZodOptional<z.ZodNumber>;
            version: z.ZodOptional<z.ZodString>;
        },
        "passthrough",
        z.ZodTypeAny,
        z.objectOutputType<
            {
                apiKey: z.ZodOptional<z.ZodString>;
                maxOutputTokens: z.ZodOptional<z.ZodNumber>;
                stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
                temperature: z.ZodOptional<z.ZodNumber>;
                topK: z.ZodOptional<z.ZodNumber>;
                topP: z.ZodOptional<z.ZodNumber>;
                version: z.ZodOptional<z.ZodString>;
            },
            z.ZodTypeAny,
            "passthrough",
        >,
        z.objectInputType<
            {
                apiKey: z.ZodOptional<z.ZodString>;
                maxOutputTokens: z.ZodOptional<z.ZodNumber>;
                stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
                temperature: z.ZodOptional<z.ZodNumber>;
                topK: z.ZodOptional<z.ZodNumber>;
                topP: z.ZodOptional<z.ZodNumber>;
                version: z.ZodOptional<z.ZodString>;
            },
            z.ZodTypeAny,
            "passthrough",
        >,
    >,
>(
    options:
        | string
        | (
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text: string;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media: { contentType?: string; url: string };
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest: {
                    input?: unknown;
                    name: string;
                    partial?: boolean;
                    ref?: string;
                };
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse: { name: string; output?: unknown; ref?: string } & {
                    content?: ({ text: string; custom?: Record<string, unknown> | undefined; metadata?: Record<string, unknown> | undefined; media?: undefined; toolRequest?: undefined; toolResponse?: undefined; data?: unknown; reasoning?: undefined; resource?: undefined; } | ... 6 more ... | { ...; })[];
                };
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom: Record<string, any>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning: string;
                resource?: undefined;
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
            | {
                custom?: Record<string, unknown>;
                data?: unknown;
                media?: undefined;
                metadata?: Record<string, unknown>;
                reasoning?: undefined;
                resource: { uri: string };
                text?: undefined;
                toolRequest?: undefined;
                toolResponse?: undefined;
            }
        )[]
        | GenerateStreamOptions<O, CustomOptions>,
): GenerateStreamResponse<z.TypeOf<O>>
Type Parameters
- O extends z.ZodTypeAny = z.ZodTypeAny
- CustomOptions extends z.ZodTypeAny = z.ZodObject<
      {
          apiKey: z.ZodOptional<z.ZodString>;
          maxOutputTokens: z.ZodOptional<z.ZodNumber>;
          stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
          temperature: z.ZodOptional<z.ZodNumber>;
          topK: z.ZodOptional<z.ZodNumber>;
          topP: z.ZodOptional<z.ZodNumber>;
          version: z.ZodOptional<z.ZodString>;
      },
      "passthrough",
      z.ZodTypeAny,
      z.objectOutputType<
          {
              apiKey: z.ZodOptional<z.ZodString>;
              maxOutputTokens: z.ZodOptional<z.ZodNumber>;
              stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
              temperature: z.ZodOptional<z.ZodNumber>;
              topK: z.ZodOptional<z.ZodNumber>;
              topP: z.ZodOptional<z.ZodNumber>;
              version: z.ZodOptional<z.ZodString>;
          },
          z.ZodTypeAny,
          "passthrough",
      >,
      z.objectInputType<
          {
              apiKey: z.ZodOptional<z.ZodString>;
              maxOutputTokens: z.ZodOptional<z.ZodNumber>;
              stopSequences: z.ZodOptional<z.ZodArray<z.ZodString, "many">>;
              temperature: z.ZodOptional<z.ZodNumber>;
              topK: z.ZodOptional<z.ZodNumber>;
              topP: z.ZodOptional<z.ZodNumber>;
              version: z.ZodOptional<z.ZodString>;
          },
          z.ZodTypeAny,
          "passthrough",
      >,
  >
Parameters
- options:
      | string
      | (
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text: string;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media: { contentType?: string; url: string };
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest: {
                  input?: unknown;
                  name: string;
                  partial?: boolean;
                  ref?: string;
              };
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse: { name: string; output?: unknown; ref?: string } & {
                  content?: ({ text: string; custom?: Record<string, unknown> | undefined; metadata?: Record<string, unknown> | undefined; media?: undefined; toolRequest?: undefined; toolResponse?: undefined; data?: unknown; reasoning?: undefined; resource?: undefined; } | ... 6 more ... | { ...; })[];
              };
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom: Record<string, any>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning: string;
              resource?: undefined;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              reasoning?: undefined;
              resource: { uri: string };
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
      )[]
      | GenerateStreamOptions<O, CustomOptions>
Returns GenerateStreamResponse<z.TypeOf<O>>
- Defined in ai/lib/session.d.ts:215

Class Chat

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Chat

Properties

`Readonly`session

`Readonly`sessionId

Accessors

messages

Methods

send

Type Parameters

Parameters

Returns Promise<GenerateResponse<z.TypeOf<O>>>

sendStream

Type Parameters

Parameters

Returns GenerateStreamResponse<z.TypeOf<O>>

Settings

On This Page

Class Chat

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns Chat

Properties

Readonlysession

ReadonlysessionId

Accessors

messages

Methods

send

Type Parameters

Parameters

Returns Promise<GenerateResponse<z.TypeOf<O>>>

sendStream

Type Parameters

Parameters

Returns GenerateStreamResponse<z.TypeOf<O>>

Settings

On This Page

`Readonly`session

`Readonly`sessionId