Struct EmbeddingsParamBuilder

pub struct EmbeddingsParamBuilder { /* private fields */ }

Builder for EmbeddingsParam.

Implementations

impl EmbeddingsParamBuilder

pub fn model<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

调用模型名称，可以选择text-embedding-v1，text-embedding-v2或者text-embedding-v3

Examples found in repository

examples/text-embedding.rs (line 12)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let input = EmbeddingsParamBuilder::default()
        .model("text-embedding-v3")
        .input(
            EmbeddingsInputBuilder::default()
                .texts(vec![
                    "风急天高猿啸哀".into(),
                    "渚清沙白鸟飞回".into(), 
                    "无边落木萧萧下".into(), 
                    "不尽长江滚滚来".into()
                ])
                .build()?,
        )
        .parameters(
            EmbeddingsParametersBuilder::default()
                .dimension(1024)
                .build()?,
        )
        .build()?;
    let output = client.text_embeddings().call(input).await?;

    dbg!(output);

    Ok(())
}

pub fn input(&mut self, value: EmbeddingsInput) -> &mut Self

Examples found in repository

examples/text-embedding.rs (lines 13-22)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let input = EmbeddingsParamBuilder::default()
        .model("text-embedding-v3")
        .input(
            EmbeddingsInputBuilder::default()
                .texts(vec![
                    "风急天高猿啸哀".into(),
                    "渚清沙白鸟飞回".into(), 
                    "无边落木萧萧下".into(), 
                    "不尽长江滚滚来".into()
                ])
                .build()?,
        )
        .parameters(
            EmbeddingsParametersBuilder::default()
                .dimension(1024)
                .build()?,
        )
        .build()?;
    let output = client.text_embeddings().call(input).await?;

    dbg!(output);

    Ok(())
}

pub fn parameters<VALUE: Into<EmbeddingsParameters>>( &mut self, value: VALUE, ) -> &mut Self

Examples found in repository

examples/text-embedding.rs (lines 23-27)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let input = EmbeddingsParamBuilder::default()
        .model("text-embedding-v3")
        .input(
            EmbeddingsInputBuilder::default()
                .texts(vec![
                    "风急天高猿啸哀".into(),
                    "渚清沙白鸟飞回".into(), 
                    "无边落木萧萧下".into(), 
                    "不尽长江滚滚来".into()
                ])
                .build()?,
        )
        .parameters(
            EmbeddingsParametersBuilder::default()
                .dimension(1024)
                .build()?,
        )
        .build()?;
    let output = client.text_embeddings().call(input).await?;

    dbg!(output);

    Ok(())
}

pub fn text_type<VALUE: Into<String>>(&mut self, value: VALUE) -> &mut Self

文本转换为向量后可以应用于检索、聚类、分类等下游任务， 对检索这类非对称任务为了达到更好的检索效果建议区分查询文本（query）和底库文本（document）类型, 聚类、分类等对称任务可以不用特殊指定，采用系统默认值document即可。

pub fn build(&self) -> Result<EmbeddingsParam, EmbeddingsParamBuilderError>

Builds a new EmbeddingsParam.

Errors

If a required field has not been initialized.

Examples found in repository

examples/text-embedding.rs (line 28)

async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Client::new();
    let input = EmbeddingsParamBuilder::default()
        .model("text-embedding-v3")
        .input(
            EmbeddingsInputBuilder::default()
                .texts(vec![
                    "风急天高猿啸哀".into(),
                    "渚清沙白鸟飞回".into(), 
                    "无边落木萧萧下".into(), 
                    "不尽长江滚滚来".into()
                ])
                .build()?,
        )
        .parameters(
            EmbeddingsParametersBuilder::default()
                .dimension(1024)
                .build()?,
        )
        .build()?;
    let output = client.text_embeddings().call(input).await?;

    dbg!(output);

    Ok(())
}

Trait Implementations

impl Clone for EmbeddingsParamBuilder

fn clone(&self) -> EmbeddingsParamBuilder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Default for EmbeddingsParamBuilder

fn default() -> Self

Returns the “default value” for a type.