Knowledge retrieval

​

Pré-requisitos

1. Obtain an API key e configure it as an environment variable.
2. Crie uma base de conhecimento e obtenha seu ID. Você pode criar uma base de conhecimento das seguintes formas:
   • Pelo console: Crie uma base de conhecimento na página de bases de conhecimento no console do Model Studio. Para mais informações, consulte Create and use a knowledge base.
   • Via API: Use o kit de desenvolvimento de software (SDK) do Alibaba Cloud Model Studio para criar uma base de conhecimento. Para mais informações, consulte Knowledge Base API Guide.

     Antes de criar uma base de conhecimento via API, obtenha o ID do workspace (workspace_id) no console do Model Studio . Apenas dois tipos de bases de conhecimento são suportados: busca de documentos e consulta de dados. Esses tipos atendem a pares básicos de perguntas e respostas de documentos, mas não suportam respostas com rich text ou imagens.

   O ID da base de conhecimento está disponível na página de detalhes da base de conhecimento no console do Model Studio.

​

Como usar

Antes de começar, create and use a knowledge base e obtenha seu ID. Atualmente, o parâmetro vector_store_ids aceita apenas um ID de base de conhecimento.

# Dependency imports and client creation are omitted here. For the complete runnable code, see "Getting started" below.
response = client.responses.create(
    model="qwen3.8-max",
    input="Tell me about the Alibaba Cloud Model Studio X1 phone",
    tools=[
        {
            "type": "file_search",
            # Replace this with your knowledge base ID. Only one is currently supported.
            "vector_store_ids": ["your_knowledge_base_id"]
        }
    ]
)

print(response.output_text)

​

Modelos suportados

• Qwen-Max: séries Qwen3,8-Max e Qwen3,7-Max
• Qwen-Plus: séries Qwen3,7-Plus, Qwen3,6-Plus e Qwen3,5-Plus
• Qwen-Flash: séries Qwen3,7-Flash, Qwen3,6-Flash e Qwen3,5-Flash
• Série open-source Qwen3,8
• Série open-source Qwen3,6 (exceto qwen3.6-27b)
• Série open-source Qwen3,5

​

Primeiros passos

Substitua vector_store_ids no código de exemplo pelo ID da sua base de conhecimento.

import os
from openai import OpenAI

client = OpenAI(
    # If you have not configured the environment variable, replace the following line with your Model Studio API key: api_key="sk-xxx" (not recommended)
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    # The following URL is for the Singapore region. Replace {WorkspaceId} with your actual workspace ID. URLs vary by region.
    base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1"
)

response = client.responses.create(
    model="qwen3.8-max",
    input="Tell me about the Alibaba Cloud Model Studio X1 phone",
    tools=[
        {
            "type": "file_search",
            # Replace this with your knowledge base ID. Only one is currently supported.
            "vector_store_ids": ["your_knowledge_base_id"]
        }
    ]
)

print("[Model Response]")
print(response.output_text)
print(f"\n[Token Usage] Input: {response.usage.input_tokens}, Output: {response.usage.output_tokens}, Total: {response.usage.total_tokens}")

[Model Response]
Based on the content in the knowledge base, the key points of this product include the following:

1. **Core features**: The product provides...
2. **Scenarios**: Suitable for...
3. **Technical attributes**: Based on...

...

[Token Usage] Input: 1568, Output: 1724, Total: 3292

​

Saída em streaming

import os
from openai import OpenAI

client = OpenAI(
    # If you have not configured the environment variable, replace the following line with your Model Studio API key: api_key="sk-xxx" (not recommended)
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    # The following URL is for the Singapore region. Replace {WorkspaceId} with your actual workspace ID. URLs vary by region.
    base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1"
)

stream = client.responses.create(
    model="qwen3.8-max",
    input="Tell me about the Alibaba Cloud Model Studio X1 phone",
    tools=[
        {
            "type": "file_search",
            # Replace this with your knowledge base ID. Only one is currently supported.
            "vector_store_ids": ["your_knowledge_base_id"]
        }
    ],
    stream=True
)

for event in stream:
    # The model response starts
    if event.type == "response.content_part.added":
        print("[Model Response]")
    # Print the model response in a stream
    elif event.type == "response.output_text.delta":
        print(event.delta, end="", flush=True)
    # When the response is complete, print the token usage
    elif event.type == "response.completed":
        usage = event.response.usage
        print(f"\n\n[Token Usage] Input: {usage.input_tokens}, Output: {usage.output_tokens}, Total: {usage.total_tokens}")

​

Parâmetros

​

Faturamento

• Taxas de chamada do modelo: O conteúdo recuperado da base de conhecimento é adicionado ao prompt, aumentando o número de tokens de entrada do modelo. A cobrança segue o preço padrão do modelo. Para detalhes, consulte o console do Model Studio.
• Taxas de chamada de ferramenta: O recurso de base de conhecimento é atualmente gratuito.