openai_interface/batches/
retrieve.rs

1//! Retrieve a batch job via `GET /batches/{batch_id}`.
2//!
3//! > ![warn] This module is untested!
4//! > If you encounter any issues, please report them on the repository.
5
6use url::Url;
7
8use crate::{
9    batches::Batch,
10    errors::OapiError,
11    rest::get::{Get, GetNoStream},
12};
13
14/// Retrieves a batch by its ID.
15#[derive(Debug, Clone)]
16pub struct RetrieveBatchRequest<'a> {
17    /// The ID of the batch to retrieve, e.g. `batch_...`.
18    pub batch_id: &'a str,
19}
20
21impl Get for RetrieveBatchRequest<'_> {
22    /// Builds the URL for the request.
23    ///
24    /// `base_url` should be like <https://api.openai.com/v1>
25    fn build_url(&self, base_url: &str) -> Result<String, OapiError> {
26        let mut url = Url::parse(base_url.trim_end_matches('/')).map_err(OapiError::UrlError)?;
27        url.path_segments_mut()
28            .map_err(|_| OapiError::UrlCannotBeBase(base_url.to_string()))?
29            .push("batches")
30            .push(self.batch_id);
31        Ok(url.to_string())
32    }
33}
34
35impl GetNoStream for RetrieveBatchRequest<'_> {
36    type Response = Batch;
37}
openai_interface/batches/retrieve.rs

openai_interface/batches/
retrieve.rs
