Class GenerateResponse<O>

constructor

• new GenerateResponse<O = unknown>(
      response: {
          candidates?: {
              custom?: unknown;
              finishMessage?: string;
              finishReason:
                  | "length"
                  | "stop"
                  | "interrupted"
                  | "blocked"
                  | "unknown"
                  | "other";
              index: number;
              message: {
                  content: (
                      | {
                          custom?: Record<string, unknown>;
                          data?: unknown;
                          media?: undefined;
                          metadata?: Record<string, unknown>;
                          text: string;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                      | {
                          custom?: Record<string, unknown>;
                          data?: unknown;
                          media: { contentType?: string; url: string };
                          metadata?: Record<string, unknown>;
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                      | {
                          custom?: Record<string, unknown>;
                          data?: unknown;
                          media?: undefined;
                          metadata?: Record<string, unknown>;
                          text?: undefined;
                          toolRequest: { input?: unknown; name: string; ref?: string };
                          toolResponse?: undefined;
                      }
                      | {
                          custom?: Record<string, unknown>;
                          data?: unknown;
                          media?: undefined;
                          metadata?: Record<string, unknown>;
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse: { name: string; output?: unknown; ref?: string };
                      }
                      | {
                          custom?: Record<string, unknown>;
                          data?: unknown;
                          media?: undefined;
                          metadata?: Record<string, unknown>;
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                      | {
                          custom: Record<string, any>;
                          data?: unknown;
                          media?: undefined;
                          metadata?: Record<string, unknown>;
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                  )[];
                  metadata?: Record<string, unknown>;
                  role: "user" | "model" | "tool" | "system";
              };
              usage?: {
                  cachedContentTokens?: number;
                  custom?: Record<string, number>;
                  inputAudioFiles?: number;
                  inputCharacters?: number;
                  inputImages?: number;
                  inputTokens?: number;
                  inputVideos?: number;
                  outputAudioFiles?: number;
                  outputCharacters?: number;
                  outputImages?: number;
                  outputTokens?: number;
                  outputVideos?: number;
                  thoughtsTokens?: number;
                  totalTokens?: number;
              };
          }[];
          custom?: unknown;
          finishMessage?: string;
          finishReason?: | "length"
          | "stop"
          | "interrupted"
          | "blocked"
          | "unknown"
          | "other";
          latencyMs?: number;
          message?: {
              content: (
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text: string;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media: { contentType?: string; url: string };
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest: { input?: unknown; name: string; ref?: string };
                      toolResponse?: undefined;
                  }
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest?: undefined;
                      toolResponse: { name: string; output?: unknown; ref?: string };
                  }
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
                  | {
                      custom: Record<string, any>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
              )[];
              metadata?: Record<string, unknown>;
              role: "user" | "model" | "tool" | "system";
          };
          raw?: unknown;
          request?: {
              candidates?: number;
              config?: any;
              docs?: {
                  content: (
                      | {
                          custom?: Record<(...), (...)>;
                          data?: unknown;
                          media?: undefined;
                          metadata?: Record<(...), (...)>;
                          text: string;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                      | {
                          custom?: Record<(...), (...)>;
                          data?: unknown;
                          media: { contentType?: (...) | (...); url: string };
                          metadata?: Record<(...), (...)>;
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                  )[];
                  metadata?: Record<string, any>;
              }[];
              messages: {
                  content: (
                      | {
                          custom?: Record<string, unknown>;
                          data?: unknown;
                          media?: undefined;
                          metadata?: Record<string, unknown>;
                          text: string;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                      | {
                          custom?: Record<string, unknown>;
                          data?: unknown;
                          media: { contentType?: string; url: string };
                          metadata?: Record<string, unknown>;
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                      | {
                          custom?: Record<string, unknown>;
                          data?: unknown;
                          media?: undefined;
                          metadata?: Record<string, unknown>;
                          text?: undefined;
                          toolRequest: { input?: unknown; name: string; ref?: string };
                          toolResponse?: undefined;
                      }
                      | {
                          custom?: Record<string, unknown>;
                          data?: unknown;
                          media?: undefined;
                          metadata?: Record<string, unknown>;
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse: { name: string; output?: unknown; ref?: string };
                      }
                      | {
                          custom?: Record<string, unknown>;
                          data?: unknown;
                          media?: undefined;
                          metadata?: Record<string, unknown>;
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                      | {
                          custom: Record<string, any>;
                          data?: unknown;
                          media?: undefined;
                          metadata?: Record<string, unknown>;
                          text?: undefined;
                          toolRequest?: undefined;
                          toolResponse?: undefined;
                      }
                  )[];
                  metadata?: Record<string, unknown>;
                  role: "user" | "model" | "tool" | "system";
              }[];
              output?: {
                  constrained?: boolean;
                  contentType?: string;
                  format?: string;
                  schema?: Record<string, any>;
              };
              toolChoice?: "required"
              | "auto"
              | "none";
              tools?: {
                  description: string;
                  inputSchema?: null | Record<string, any>;
                  metadata?: Record<string, any>;
                  name: string;
                  outputSchema?: null | Record<string, any>;
              }[];
          };
          usage?: {
              cachedContentTokens?: number;
              custom?: Record<string, number>;
              inputAudioFiles?: number;
              inputCharacters?: number;
              inputImages?: number;
              inputTokens?: number;
              inputVideos?: number;
              outputAudioFiles?: number;
              outputCharacters?: number;
              outputImages?: number;
              outputTokens?: number;
              outputVideos?: number;
              thoughtsTokens?: number;
              totalTokens?: number;
          };
      },
      options?: {
          parser?: MessageParser<O>;
          request?: GenerateRequest<z.ZodTypeAny>;
      },
  ): GenerateResponse<O>

• Type Parameters

  • O = unknown

  Parameters

  • response: {
        candidates?: {
            custom?: unknown;
            finishMessage?: string;
            finishReason:
                | "length"
                | "stop"
                | "interrupted"
                | "blocked"
                | "unknown"
                | "other";
            index: number;
            message: {
                content: (
                    | {
                        custom?: Record<string, unknown>;
                        data?: unknown;
                        media?: undefined;
                        metadata?: Record<string, unknown>;
                        text: string;
                        toolRequest?: undefined;
                        toolResponse?: undefined;
                    }
                    | {
                        custom?: Record<string, unknown>;
                        data?: unknown;
                        media: { contentType?: string; url: string };
                        metadata?: Record<string, unknown>;
                        text?: undefined;
                        toolRequest?: undefined;
                        toolResponse?: undefined;
                    }
                    | {
                        custom?: Record<string, unknown>;
                        data?: unknown;
                        media?: undefined;
                        metadata?: Record<string, unknown>;
                        text?: undefined;
                        toolRequest: { input?: unknown; name: string; ref?: string };
                        toolResponse?: undefined;
                    }
                    | {
                        custom?: Record<string, unknown>;
                        data?: unknown;
                        media?: undefined;
                        metadata?: Record<string, unknown>;
                        text?: undefined;
                        toolRequest?: undefined;
                        toolResponse: { name: string; output?: unknown; ref?: string };
                    }
                    | {
                        custom?: Record<string, unknown>;
                        data?: unknown;
                        media?: undefined;
                        metadata?: Record<string, unknown>;
                        text?: undefined;
                        toolRequest?: undefined;
                        toolResponse?: undefined;
                    }
                    | {
                        custom: Record<string, any>;
                        data?: unknown;
                        media?: undefined;
                        metadata?: Record<string, unknown>;
                        text?: undefined;
                        toolRequest?: undefined;
                        toolResponse?: undefined;
                    }
                )[];
                metadata?: Record<string, unknown>;
                role: "user" | "model" | "tool" | "system";
            };
            usage?: {
                cachedContentTokens?: number;
                custom?: Record<string, number>;
                inputAudioFiles?: number;
                inputCharacters?: number;
                inputImages?: number;
                inputTokens?: number;
                inputVideos?: number;
                outputAudioFiles?: number;
                outputCharacters?: number;
                outputImages?: number;
                outputTokens?: number;
                outputVideos?: number;
                thoughtsTokens?: number;
                totalTokens?: number;
            };
        }[];
        custom?: unknown;
        finishMessage?: string;
        finishReason?: | "length"
        | "stop"
        | "interrupted"
        | "blocked"
        | "unknown"
        | "other";
        latencyMs?: number;
        message?: {
            content: (
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    text: string;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media: { contentType?: string; url: string };
                    metadata?: Record<string, unknown>;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    text?: undefined;
                    toolRequest: { input?: unknown; name: string; ref?: string };
                    toolResponse?: undefined;
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse: { name: string; output?: unknown; ref?: string };
                }
                | {
                    custom?: Record<string, unknown>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
                | {
                    custom: Record<string, any>;
                    data?: unknown;
                    media?: undefined;
                    metadata?: Record<string, unknown>;
                    text?: undefined;
                    toolRequest?: undefined;
                    toolResponse?: undefined;
                }
            )[];
            metadata?: Record<string, unknown>;
            role: "user" | "model" | "tool" | "system";
        };
        raw?: unknown;
        request?: {
            candidates?: number;
            config?: any;
            docs?: {
                content: (
                    | {
                        custom?: Record<(...), (...)>;
                        data?: unknown;
                        media?: undefined;
                        metadata?: Record<(...), (...)>;
                        text: string;
                        toolRequest?: undefined;
                        toolResponse?: undefined;
                    }
                    | {
                        custom?: Record<(...), (...)>;
                        data?: unknown;
                        media: { contentType?: (...) | (...); url: string };
                        metadata?: Record<(...), (...)>;
                        text?: undefined;
                        toolRequest?: undefined;
                        toolResponse?: undefined;
                    }
                )[];
                metadata?: Record<string, any>;
            }[];
            messages: {
                content: (
                    | {
                        custom?: Record<string, unknown>;
                        data?: unknown;
                        media?: undefined;
                        metadata?: Record<string, unknown>;
                        text: string;
                        toolRequest?: undefined;
                        toolResponse?: undefined;
                    }
                    | {
                        custom?: Record<string, unknown>;
                        data?: unknown;
                        media: { contentType?: string; url: string };
                        metadata?: Record<string, unknown>;
                        text?: undefined;
                        toolRequest?: undefined;
                        toolResponse?: undefined;
                    }
                    | {
                        custom?: Record<string, unknown>;
                        data?: unknown;
                        media?: undefined;
                        metadata?: Record<string, unknown>;
                        text?: undefined;
                        toolRequest: { input?: unknown; name: string; ref?: string };
                        toolResponse?: undefined;
                    }
                    | {
                        custom?: Record<string, unknown>;
                        data?: unknown;
                        media?: undefined;
                        metadata?: Record<string, unknown>;
                        text?: undefined;
                        toolRequest?: undefined;
                        toolResponse: { name: string; output?: unknown; ref?: string };
                    }
                    | {
                        custom?: Record<string, unknown>;
                        data?: unknown;
                        media?: undefined;
                        metadata?: Record<string, unknown>;
                        text?: undefined;
                        toolRequest?: undefined;
                        toolResponse?: undefined;
                    }
                    | {
                        custom: Record<string, any>;
                        data?: unknown;
                        media?: undefined;
                        metadata?: Record<string, unknown>;
                        text?: undefined;
                        toolRequest?: undefined;
                        toolResponse?: undefined;
                    }
                )[];
                metadata?: Record<string, unknown>;
                role: "user" | "model" | "tool" | "system";
            }[];
            output?: {
                constrained?: boolean;
                contentType?: string;
                format?: string;
                schema?: Record<string, any>;
            };
            toolChoice?: "required"
            | "auto"
            | "none";
            tools?: {
                description: string;
                inputSchema?: null | Record<string, any>;
                metadata?: Record<string, any>;
                name: string;
                outputSchema?: null | Record<string, any>;
            }[];
        };
        usage?: {
            cachedContentTokens?: number;
            custom?: Record<string, number>;
            inputAudioFiles?: number;
            inputCharacters?: number;
            inputImages?: number;
            inputTokens?: number;
            inputVideos?: number;
            outputAudioFiles?: number;
            outputCharacters?: number;
            outputImages?: number;
            outputTokens?: number;
            outputVideos?: number;
            thoughtsTokens?: number;
            totalTokens?: number;
        };
    }
  • Optionaloptions: { parser?: MessageParser<O>; request?: GenerateRequest<z.ZodTypeAny> }

  Returns GenerateResponse<O>

custom

OptionalfinishMessage

finishReason

Optionalmessage

Optionalparser

Optionalrequest

usage

data

• get data(): null | O

• Returns the first detected data part of the generated message.

  Returns null | O

  The first data part detected in the candidate (if any).

interrupts

• get interrupts(): {
      custom?: Record<string, unknown>;
      data?: unknown;
      media?: undefined;
      metadata?: Record<string, unknown>;
      text?: undefined;
      toolRequest: { input?: unknown; name: string; ref?: string };
      toolResponse?: undefined;
  }[]

• Returns all tool requests annotated as interrupts found in the generated message.

  Returns {
      custom?: Record<string, unknown>;
      data?: unknown;
      media?: undefined;
      metadata?: Record<string, unknown>;
      text?: undefined;
      toolRequest: { input?: unknown; name: string; ref?: string };
      toolResponse?: undefined;
  }[]

  A list of ToolRequestParts.

media

• get media(): null | { contentType?: string; url: string }

• Returns the first detected media part in the generated message. Useful for extracting (for example) an image from a generation expected to create one.

  Returns null | { contentType?: string; url: string }

  The first detected media part in the candidate.

messages

• get messages(): {
      content: (
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              text: string;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media: { contentType?: string; url: string };
              metadata?: Record<string, unknown>;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              text?: undefined;
              toolRequest: { input?: unknown; name: string; ref?: string };
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse: { name: string; output?: unknown; ref?: string };
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom: Record<string, any>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
      )[];
      metadata?: Record<string, unknown>;
      role: "user" | "model" | "tool" | "system";
  }[]

• Returns the message history for the request by concatenating the model response to the list of messages from the request. The result of this method can be safely serialized to JSON for persistence in a database.

  Returns {
      content: (
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              text: string;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media: { contentType?: string; url: string };
              metadata?: Record<string, unknown>;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              text?: undefined;
              toolRequest: { input?: unknown; name: string; ref?: string };
              toolResponse?: undefined;
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse: { name: string; output?: unknown; ref?: string };
          }
          | {
              custom?: Record<string, unknown>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
          | {
              custom: Record<string, any>;
              data?: unknown;
              media?: undefined;
              metadata?: Record<string, unknown>;
              text?: undefined;
              toolRequest?: undefined;
              toolResponse?: undefined;
          }
      )[];
      metadata?: Record<string, unknown>;
      role: "user" | "model" | "tool" | "system";
  }[]

  A serializable list of messages compatible with generate({history}).

output

• get output(): null | O

• If the generated message contains a data part, it is returned. Otherwise, the output() method extracts the first valid JSON object or array from the text contained in the selected candidate's message and returns it.

  Returns null | O

  The structured output contained in the selected candidate.

raw

• get raw(): unknown

• Returns unknown

text

• get text(): string

• Concatenates all text parts present in the generated message with no delimiter.

  Returns string

  A string of all concatenated text parts.

toolRequests

• get toolRequests(): {
      custom?: Record<string, unknown>;
      data?: unknown;
      media?: undefined;
      metadata?: Record<string, unknown>;
      text?: undefined;
      toolRequest: { input?: unknown; name: string; ref?: string };
      toolResponse?: undefined;
  }[]

• Returns all tool request found in the generated message.

  Returns {
      custom?: Record<string, unknown>;
      data?: unknown;
      media?: undefined;
      metadata?: Record<string, unknown>;
      text?: undefined;
      toolRequest: { input?: unknown; name: string; ref?: string };
      toolResponse?: undefined;
  }[]

  Array of all tool request found in the candidate.

assertValid

• assertValid(): void

• Throws an error if the response does not contain valid output.

  Returns void

assertValidSchema

• assertValidSchema(request?: GenerateRequest<z.ZodTypeAny>): void

• Throws an error if the response does not conform to expected schema.

  Parameters

  • Optionalrequest: GenerateRequest<z.ZodTypeAny>

  Returns void

isValid

• isValid(request?: GenerateRequest<z.ZodTypeAny>): boolean

• Parameters

  • Optionalrequest: GenerateRequest<z.ZodTypeAny>

  Returns boolean

toJSON

• toJSON(): {
      custom?: unknown;
      finishMessage?: string;
      finishReason: | "length"
      | "stop"
      | "interrupted"
      | "blocked"
      | "unknown"
      | "other";
      latencyMs?: number;
      message?: {
          content: (
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  text: string;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media: { contentType?: string; url: string };
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest: { input?: unknown; name: string; ref?: string };
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse: { name: string; output?: unknown; ref?: string };
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom: Record<string, any>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
          )[];
          metadata?: Record<string, unknown>;
          role: "user" | "model" | "tool" | "system";
      };
      raw?: unknown;
      request?: {
          candidates?: number;
          config?: any;
          docs?: {
              content: (
                  | {
                      custom?: Record<(...), (...)>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<(...), (...)>;
                      text: string;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
                  | {
                      custom?: Record<(...), (...)>;
                      data?: unknown;
                      media: { contentType?: (...) | (...); url: string };
                      metadata?: Record<(...), (...)>;
                      text?: undefined;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
              )[];
              metadata?: Record<string, any>;
          }[];
          messages: {
              content: (
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text: string;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media: { contentType?: string; url: string };
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest: { input?: unknown; name: string; ref?: string };
                      toolResponse?: undefined;
                  }
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest?: undefined;
                      toolResponse: { name: string; output?: unknown; ref?: string };
                  }
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
                  | {
                      custom: Record<string, any>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
              )[];
              metadata?: Record<string, unknown>;
              role: "user" | "model" | "tool" | "system";
          }[];
          output?: {
              constrained?: boolean;
              contentType?: string;
              format?: string;
              schema?: Record<string, any>;
          };
          toolChoice?: "required"
          | "auto"
          | "none";
          tools?: {
              description: string;
              inputSchema?: null | Record<string, any>;
              metadata?: Record<string, any>;
              name: string;
              outputSchema?: null | Record<string, any>;
          }[];
      };
      usage?: {
          cachedContentTokens?: number;
          custom?: Record<string, number>;
          inputAudioFiles?: number;
          inputCharacters?: number;
          inputImages?: number;
          inputTokens?: number;
          inputVideos?: number;
          outputAudioFiles?: number;
          outputCharacters?: number;
          outputImages?: number;
          outputTokens?: number;
          outputVideos?: number;
          thoughtsTokens?: number;
          totalTokens?: number;
      };
  }

• Returns {
      custom?: unknown;
      finishMessage?: string;
      finishReason:
          | "length"
          | "stop"
          | "interrupted"
          | "blocked"
          | "unknown"
          | "other";
      latencyMs?: number;
      message?: {
          content: (
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  text: string;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media: { contentType?: string; url: string };
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest: { input?: unknown; name: string; ref?: string };
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse: { name: string; output?: unknown; ref?: string };
              }
              | {
                  custom?: Record<string, unknown>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom: Record<string, any>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<string, unknown>;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
          )[];
          metadata?: Record<string, unknown>;
          role: "user" | "model" | "tool" | "system";
      };
      raw?: unknown;
      request?: {
          candidates?: number;
          config?: any;
          docs?: {
              content: (
                  | {
                      custom?: Record<(...), (...)>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<(...), (...)>;
                      text: string;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
                  | {
                      custom?: Record<(...), (...)>;
                      data?: unknown;
                      media: { contentType?: (...) | (...); url: string };
                      metadata?: Record<(...), (...)>;
                      text?: undefined;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
              )[];
              metadata?: Record<string, any>;
          }[];
          messages: {
              content: (
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text: string;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media: { contentType?: string; url: string };
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest: { input?: unknown; name: string; ref?: string };
                      toolResponse?: undefined;
                  }
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest?: undefined;
                      toolResponse: { name: string; output?: unknown; ref?: string };
                  }
                  | {
                      custom?: Record<string, unknown>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
                  | {
                      custom: Record<string, any>;
                      data?: unknown;
                      media?: undefined;
                      metadata?: Record<string, unknown>;
                      text?: undefined;
                      toolRequest?: undefined;
                      toolResponse?: undefined;
                  }
              )[];
              metadata?: Record<string, unknown>;
              role: "user" | "model" | "tool" | "system";
          }[];
          output?: {
              constrained?: boolean;
              contentType?: string;
              format?: string;
              schema?: Record<string, any>;
          };
          toolChoice?: "required"
          | "auto"
          | "none";
          tools?: {
              description: string;
              inputSchema?: null | Record<string, any>;
              metadata?: Record<string, any>;
              name: string;
              outputSchema?: null | Record<string, any>;
          }[];
      };
      usage?: {
          cachedContentTokens?: number;
          custom?: Record<string, number>;
          inputAudioFiles?: number;
          inputCharacters?: number;
          inputImages?: number;
          inputTokens?: number;
          inputVideos?: number;
          outputAudioFiles?: number;
          outputCharacters?: number;
          outputImages?: number;
          outputTokens?: number;
          outputVideos?: number;
          thoughtsTokens?: number;
          totalTokens?: number;
      };
  }