lm-studio-api-extended 0.1.3

Unofficial Rust client for LM Studio with text embedding support.
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

/// EmbeddingRequest defines the structure for an 
/// embedding API request.
/// It specifies the model, input texts, and optional 
/// encoding format for the request.
use crate::{prelude::*, EmbeddingInput};
use super::{ EmbeddingModel };


#[derive(Debug, Clone, Serialize)]
pub struct EmbeddingRequest {
    /// Model to use for embedding. Determines which model 
    /// will process the input.
    pub model: EmbeddingModel,

    /// Input text(s) to embed. Can be a batch of texts for efficiency.
    pub input: EmbeddingInput,

    /// Optional encoding format (e.g., "float"). Controls the output format 
    /// of the embedding vector.
    #[serde(skip_serializing_if = "Option::is_none")]
    pub encoding_format: Option<String>,
}

/// Provides a default EmbeddingRequest with empty input and default 
/// encoding format.
/// This is useful for initializing requests before populating fields.
impl ::std::default::Default for EmbeddingRequest {
    fn default() -> Self {
        Self {
            model: EmbeddingModel::Custom("".into()),
            input: EmbeddingInput::from("Rust is magic."),
            encoding_format: Some("float".to_string())
        }
    }
}

impl EmbeddingRequest {
    pub fn make_sendable(&self, input: EmbeddingInput) -> Vec<String> {
        match input {
            EmbeddingInput::Sentence(s) => vec![s],
            EmbeddingInput::Sentences(ss) => ss
        }
    }
}