Struct Chat 

pub struct Chat<'c, C: Config> { /* private fields */ }

Given a list of messages comprising a conversation, the model will return a response.

Related guide: Chat Completions

Implementations

impl<'c, C: Config> Chat<'c, C>

pub fn new(client: &'c Client<C>) -> Self

pub async fn create( &self, request: CreateChatCompletionRequest, ) -> Result<CreateChatCompletionResponse, OpenAIError>

Creates a model response for the given chat conversation.

Returns a chat completion object, or a streamed sequence of chat completion chunk objects if the request is streamed.

Learn more in the text generation, vision, and audio guides.

Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, refer to the reasoning guide.

byot: You must ensure “stream: false” in serialized request Creates a model response for the given chat conversation.

Returns a chat completion object, or a streamed sequence of chat completion chunk objects if the request is streamed.

Learn more in the text generation, vision, and audio guides.

Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, refer to the reasoning guide.

byot: You must ensure “stream: false” in serialized request

pub async fn create_byot<T0: Serialize, R: DeserializeOwned>( &self, request: T0, ) -> Result<R, OpenAIError>

Creates a model response for the given chat conversation.

Returns a chat completion object, or a streamed sequence of chat completion chunk objects if the request is streamed.

Learn more in the text generation, vision, and audio guides.

Parameter support can differ depending on the model used to generate the response, particularly for newer reasoning models. Parameters that are only supported for reasoning models are noted below. For the current state of unsupported parameters in reasoning models, refer to the reasoning guide.

byot: You must ensure “stream: false” in serialized request

pub async fn create_stream( &self, request: CreateChatCompletionRequest, ) -> Result<ChatCompletionResponseStream, OpenAIError>

Creates a completion for the chat message.

If set to true, the model response data will be streamed to the client as it is generated using server-sent events.

See the Streaming section for more information, along with the streaming responses guide for more information on how to handle the streaming events.

ChatCompletionResponseStream is a parsed SSE stream until a [DONE] is received from server.

byot: You must ensure “stream: true” in serialized request Creates a completion for the chat message.

If set to true, the model response data will be streamed to the client as it is generated using server-sent events.

See the Streaming section for more information, along with the streaming responses guide for more information on how to handle the streaming events.

ChatCompletionResponseStream is a parsed SSE stream until a [DONE] is received from server.

byot: You must ensure “stream: true” in serialized request

pub async fn create_stream_byot<T0: Serialize, R>( &self, request: T0, ) -> Result<Pin<Box<dyn Stream<Item = Result<R, OpenAIError>> + Send>>, OpenAIError>

where R: Send + 'static + DeserializeOwned,

Creates a completion for the chat message.

If set to true, the model response data will be streamed to the client as it is generated using server-sent events.

See the Streaming section for more information, along with the streaming responses guide for more information on how to handle the streaming events.

ChatCompletionResponseStream is a parsed SSE stream until a [DONE] is received from server.

byot: You must ensure “stream: true” in serialized request

pub async fn list<Q>( &self, query: &Q, ) -> Result<ChatCompletionList, OpenAIError>

where Q: Serialize + ?Sized,

List stored Chat Completions. Only Chat Completions that have been stored with the store parameter set to true will be returned. List stored Chat Completions. Only Chat Completions that have been stored with the store parameter set to true will be returned.

pub async fn list_byot<T0: Serialize, R: DeserializeOwned>( &self, query: T0, ) -> Result<R, OpenAIError>

List stored Chat Completions. Only Chat Completions that have been stored with the store parameter set to true will be returned.

pub async fn retrieve( &self, completion_id: &str, ) -> Result<CreateChatCompletionResponse, OpenAIError>

Get a stored chat completion. Only Chat Completions that have been created with the store parameter set to true will be returned. Get a stored chat completion. Only Chat Completions that have been created with the store parameter set to true will be returned.

pub async fn retrieve_byot<T0: Display, R: DeserializeOwned>( &self, completion_id: T0, ) -> Result<R, OpenAIError>

Get a stored chat completion. Only Chat Completions that have been created with the store parameter set to true will be returned.

pub async fn update( &self, completion_id: &str, request: UpdateChatCompletionRequest, ) -> Result<CreateChatCompletionResponse, OpenAIError>

Modify a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be modified. Currently, the only supported modification is to update the metadata field. Modify a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be modified. Currently, the only supported modification is to update the metadata field.

pub async fn update_byot<T0: Display, T1: Serialize, R: DeserializeOwned>( &self, completion_id: T0, request: T1, ) -> Result<R, OpenAIError>

Modify a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be modified. Currently, the only supported modification is to update the metadata field.

pub async fn delete( &self, completion_id: &str, ) -> Result<ChatCompletionDeleted, OpenAIError>

Delete a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be deleted. Delete a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be deleted.

pub async fn delete_byot<T0: Display, R: DeserializeOwned>( &self, completion_id: T0, ) -> Result<R, OpenAIError>

Delete a stored chat completion. Only Chat Completions that have been created with the store parameter set to true can be deleted.

pub async fn messages<Q>( &self, completion_id: &str, query: &Q, ) -> Result<ChatCompletionMessageList, OpenAIError>

where Q: Serialize + ?Sized,

Get a list of messages for the specified chat completion. Get a list of messages for the specified chat completion.

pub async fn messages_byot<T0: Display, T1: Serialize, R: DeserializeOwned>( &self, completion_id: T0, query: T1, ) -> Result<R, OpenAIError>

Get a list of messages for the specified chat completion.