ferrin-spec 0.2.0

Ferrin provider specification: model traits, prompt and content types, stream parts, shared errors.
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

//! Object-safe transcription model.

use super::BoxFuture;
use super::ModelRef;
use super::model_ref::ref_conversions;
use crate::error::ProviderError;
use crate::shared::ModelId;
use crate::shared::ProviderId;
use crate::transcription_model::TranscriptionModel;
use crate::transcription_model::TranscriptionOptions;
use crate::transcription_model::TranscriptionResult;
use crate::transcription_model::TranscriptionStreamOptions;
use crate::transcription_model::TranscriptionStreamResult;

/// Object-safe counterpart of [`TranscriptionModel`].
pub trait DynTranscriptionModel: Send + Sync + 'static {
    /// See [`TranscriptionModel::provider`].
    fn provider(&self) -> &ProviderId;
    /// See [`TranscriptionModel::model_id`].
    fn model_id(&self) -> &ModelId;
    /// See [`TranscriptionModel::do_generate`].
    fn do_generate(
        &self,
        options: TranscriptionOptions,
    ) -> BoxFuture<'_, Result<TranscriptionResult, ProviderError>>;
    /// See [`TranscriptionModel::supports_stream`].
    fn supports_stream(&self) -> bool;
    /// See [`TranscriptionModel::do_stream`].
    fn do_stream(
        &self,
        options: TranscriptionStreamOptions,
    ) -> BoxFuture<'_, Result<TranscriptionStreamResult, ProviderError>>;
}

impl<T: TranscriptionModel> DynTranscriptionModel for T {
    fn provider(&self) -> &ProviderId {
        TranscriptionModel::provider(self)
    }

    fn model_id(&self) -> &ModelId {
        TranscriptionModel::model_id(self)
    }

    fn do_generate(
        &self,
        options: TranscriptionOptions,
    ) -> BoxFuture<'_, Result<TranscriptionResult, ProviderError>> {
        Box::pin(TranscriptionModel::do_generate(self, options))
    }

    fn supports_stream(&self) -> bool {
        TranscriptionModel::supports_stream(self)
    }

    fn do_stream(
        &self,
        options: TranscriptionStreamOptions,
    ) -> BoxFuture<'_, Result<TranscriptionStreamResult, ProviderError>> {
        Box::pin(TranscriptionModel::do_stream(self, options))
    }
}

/// Shared reference to a transcription model (or an unresolved model id).
pub type TranscriptionModelRef = ModelRef<dyn DynTranscriptionModel>;

ref_conversions!(
    TranscriptionModelRef,
    TranscriptionModel,
    DynTranscriptionModel
);