Skip to main content
Toolkit/Framework

OpenAI compatible - Embedding

Os modelos de embedding do Alibaba Cloud Model Studio são compatíveis com a API da OpenAI. Para migrar suas aplicações existentes da OpenAI para o Model Studio, ajuste os três parâmetros a seguir:

  • base_url: Substitua por https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1.
    Para outras regiões, substitua o base_url:
  • api_key: Substitua por uma chave de API do Model Studio.
  • model: Substitua por um nome de modelo da lista abaixo.
O Model Studio lançou domínios específicos por workspace para as regiões China (Pequim), Singapura e China (Hong Kong). Os novos domínios dedicados oferecem desempenho superior e maior estabilidade para solicitações de inferência. Recomendamos migrar para os novos domínios:
  • China (Pequim): de https://dashscope.aliyuncs.com para https://{WorkspaceId}.cn-beijing.maas.aliyuncs.com
  • Singapura: de https://dashscope-intl.aliyuncs.com para https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com
  • China (Hong Kong): de https://cn-hongkong.dashscope.aliyuncs.com para https://{WorkspaceId}.cn-hongkong.maas.aliyuncs.com
{WorkspaceId} é o ID do seu workspace, disponível na página Workspace Details no console do Model Studio. O domínio existente permanece totalmente funcional.

Modelos suportados

  • Singapura
  • China (Pequim)
  • China (Hong Kong)
ModeloDimensões do embeddingMáx. de linhasMáx. de tokens por linha (Nota)Preço (por 1 milhão de tokens de entrada)Idiomas suportadosCota gratuita (Nota)
text-embedding-v4
Série Qwen3-Embedding
2.048, 1.536, 1.024 (padrão), 768, 512, 256, 128 ou 64108.192$0,07Mais de 100 idiomas principais, como chinês, inglês, espanhol, francês, português, indonésio, japonês, coreano, alemão e russo1 milhão de tokensVálido por 90 dias após a ativação do Model Studio
text-embedding-v31.024 (padrão), 768 ou 512Mais de 50 idiomas principais, como chinês, inglês, espanhol, francês, português, indonésio, japonês, coreano, alemão e russo500.000 tokensVálido por 90 dias após a ativação do Model Studio
Os modelos de embedding multimodal, como qwen3-vl-embedding e a série tongyi-embedding-vision, não suportam a API compatível com OpenAI. Consulte Embedding Multimodal .

Como usar

Exemplos de chamada

Esta seção apresenta exemplos de entrada de string usando Python (OpenAI SDK) e cURL (HTTP). Para exemplos com outras linguagens de programação ou métodos de entrada, consulte Introdução ao text embedding.
  • OpenAI SDK
  • HTTP
Para chamar o serviço com o OpenAI SDK, instale primeiro o OpenAI SDK.
import os
from openai import OpenAI

def get_response():
    client = OpenAI(
        # API keys vary by region. Get your API key: https://www.alibabacloud.com/help/en/model-studio/get-api-key
        api_key=os.getenv("DASHSCOPE_API_KEY"), # If you have not configured the environment variable, replace this value with your API key.
        # The base_url of the Model Studio service. If you use a model in the China (Beijing) region, replace the URL with https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1.
        base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1",
    )
    completion = client.embeddings.create(
        model="text-embedding-v3", # If you use a model in the China (Beijing) region, replace the model name with text-embedding-v4.
        input='The quality of the clothes is excellent. They are beautiful. It was worth the wait. I like them and will buy from here again.',
        encoding_format="float"
        )
    print(completion.model_dump_json())

if __name__ == '__main__':
    get_response()
Após executar o código, o seguinte resultado é retornado:
{
  "data": [
    {
      "embedding": [
        0.0023064255,
        -0.009327292,
        ....
        -0.0028842222
      ],
      "index": 0,
      "object": "embedding"
    }
  ],
  "model":"text-embedding-v3",
  "object":"list",
  "usage":{"prompt_tokens":23,"total_tokens":23},
  "id":"f62c2ae7-0906-9758-ab34-47c5764f07e2"
}

Exemplo de resposta de erro

Se ocorrer um erro na solicitação de acesso, os parâmetros code e message na resposta indicarão a causa.
{
    "error": {
        "message": "Incorrect API key provided. ",
        "type": "invalid_request_error",
        "param": null,
        "code": "invalid_api_key"
    }
}

Referência da API

Referência da API de text embedding

Códigos de erro

Se a chamada do modelo falhar e retornar uma mensagem de erro, consulte Códigos de erro para resolução.
Referência da API de Geração de Texto
Geração de Imagens
  • FAQ
Geração de Vídeo
Áudio
API em tempo real
Incorporação de Texto
Produção de Modelos