logoAnt Design X

DesignDevelopmentComponentsX MarkdownX SDKPlayground
  • Introduction
  • Data Flow
    • useXChatConversation Data
      2.0.0
    • useXConversations
      2.0.0
  • Chat Provider
    • Chat Provider
      2.0.0
    • OpenAIChatProvider
      2.0.0
    • DeepSeekChatProvider
      2.0.0
    • Custom Chat Provider
      2.0.0
  • Utilities
    • XRequestRequest
      2.0.0
    • XStreamStream
      2.0.0

OpenAIChatProvider

Importimport { OpenAIChatProvider } from "@ant-design/x";
Sourcecomponents/open-ai-chat-provider
Docs
Edit this page
Versionsupported since 2.0.0

OpenAIChatProvider is a Chat Provider compatible with the OpenAI interface. It automatically converts request parameters and response data into the OpenAI API format.

XModelParams defines the request parameter types for OpenAIChatProvider, XModelResponse defines the response data types, and XModelMessage defines the complete message data types. These types can be directly used in the generics ChatMessage, Input, and Output of useXChat.

Usage Example

Basic

OpenAIChatProvider works with useXChat for data operations.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code
With Components

Use OpenAIChatProvider to integrate models with OpenAI data format, enabling message sending, data processing, and message termination.

CodeSandbox Icon
codepen icon
External Link Icon
expand codeexpand code

Messages Data

Is Requesting：false
Data Length：0
Data Details：
[]

Data Operations

Send Request
Current status: No messages yet, please enter a question and send