@h-lumos/llm-sdk/dist-types/ernie/resources/embeddings.d.ts

通用大模型 SDK

import { default as OpenAI } from 'openai';
import { RequestOptions } from 'openai/core';
import { APIResource } from '../../resource';

export declare class Embeddings extends APIResource {
    protected endpoints: Record<EmbeddingModel, string>;
    /**
     * 创建文本嵌入向量
     *
     * @param params 请求参数，包含模型、用户信息和输入文本
     * @param options 可选请求配置
     * @returns 包含嵌入向量的Promise对象
     *
     * @see 官方文档 https://cloud.baidu.com/doc/WENXINWORKSHOP/s/alj562vvu
     */
    create(params: EmbeddingCreateParams, options?: RequestOptions): Promise<OpenAI.CreateEmbeddingResponse>;
    /**
     * 将百度API响应格式转换为OpenAI兼容格式
     * @param model - 使用的嵌入模型名称
     * @param data - 来自百度API的原始响应数据
     * @returns OpenAI标准格式的嵌入响应
     */
    static fromResponse(model: EmbeddingModel, data: CreateEmbeddingResponse): OpenAI.CreateEmbeddingResponse;
    /**
     * 如果 code 不为 0，抛出 APIError
     *
     * @param code -
     * @param message -
     */
    static assert(resp: CreateEmbeddingResponse): void;
}
export type EmbeddingModel = 'ernie-text-embedding';
export interface EmbeddingCreateParams {
    /**
     * 输入文本
     */
    input: string | Array<string> | Array<number> | Array<Array<number>>;
    /**
     * 模型
     */
    model: EmbeddingModel;
    /**
     * 用户 ID
     */
    user?: string;
}
type CreateEmbeddingResponse = {
    errorCode: number;
    errorMsg: string;
    result: OpenAI.CreateEmbeddingResponse;
};
export {};