Type alias AIMessage

AIMessage: BaseMessage & {
    example?: boolean;
    invalid_tool_calls?: {
        args?: string;
        error?: string;
        id?: string;
        name?: string;
        type?: "invalid_tool_call";
    }[];
    tool_calls?: {
        args: {
            [x: string]: any;
        };
        id?: string;
        name: string;
        type?: "tool_call";
    }[];
    type: "ai";
    usage_metadata?: {
        input_token_details?: {
            audio?: number;
            cache_creation?: number;
            cache_read?: number;
        };
        input_tokens: number;
        output_token_details?: {
            audio?: number;
            reasoning?: number;
        };
        output_tokens: number;
        total_tokens: number;
    };
}

Type declaration

  • Optional example?: boolean
  • Optional invalid_tool_calls?: {
        args?: string;
        error?: string;
        id?: string;
        name?: string;
        type?: "invalid_tool_call";
    }[]
  • Optional tool_calls?: {
        args: {
            [x: string]: any;
        };
        id?: string;
        name: string;
        type?: "tool_call";
    }[]
  • type: "ai"
  • Optional usage_metadata?: {
        input_token_details?: {
            audio?: number;
            cache_creation?: number;
            cache_read?: number;
        };
        input_tokens: number;
        output_token_details?: {
            audio?: number;
            reasoning?: number;
        };
        output_tokens: number;
        total_tokens: number;
    }
    • Optional input_token_details?: {
          audio?: number;
          cache_creation?: number;
          cache_read?: number;
      }
      • Optional audio?: number
      • Optional cache_creation?: number
      • Optional cache_read?: number
    • input_tokens: number
    • Optional output_token_details?: {
          audio?: number;
          reasoning?: number;
      }
      • Optional audio?: number
      • Optional reasoning?: number
    • output_tokens: number
    • total_tokens: number