Struct EmbedRequest 

pub struct EmbedRequest { /* private fields */ }

Validated text-embedding request.

Examples

use providers_kit::embedding::EmbedRequest;
let request = EmbedRequest::new(vec!["search document".into()])?
    .with_dimensions(std::num::NonZeroU32::new(128).unwrap());
assert_eq!(request.inputs(), &["search document"]);
assert_eq!(request.dimensions().unwrap().get(), 128);

Implementations

impl EmbedRequest

pub fn new(inputs: Vec<String>) -> Result<Self, KitError>

Creates a request containing non-empty text inputs.

Errors

Returns an input error if the input list is empty or any text is whitespace-only.

Examples

use providers_kit::embedding::EmbedRequest;
let request = EmbedRequest::new(vec!["search document".into()])?
    .with_dimensions(std::num::NonZeroU32::new(128).unwrap());
assert_eq!(request.inputs(), &["search document"]);
assert_eq!(request.dimensions().unwrap().get(), 128);

pub fn with_dimensions(self, dimensions: NonZeroU32) -> Self

Requests a non-zero output dimensionality.

The Model is already selected; dimensionality support is checked by the model operation.

Examples

use providers_kit::embedding::EmbedRequest;
let request = EmbedRequest::new(vec!["search document".into()])?
    .with_dimensions(std::num::NonZeroU32::new(128).unwrap());
assert_eq!(request.inputs(), &["search document"]);
assert_eq!(request.dimensions().unwrap().get(), 128);

pub fn inputs(&self) -> &[String]

Returns text inputs in caller order.

Examples

use providers_kit::embedding::EmbedRequest;
let request = EmbedRequest::new(vec!["search document".into()])?
    .with_dimensions(std::num::NonZeroU32::new(128).unwrap());
assert_eq!(request.inputs(), &["search document"]);
assert_eq!(request.dimensions().unwrap().get(), 128);

pub const fn dimensions(&self) -> Option<NonZeroU32>

Returns the requested output dimensionality.

Examples

use providers_kit::embedding::EmbedRequest;
let request = EmbedRequest::new(vec!["search document".into()])?
    .with_dimensions(std::num::NonZeroU32::new(128).unwrap());
assert_eq!(request.inputs(), &["search document"]);
assert_eq!(request.dimensions().unwrap().get(), 128);

Trait Implementations

impl Clone for EmbedRequest

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for EmbedRequest

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EmbedRequest

fn deserialize<D>(deserializer: D) -> Result<Self, D::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EmbedRequest

impl PartialEq for EmbedRequest

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for EmbedRequest

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for EmbedRequest