rig-core 0.35.0

An opinionated library for building LLM powered applications.
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

#[cfg(feature = "audio")]
mod audio {
    #[allow(deprecated)]
    use crate::audio_generation::AudioGenerationModelDyn;
    use crate::audio_generation::{
        AudioGenerationError, AudioGenerationModel, AudioGenerationRequest, AudioGenerationResponse,
    };
    use crate::client::Nothing;
    use std::future::Future;
    use std::sync::Arc;

    /// A provider client with audio generation capabilities.
    /// Clone is required for conversions between client types.
    pub trait AudioGenerationClient {
        /// The AudioGenerationModel used by the Client
        type AudioGenerationModel: AudioGenerationModel<Client = Self>;

        /// Create an audio generation model with the given name.
        ///
        /// # Example
        /// ```
        /// use rig::providers::openai::{Client, self};
        ///
        /// // Initialize the OpenAI client
        /// let openai = Client::new("your-open-ai-api-key");
        ///
        /// let tts = openai.audio_generation_model(openai::TTS_1);
        /// ```
        fn audio_generation_model(&self, model: impl Into<String>) -> Self::AudioGenerationModel {
            Self::AudioGenerationModel::make(self, model)
        }
    }

    #[allow(deprecated)]
    #[deprecated(
        since = "0.25.0",
        note = "`DynClientBuilder` and related features have been deprecated and will be removed in a future release. In this case, use `ImageGenerationModel` instead."
    )]
    pub trait AudioGenerationClientDyn {
        fn audio_generation_model<'a>(&self, model: &str) -> Box<dyn AudioGenerationModelDyn + 'a>;
    }

    #[allow(deprecated)]
    impl<T, M> AudioGenerationClientDyn for T
    where
        T: AudioGenerationClient<AudioGenerationModel = M>,
        M: AudioGenerationModel + 'static,
    {
        fn audio_generation_model<'a>(&self, model: &str) -> Box<dyn AudioGenerationModelDyn + 'a> {
            Box::new(self.audio_generation_model(model))
        }
    }

    #[deprecated(
        since = "0.25.0",
        note = "`DynClientBuilder` and related features have been deprecated and will be removed in a future release. In this case, use `ImageGenerationModel` instead."
    )]
    /// Wraps a AudioGenerationModel in a dyn-compatible way for AudioGenerationRequestBuilder.
    #[derive(Clone)]
    pub struct AudioGenerationModelHandle<'a> {
        #[allow(deprecated)]
        pub(crate) inner: Arc<dyn AudioGenerationModelDyn + 'a>,
    }

    #[allow(deprecated)]
    impl AudioGenerationModel for AudioGenerationModelHandle<'_> {
        type Response = ();
        type Client = Nothing;

        /// **PANICS**: DynClientBuilder and related features (like this model handle) are being phased out,
        /// during this transition period some methods will panic when called
        fn make(_: &Self::Client, _: impl Into<String>) -> Self {
            panic!(
                "Function should be unreachable as Self can only be constructed from another 'AudioGenerationModel'"
            )
        }

        fn audio_generation(
            &self,
            request: AudioGenerationRequest,
        ) -> impl Future<
            Output = Result<AudioGenerationResponse<Self::Response>, AudioGenerationError>,
        > + Send {
            self.inner.audio_generation(request)
        }
    }
}

#[cfg(feature = "audio")]
pub use audio::*;