generative-ts

Interface OpenAiChatResponse

interface OpenAiChatResponse {
    choices: {
        finish_reason: string;
        index: number;
        logprobs: any;
        message: {
            content: string;
            role: string;
        } & {
            function_call?: {
                arguments: string;
                name: string;
            };
            tool_calls?: {
                function: {
                    arguments: string;
                    name: string;
                };
                id: string;
                type: string;
            }[];
        };
    }[];
    created: number;
    id: string;
    model: string;
    object: string;
    system_fingerprint?: string;
    usage?: {
        completion_tokens: number;
        prompt_tokens: number;
        total_tokens: number;
    };
}

Hierarchy

  • TypeOf<typeof OpenAiChatResponseCodec>
    • OpenAiChatResponse

Properties

choices created id model object system_fingerprint? usage?

Properties

choices

choices: {
    finish_reason: string;
    index: number;
    logprobs: any;
    message: {
        content: string;
        role: string;
    } & {
        function_call?: {
            arguments: string;
            name: string;
        };
        tool_calls?: {
            function: {
                arguments: string;
                name: string;
            };
            id: string;
            type: string;
        }[];
    };
}[]

Type declaration

  • finish_reason: string
  • index: number
  • logprobs: any
  • message: {
        content: string;
        role: string;
    } & {
        function_call?: {
            arguments: string;
            name: string;
        };
        tool_calls?: {
            function: {
                arguments: string;
                name: string;
            };
            id: string;
            type: string;
        }[];
    }

created

created: number

id

id: string

model

model: string

object

object: string

Optional system_fingerprint

system_fingerprint?: string

Optional usage

usage?: {
    completion_tokens: number;
    prompt_tokens: number;
    total_tokens: number;
}

Type declaration

  • completion_tokens: number
  • prompt_tokens: number
  • total_tokens: number