async-openai 0.34.0

Rust library for OpenAI
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

use crate::{
    config::Config,
    error::OpenAIError,
    types::assistants::{ListRunStepsResponse, RunStepObject},
    Client, RequestOptions,
};

/// Represents a step in execution of a run.
#[deprecated(
    note = "Assistants API is deprecated and will be removed in August 2026. Use the Responses API."
)]
pub struct Steps<'c, C: Config> {
    pub thread_id: String,
    pub run_id: String,
    client: &'c Client<C>,
    pub(crate) request_options: RequestOptions,
}

impl<'c, C: Config> Steps<'c, C> {
    pub fn new(client: &'c Client<C>, thread_id: &str, run_id: &str) -> Self {
        Self {
            client,
            thread_id: thread_id.into(),
            run_id: run_id.into(),
            request_options: RequestOptions::new(),
        }
    }

    /// Retrieves a run step.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn retrieve(&self, step_id: &str) -> Result<RunStepObject, OpenAIError> {
        self.client
            .get(
                &format!(
                    "/threads/{}/runs/{}/steps/{step_id}",
                    self.thread_id, self.run_id
                ),
                &self.request_options,
            )
            .await
    }

    /// Returns a list of run steps belonging to a run.
    #[crate::byot(R = serde::de::DeserializeOwned)]
    pub async fn list(&self) -> Result<ListRunStepsResponse, OpenAIError> {
        self.client
            .get(
                &format!("/threads/{}/runs/{}/steps", self.thread_id, self.run_id),
                &self.request_options,
            )
            .await
    }
}