Type Alias GenerateResponseData

Type Declaration

• Optionalcandidates?: {
      custom?: unknown;
      finishMessage?: string;
      finishReason:
          | "length"
          | "stop"
          | "other"
          | "unknown"
          | "interrupted"
          | "blocked"
          | "aborted";
      index: number;
      message: {
          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?: (...) | (...) } & {
                      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";
      };
      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;
      };
  }[]

• Optionalcustom?: unknown

• OptionalfinishMessage?: string

• OptionalfinishReason?: "length" | "stop" | "other" | "unknown" | "interrupted" | "blocked" | "aborted"

• OptionallatencyMs?: number

• Optionalmessage?: {
      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";
  }

• Optionaloperation?: {
      action?: string;
      done?: boolean;
      error?: z.objectOutputType<
          { message: z.ZodString },
          z.ZodTypeAny,
          "passthrough",
      >;
      id: string;
      metadata?: Record<string, any>;
      output?: any;
  }

• Optionalraw?: unknown

• Optionalrequest?: {
      candidates?: number;
      config?: any;
      docs?: {
          content: (
              | {
                  custom?: Record<(...), (...)>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<(...), (...)>;
                  reasoning?: undefined;
                  resource?: undefined;
                  text: string;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<(...), (...)>;
                  data?: unknown;
                  media: { contentType?: (...) | (...); url: string };
                  metadata?: Record<(...), (...)>;
                  reasoning?: undefined;
                  resource?: undefined;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<(...), (...)>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<(...), (...)>;
                  reasoning?: undefined;
                  resource?: undefined;
                  text?: undefined;
                  toolRequest: {
                      input?: unknown;
                      name: string;
                      partial?: (...) | (...) | (...);
                      ref?: (...) | (...);
                  };
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<(...), (...)>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<(...), (...)>;
                  reasoning?: undefined;
                  resource?: undefined;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse: { name: ...; output?: ...; ref?: ... } & { content?: ... };
              }
              | {
                  custom?: Record<(...), (...)>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<(...), (...)>;
                  reasoning?: undefined;
                  resource?: undefined;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom: Record<string, any>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<(...), (...)>;
                  reasoning?: undefined;
                  resource?: undefined;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<(...), (...)>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<(...), (...)>;
                  reasoning: string;
                  resource?: undefined;
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
              | {
                  custom?: Record<(...), (...)>;
                  data?: unknown;
                  media?: undefined;
                  metadata?: Record<(...), (...)>;
                  reasoning?: undefined;
                  resource: { uri: string };
                  text?: undefined;
                  toolRequest?: undefined;
                  toolResponse?: undefined;
              }
          )[];
          metadata?: Record<string, any>;
      }[];
      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?: (...) | (...) } & {
                      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";
      }[];
      output?: {
          constrained?: boolean;
          contentType?: string;
          format?: string;
          schema?: Record<string, any>;
      };
      toolChoice?: "required"
      | "auto"
      | "none";
      tools?: {
          description: string;
          inputSchema?: Record<string, any> | null;
          metadata?: Record<string, any>;
          name: string;
          outputSchema?: Record<string, any> | null;
      }[];
  }

• Optionalusage?: {
      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;
  }