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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149

use crate::{
    config::Config,
    error::OpenAIError,
    types::videos::{
        CreateVideoCharacterRequest, CreateVideoEditRequest, CreateVideoExtendRequest,
        CreateVideoRequest, DeletedVideoResource, RemixVideoRequest, VideoCharacterResource,
        VideoListResource, VideoResource,
    },
    Client, RequestOptions,
};
use bytes::Bytes;

/// Video generation with Sora
/// Related guide: [Video generation](https://platform.openai.com/docs/guides/video-generation)
pub struct Videos<'c, C: Config> {
    client: &'c Client<C>,
    pub(crate) request_options: RequestOptions,
}

impl<'c, C: Config> Videos<'c, C> {
    pub fn new(client: &'c Client<C>) -> Self {
        Self {
            client,
            request_options: RequestOptions::new(),
        }
    }

    /// Create a video
    #[crate::byot(
        T0 = Clone,
        R = serde::de::DeserializeOwned,
        where_clause =  "reqwest::multipart::Form: crate::traits::AsyncTryFrom<T0, Error = OpenAIError>",
    )]
    pub async fn create(&self, request: CreateVideoRequest) -> Result<VideoResource, OpenAIError> {
        self.client
            .post_form("/videos", request, &self.request_options)
            .await
    }

    /// Create a video remix
    #[crate::byot(T0 = std::fmt::Display, T1 = serde::Serialize, R = serde::de::DeserializeOwned)]
    pub async fn remix(
        &self,
        video_id: &str,
        request: RemixVideoRequest,
    ) -> Result<VideoResource, OpenAIError> {
        self.client
            .post(
                &format!("/videos/{video_id}/remix"),
                request,
                &self.request_options,
            )
            .await
    }

    /// Create a character from an uploaded video.
    #[crate::byot(
        T0 = Clone,
        R = serde::de::DeserializeOwned,
        where_clause = "reqwest::multipart::Form: crate::traits::AsyncTryFrom<T0, Error = OpenAIError>",
    )]
    pub async fn create_character(
        &self,
        request: CreateVideoCharacterRequest,
    ) -> Result<VideoCharacterResource, OpenAIError> {
        self.client
            .post_form("/videos/characters", request, &self.request_options)
            .await
    }

    /// Fetch a character by its ID.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn get_character(
        &self,
        character_id: &str,
    ) -> Result<VideoCharacterResource, OpenAIError> {
        self.client
            .get(
                &format!("/videos/characters/{character_id}"),
                &self.request_options,
            )
            .await
    }

    /// Create a new video generation job by editing a source video.
    #[crate::byot(
        T0 = Clone,
        R = serde::de::DeserializeOwned,
        where_clause = "reqwest::multipart::Form: crate::traits::AsyncTryFrom<T0, Error = OpenAIError>",
    )]
    pub async fn edit(
        &self,
        request: CreateVideoEditRequest,
    ) -> Result<VideoResource, OpenAIError> {
        self.client
            .post_form("/videos/edits", request, &self.request_options)
            .await
    }

    /// Create an extension of a completed video.
    #[crate::byot(
        T0 = Clone,
        R = serde::de::DeserializeOwned,
        where_clause = "reqwest::multipart::Form: crate::traits::AsyncTryFrom<T0, Error = OpenAIError>",
    )]
    pub async fn extend(
        &self,
        request: CreateVideoExtendRequest,
    ) -> Result<VideoResource, OpenAIError> {
        self.client
            .post_form("/videos/extensions", request, &self.request_options)
            .await
    }

    /// Retrieves a video by its ID.
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn retrieve(&self, video_id: &str) -> Result<VideoResource, OpenAIError> {
        self.client
            .get(&format!("/videos/{}", video_id), &self.request_options)
            .await
    }

    /// Delete a Video
    #[crate::byot(T0 = std::fmt::Display, R = serde::de::DeserializeOwned)]
    pub async fn delete(&self, video_id: &str) -> Result<DeletedVideoResource, OpenAIError> {
        self.client
            .delete(&format!("/videos/{}", video_id), &self.request_options)
            .await
    }

    /// List Videos
    #[crate::byot(R = serde::de::DeserializeOwned)]
    pub async fn list(&self) -> Result<VideoListResource, OpenAIError> {
        self.client.get("/videos", &self.request_options).await
    }

    /// Download video content.
    /// Variant can be provided as query parameter
    pub async fn download_content(&self, video_id: &str) -> Result<Bytes, OpenAIError> {
        let (bytes, _headers) = self
            .client
            .get_raw(
                &format!("/videos/{video_id}/content"),
                &self.request_options,
            )
            .await?;
        Ok(bytes)
    }
}