Struct Responses 

pub struct Responses<'client, E>
where
    E: OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static,
{ /* private fields */ }

The client for the OpenAI Responses API.

Implementations

impl<'client, E> Responses<'client, E>

where E: OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static,

pub async fn create( &self, request: CreateResponseRequest, ) -> Result<ResponseObject>

Creates a model response.

Arguments

• request: The request body for creating a response.

Errors

Returns OpenAIError if the request fails.

pub async fn retrieve(&self, response_id: &str) -> Result<ResponseObject>

Retrieves a response.

Arguments

• response_id: The ID of the response to retrieve.

Errors

Returns OpenAIError if the request fails.

pub async fn list_input_items( &self, response_id: &str, query: Option<ListQuery>, ) -> Result<ResponseItemList>

Lists input items for a response.

Arguments

• response_id: The ID of the response.
• query: Optional query parameters for listing input items.

Errors

Returns OpenAIError if the request fails.

pub async fn create_stream( &self, request: CreateResponseRequest, ) -> Result<Receiver<Result<ResponseStreamEvent>>>

Creates a model response and streams the response.

Arguments

• request: The request body for creating a response.

Errors

Returns OpenAIError if the request fails.

pub async fn delete(&self, response_id: &str) -> Result<Value>

Deletes a response.

Arguments

• response_id: The ID of the response to delete.

Errors

Returns OpenAIError if the request fails.

pub async fn update( &self, response_id: &str, update: Value, ) -> Result<ResponseObject>

👎Deprecated since 0.2.0: OpenAI API no longer supports response updates

Updates a response.

⚠️ DEPRECATED: OpenAI API no longer supports PATCH operations on responses. This method will return HTTP 405 Method Not Allowed.

Arguments

• response_id: The ID of the response to update.
• update: The update request body.

Errors

Returns OpenAIError if the request fails.

pub async fn cancel(&self, response_id: &str) -> Result<ResponseObject>

Cancels an in-progress response.

Arguments

• response_id: The ID of the response to cancel.

Errors

Returns OpenAIError if the request fails.

Trait Implementations

impl<'client, E> Clone for Responses<'client, E>

where E: OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static + Clone,

fn clone(&self) -> Responses<'client, E>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'client, E> Debug for Responses<'client, E>

where E: OpenaiEnvironment + EnvironmentInterface + Send + Sync + 'static + Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.