同步接口API详情

调用示例

设置API-KEY

 export DASHSCOPE_API_KEY=YOUR_DASHSCOPE_API_KEY

输入字符串

Python

import dashscope
from http import HTTPStatus


def embed_with_str():
    resp = dashscope.TextEmbedding.call(
        model=dashscope.TextEmbedding.Models.text_embedding_v1,
        input='衣服的质量杠杠的，很漂亮，不枉我等了这么久啊，喜欢，以后还来这里买')
    if resp.status_code == HTTPStatus.OK:
        print(resp)
    else:
        print(resp)


if __name__ == '__main__':
    embed_with_str()

Java

import java.util.Arrays;
import java.util.concurrent.Semaphore;
import com.alibaba.dashscope.common.ResultCallback;
import com.alibaba.dashscope.embeddings.TextEmbedding;
import com.alibaba.dashscope.embeddings.TextEmbeddingParam;
import com.alibaba.dashscope.embeddings.TextEmbeddingResult;
import com.alibaba.dashscope.exception.ApiException;
import com.alibaba.dashscope.exception.NoApiKeyException;

public final class Main {
    public static void basicCall() throws ApiException, NoApiKeyException{
        TextEmbeddingParam param = TextEmbeddingParam
        .builder()
        .model(TextEmbedding.Models.TEXT_EMBEDDING_V1)
        .texts(Arrays.asList("风急天高猿啸哀", "渚清沙白鸟飞回", "无边落木萧萧下", "不尽长江滚滚来")).build();
        TextEmbedding textEmbedding = new TextEmbedding();
        TextEmbeddingResult result = textEmbedding.call(param);
        System.out.println(result);
    }
  
    public static void callWithCallback() throws ApiException, NoApiKeyException, InterruptedException{
        TextEmbeddingParam param = TextEmbeddingParam
        .builder()
        .model(TextEmbedding.Models.TEXT_EMBEDDING_V1)
        .texts(Arrays.asList("风急天高猿啸哀", "渚清沙白鸟飞回", "无边落木萧萧下", "不尽长江滚滚来")).build();
        TextEmbedding textEmbedding = new TextEmbedding();
        Semaphore sem = new Semaphore(0);
        textEmbedding.call(param, new ResultCallback<TextEmbeddingResult>() {

          @Override
          public void onEvent(TextEmbeddingResult message) {
            System.out.println(message);
          }
          @Override
          public void onComplete(){
            sem.release();
          }

          @Override
          public void onError(Exception err){
            System.out.println(err.getMessage());
            err.printStackTrace();
            sem.release();
          }
          
        });
        sem.acquire();
    }

  public static void main(String[] args){
    try{
      callWithCallback();
    }catch(ApiException|NoApiKeyException|InterruptedException e){
      e.printStackTrace();
      System.out.println(e);

    }
      try {
        basicCall();
    } catch (ApiException | NoApiKeyException e) {
        System.out.println(e.getMessage());
    }
    System.exit(0);
  }
}

输入字符串列表

Python

from typing import Generator, List
import dashscope
from http import HTTPStatus


# 最多支持25条，每条最长支持2048tokens
DASHSCOPE_MAX_BATCH_SIZE = 25


def batched(inputs: List,
            batch_size: int = DASHSCOPE_MAX_BATCH_SIZE) -> Generator[List, None, None]:
    for i in range(0, len(inputs), batch_size):
        yield inputs[i:i + batch_size]


def embed_with_list_of_str(inputs: List):
    result = None  # merge the results.
    batch_counter = 0
    for batch in batched(inputs):
        resp = dashscope.TextEmbedding.call(
            model=dashscope.TextEmbedding.Models.text_embedding_v1,
            input=batch)
        if resp.status_code == HTTPStatus.OK:
            if result is None:
                result = resp
            else:
                for emb in resp.output['embeddings']:
                    emb['text_index'] += batch_counter
                    result.output['embeddings'].append(emb)
                result.usage['total_tokens'] += resp.usage['total_tokens']
        else:
            print(resp)
        batch_counter += len(batch)
    print(result)


if __name__ == '__main__':
    inputs = ['风急天高猿啸哀', '渚清沙白鸟飞回', '无边落木萧萧下', '不尽长江滚滚来']
    embed_with_list_of_str(inputs)

输入文件

1. 示例文件如下（文件名称：texts_to_embedding.txt，其中每一行对应一个embedding）

很不错的一款产品，送人的额，非常喜欢，很不错，好评哦，以后还会多多支持的
已经吃了，感觉不错。第二次购买，这个价格很实惠，卖家还赠送了美容器和尺子，很愉悦的一次购物。
衣服的质量杠杠的，很漂亮，不枉我等了这么久啊，喜欢，以后还来这里买，我一次买了四件不到200块钱，真好
用了一段时间了，感觉比传统的风扇好用，广度大，档数多，静音效果也不错，关键是还很漂亮！
这个热量低，比意面还低，关键是口感还好，挺好吃，多煮一会一级棒，我的减脂早餐就靠它了
整体评价：好 使用效果：好 包装与外观：好 三好商品
电视机很好，我给老爸买的，老人很喜欢，图像清晰，音质很好，老人喜欢我满意。
宝贝很轻巧，打的时候网弹力很足，儿子非常喜欢，五分好评，还送了羽毛球噢！
终于装上，风很大，热的还可以，排风声音不小，安装的师傅说不能直吹，安装的时候非常满意，最后还帮忙把棚顶给擦干净了，非常感谢。
颜色很美。就是别人的盒子都是平整的，唯独我的盒子有很严重的压痕。本来想直接用这个盒子装胶带的..现在这个样子强迫症看着实在很糟心。压成这样要么包装有问题，要么本来产品就有问题。而卖家一直在甩锅快递。由于包裹是被家里人拆开的，所以我也不知道是什么样子的，不好跟卖家掰扯。但我看别的人都是纸盒装的，想来我这个也是纸盒装的。那么排除包装的原因的话，很可能就是寄过来的就是个瑕疵品。比起同样今天到货的另一家，有个小瑕疵立马给我补寄了一个，这家的处理方式真的..换货..或者直接道歉说疏忽我都接受的。甩锅真的不能忍。本来还给好几个人推了这家店...就挺失望的 以后应该不会来了。这坚定的甩锅态度我也不点退换了..请不要给我打电话改评，谢谢。

2. 代码如下：

Python

from http import HTTPStatus
from dashscope import TextEmbedding


def embed_with_file_content():
    # 文件中最多支持25条，每条最长支持2048tokens
    with open('tests_to_embedding.txt', 'r', encoding='utf-8') as f:
        resp = TextEmbedding.call(
            model=TextEmbedding.Models.text_embedding_v1,
            input=f)
        if resp.status_code == HTTPStatus.OK:
            print(resp)
        else:
            print(resp)


if __name__ == '__main__':
    embed_with_file_content()

输出示例

{
    "status_code": 200, // 200 indicate success otherwise failed.
    "request_id": "fd564688-43f7-9595-b986-737c38874a40", // The request id.
    "code": "", // If failed, the error code.
    "message": "", // If failed, the error message.
    "output": {
        "embeddings": [ // embeddings
            {
                "embedding": [ // one embedding output
                    -3.8450357913970947, ...,
                    3.2640624046325684
                ],
                "text_index": 0 // the input index.
            }
        ]
    },
    "usage": {
        "total_tokens": 3 // the request tokens.
    }
}