openai_dive 1.4.3

OpenAI Dive is an unofficial async Rust library that allows you to interact with the OpenAI API.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

use crate::v1::api::Client;
use crate::v1::error::APIError;
use crate::v1::helpers::format_response;
use crate::v1::resources::response::request::ResponseParameters;
use crate::v1::resources::response::response::ResponseObject;
#[cfg(feature = "stream")]
use crate::v1::resources::response::shared::ResponseStream;
use crate::v1::resources::shared::DeletedObject;

pub struct Responses<'a> {
    pub client: &'a Client,
}

impl Client {
    /// OpenAI's most advanced interface for generating model responses. Supports text and image inputs, and text outputs.
    pub fn responses(&self) -> Responses<'_> {
        Responses { client: self }
    }
}

impl Responses<'_> {
    /// Creates a model response.
    pub async fn create(&self, parameters: ResponseParameters) -> Result<ResponseObject, APIError> {
        let response = self.client.post("/responses", &parameters, None).await?;

        let response: ResponseObject = format_response(response.data)?;

        Ok(response)
    }

    /// Retrieves a model response with the given ID.
    pub async fn retrieve(&self, response_id: &str) -> Result<ResponseObject, APIError> {
        let response = self
            .client
            .get(&format!("/responses/{response_id}"))
            .await?;

        let response: ResponseObject = format_response(response)?;

        Ok(response)
    }

    /// Deletes a model response with the given ID.
    pub async fn delete(&self, response_id: &str) -> Result<DeletedObject, APIError> {
        let response = self
            .client
            .delete(&format!("/responses/{response_id}"))
            .await?;

        let response: DeletedObject = format_response(response)?;

        Ok(response)
    }

    #[cfg(feature = "stream")]
    /// Creates a model response.
    pub async fn create_stream(
        &self,
        parameters: ResponseParameters,
    ) -> Result<ResponseStream, APIError> {
        let mut stream_parameters = ResponseParameters { ..parameters };
        stream_parameters.stream = Some(true);

        Ok(self
            .client
            .post_stream("/responses", &stream_parameters, None)
            .await)
    }
}