openai-interface 0.10.0

A low-level Rust interface for 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

//! Retrieve a conversation item via
//! `GET /conversations/{conversation_id}/items/{item_id}`.
//!
//! > ![warn] This module is untested!
//! > If you encounter any issues, please report them on the repository.

use url::Url;

use crate::{
    conversations::items::ConversationItem,
    errors::OapiError,
    rest::get::{Get, GetNoStream},
};

/// Retrieves an item of a conversation by its ID.
#[derive(Debug, Clone)]
pub struct RetrieveConversationItemRequest<'a> {
    /// The ID of the conversation, e.g. `conv_...`.
    pub conversation_id: &'a str,
    /// The ID of the item to retrieve.
    pub item_id: &'a str,
}

impl Get for RetrieveConversationItemRequest<'_> {
    /// Builds the URL for the request.
    ///
    /// `base_url` should be like <https://api.openai.com/v1>
    fn build_url(&self, base_url: &str) -> Result<String, OapiError> {
        let mut url = Url::parse(base_url.trim_end_matches('/')).map_err(OapiError::UrlError)?;
        url.path_segments_mut()
            .map_err(|_| OapiError::UrlCannotBeBase(base_url.to_string()))?
            .push("conversations")
            .push(self.conversation_id)
            .push("items")
            .push(self.item_id);
        Ok(url.to_string())
    }
}

impl GetNoStream for RetrieveConversationItemRequest<'_> {
    /// Unknown item types are preserved as
    /// [`ResponseOutputItem::Other`](crate::responses::ResponseOutputItem::Other)
    /// inside the wrapped item.
    type Response = ConversationItem;
}