OpenAiMessageRole.ts

// This file was auto-generated by Fern from our API Definition.

/**
 * Roles for OpenAI messages.
 *
 * Note: The "function" role is deprecated in favor of "tool". Use "tool" for new implementations.
 * The "developer" role is required for GPT-5.x and o-series models.
 */
export const OpenAiMessageRole = {
    Assistant: "assistant",
    /**
     * @deprecated The "function" role is deprecated in favor of "tool". Use "tool" for new implementations.
     * @see https://platform.openai.com/docs/guides/function-calling
     */
    Function: "function",
    User: "user",
    System: "system",
    Tool: "tool",
    /**
     * The "developer" role is used for system-level instructions in GPT-5.x and o-series models.
     * It provides a way to set high-level instructions that take precedence over user messages.
     * @see https://platform.openai.com/docs/guides/text-generation
     */
    Developer: "developer",
} as const;
export type OpenAiMessageRole = (typeof OpenAiMessageRole)[keyof typeof OpenAiMessageRole];