Type alias OpenAIChatRequest

OpenAIChatRequest: {
    frequency_penalty?: number;
    function_call?: "none" | "auto" | {
        name: string;
    };
    logit_bias?: Map<string, number>;
    max_tokens: number;
    messages: ({
        content: string;
        role: "system";
    } | {
        content: string;
        name?: string;
        role: "user";
    } | {
        content: string | null;
        name?: string;
        role: "assistant";
        tool_calls?: {
            function: {
                arguments?: string;
                name: string;
            };
            type: "function";
        }[];
    } | {
        content: string;
        role: "tool";
        tool_call_id: string;
    })[];
    model: string;
    n?: number;
    organization?: string;
    presence_penalty?: number;
    response_format?: {
        type: string;
    };
    stop?: readonly string[];
    stream?: boolean;
    temperature: number;
    tool_choice?: "none" | "auto" | {
        function: {
            name: string;
        };
        type: "function";
    };
    tools?: {
        function: {
            description: string;
            name: string;
            parameters?: object;
        };
        type: "function";
    }[];
    top_p: number;
    user?: string;
}

Type declaration

  • Optional frequency_penalty?: number
  • Optional function_call?: "none" | "auto" | {
        name: string;
    }
  • Optional logit_bias?: Map<string, number>
  • max_tokens: number
  • messages: ({
        content: string;
        role: "system";
    } | {
        content: string;
        name?: string;
        role: "user";
    } | {
        content: string | null;
        name?: string;
        role: "assistant";
        tool_calls?: {
            function: {
                arguments?: string;
                name: string;
            };
            type: "function";
        }[];
    } | {
        content: string;
        role: "tool";
        tool_call_id: string;
    })[]
  • model: string
  • Optional n?: number
  • Optional organization?: string
  • Optional presence_penalty?: number
  • Optional response_format?: {
        type: string;
    }
    • type: string
  • Optional stop?: readonly string[]
  • Optional stream?: boolean
  • temperature: number
  • Optional tool_choice?: "none" | "auto" | {
        function: {
            name: string;
        };
        type: "function";
    }
  • Optional tools?: {
        function: {
            description: string;
            name: string;
            parameters?: object;
        };
        type: "function";
    }[]
  • top_p: number
  • Optional user?: string

Settings

Member Visibility

Theme