Interface AlibabaTongyiEmbeddingsParams

interface AlibabaTongyiEmbeddingsParams {
    modelName: "text-embedding-v2";
    batchSize?: number;
    parameters?: {
        text_type?: "text" | "document";
    };
    stripNewLines?: boolean;
    timeout?: number;
}

Hierarchy (view full)

  • Toolkit
    • AlibabaTongyiEmbeddingsParams

Implemented by

Properties

modelName batchSize? parameters? stripNewLines? timeout?

Properties

modelName

modelName: "text-embedding-v2"

Model name to use

Optional batchSize

batchSize?: number

The maximum number of documents to embed in a single request. This is limited by the AlibabaTongyi API to a maximum of 2048.

Optional parameters

parameters?: {
    text_type?: "text" | "document";
}

Type declaration

  • Optional text_type?: "text" | "document"

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

Optional stripNewLines

stripNewLines?: boolean

Whether to strip new lines from the input text.

Optional timeout

timeout?: number

Timeout to use when making requests to AlibabaTongyi.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc