openai-interface 0.13.0

A low-level Rust interface for the OpenAI API
Documentation
//! Add items to a conversation via
//! `POST /conversations/{conversation_id}/items`.
//!
//! > ![warn] This module is untested!
//! > If you encounter any issues, please report them on the repository.

use serde::Serialize;
use url::Url;

use crate::{
    conversations::items::ListConversationItemsResponse,
    errors::OapiError,
    rest::post::{Post, PostNoStream},
};

/// Adds items to a conversation.
#[derive(Debug, Clone, Serialize)]
pub struct CreateConversationItemsRequest<'a> {
    /// The ID of the conversation, e.g. `conv_...`.
    #[serde(skip)]
    pub conversation_id: &'a str,
    /// The items to add, as raw JSON (Responses-API input item
    /// shapes).
    pub items: Vec<serde_json::Value>,
    /// Additional JSON properties flattened into the request body, for
    /// fields not covered by the typed struct.
    #[serde(flatten, default, skip_serializing_if = "Option::is_none")]
    pub extra_body_map: Option<serde_json::Map<String, serde_json::Value>>,
}

impl Post for CreateConversationItemsRequest<'_> {
    fn is_streaming(&self) -> bool {
        false
    }

    /// 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");
        Ok(url.to_string())
    }
}

impl PostNoStream for CreateConversationItemsRequest<'_> {
    type Response = ListConversationItemsResponse;
}