Pengambilan pengetahuan - Alibaba Cloud Model Studio - Alibaba Cloud Documentation Center

Large Language Models (LLMs) tidak dapat menjawab pertanyaan mengenai data pribadi. Fitur knowledge retrieval mengambil konten dari basis pengetahuan dan menyediakannya kepada LLM, sehingga memungkinkan model menghasilkan jawaban yang lebih akurat dan relevan.

Cara menggunakan

Anda dapat memanggil fitur knowledge retrieval melalui Responses API dengan menambahkan tool file_search ke parameter tools serta menentukan ID basis pengetahuan di parameter vector_store_ids.

Sebelum memulai, buat dan gunakan basis pengetahuan serta peroleh ID-nya. Saat ini, parameter vector_store_ids hanya mendukung satu ID basis pengetahuan.

# Impor dependensi dan buat client...
response = client.responses.create(
    model="qwen3.7-plus",
    input="Tell me about the Alibaba Cloud Model Studio X1 phone",
    tools=[
        {
            "type": "file_search",
            # Ganti ini dengan ID basis pengetahuan Anda. Saat ini hanya satu yang didukung.
            "vector_store_ids": ["your_knowledge_base_id"]
        }
    ]
)

print(response.output_text)

Model yang didukung

Qwen-Plus: seri Qwen3.7-Plus, seri Qwen3.6-Plus, dan seri Qwen3.5-Plus
Qwen-Flash: seri Qwen3.6-Flash dan seri Qwen3.5-Flash
Seri open-source Qwen3.6 (kecuali qwen3.6-27b)
Seri open source Qwen3.5

Fitur ini hanya dapat dipanggil melalui Responses API.

Prasyarat

Peroleh Kunci API dan konfigurasikan sebagai variabel lingkungan.
Buat basis pengetahuan dan peroleh ID-nya. Anda dapat membuat basis pengetahuan dengan salah satu cara berikut:
- Buat di Konsol: Buat basis pengetahuan di halaman basis pengetahuan di Konsol Model Studio. Untuk informasi selengkapnya, lihat Buat dan gunakan basis pengetahuan.
- Buat menggunakan API: Anda dapat memanggil API melalui kit pengembangan perangkat lunak (SDK) Alibaba Cloud Model Studio untuk membuat basis pengetahuan. Untuk informasi selengkapnya, lihat Panduan API Basis Pengetahuan.
  
  Sebelum membuat basis pengetahuan menggunakan API, peroleh ID ruang kerja (`workspace_id`) dari Konsol Model Studio. Hanya dua jenis basis pengetahuan yang didukung: pencarian dokumen dan kueri data. Jenis-jenis ini cocok untuk pasangan tanya jawab dokumen dasar dan tidak mendukung respons berupa teks kaya atau gambar.
Anda dapat menemukan ID basis pengetahuan di halaman detail basis pengetahuan di Konsol Model Studio.

Mulai cepat

Jalankan kode berikut untuk memanggil fitur knowledge retrieval melalui Responses API. Fitur ini mengambil konten relevan dari basis pengetahuan yang ditentukan untuk menghasilkan respons.

Ganti vector_store_ids dalam kode contoh dengan ID basis pengetahuan Anda.

Python

import os
from openai import OpenAI

client = OpenAI(
    # Jika Anda belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan Kunci API Model Studio Anda: api_key="sk-xxx" (tidak disarankan)
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    # URL berikut untuk wilayah Singapura. Saat memanggil, ganti WorkspaceId dengan ID ruang kerja aktual Anda. URL bervariasi berdasarkan wilayah.
    base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1"
)

response = client.responses.create(
    model="qwen3.7-plus",
    input="Tell me about the Alibaba Cloud Model Studio X1 phone",
    tools=[
        {
            "type": "file_search",
            # Ganti ini dengan ID basis pengetahuan Anda. Saat ini hanya satu yang didukung.
            "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}")

Node.js

import OpenAI from "openai";
import process from 'process';

const openai = new OpenAI({
    // Jika Anda belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan Kunci API Model Studio Anda: apiKey: "sk-xxx",
    apiKey: process.env.DASHSCOPE_API_KEY,
    // URL berikut untuk wilayah Singapura. Saat memanggil, ganti WorkspaceId dengan ID ruang kerja aktual Anda. URL bervariasi berdasarkan wilayah.
    baseURL: "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1"
});

async function main() {
    const response = await openai.responses.create({
        model: "qwen3.7-plus",
        input: "Tell me about the Alibaba Cloud Model Studio X1 phone",
        tools: [
            {
                type: "file_search",
                // Ganti ini dengan ID basis pengetahuan Anda. Saat ini hanya satu yang didukung.
                vector_store_ids: ["your_knowledge_base_id"]
            }
        ]
    });

    console.log("[Model Response]");
    console.log(response.output_text);

    const usage = response.usage;
    console.log(`\n[Token Usage] Input: ${usage.input_tokens}, Output: ${usage.output_tokens}, Total: ${usage.total_tokens}`);
}

main();

curl

# URL berikut untuk wilayah Singapura. Saat memanggil, ganti WorkspaceId dengan ID ruang kerja aktual Anda. URL bervariasi berdasarkan wilayah.
curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/responses \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "qwen3.7-plus",
    "input": "Tell me about the Alibaba Cloud Model Studio X1 phone",
    "tools": [
        {
            "type": "file_search",
            "vector_store_ids": ["your_knowledge_base_id"]
        }
    ]
}'

Menjalankan kode tersebut menghasilkan respons seperti berikut:

[Model Response]
Berdasarkan konten dalam basis pengetahuan, poin utama produk ini mencakup hal-hal berikut:

1. **Fitur inti**: Produk ini menyediakan...
2. **Skenario**: Cocok untuk...
3. **Atribut teknis**: Berdasarkan...

...

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

Keluaran streaming

Fitur knowledge retrieval melakukan pencarian semantik di basis pengetahuan, yang dapat memerlukan waktu pemrosesan. Anda dapat mengaktifkan keluaran streaming untuk memperoleh hasil antara secara real time.

Python

import os
from openai import OpenAI

client = OpenAI(
    # Jika Anda belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan Kunci API Model Studio Anda: api_key="sk-xxx" (tidak disarankan)
    api_key=os.getenv("DASHSCOPE_API_KEY"),
    # URL berikut untuk wilayah Singapura. Saat memanggil, ganti WorkspaceId dengan ID ruang kerja aktual Anda. URL bervariasi berdasarkan wilayah.
    base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1"
)

stream = client.responses.create(
    model="qwen3.7-plus",
    input="Tell me about the Alibaba Cloud Model Studio X1 phone",
    tools=[
        {
            "type": "file_search",
            # Ganti ini dengan ID basis pengetahuan Anda. Saat ini hanya satu yang didukung.
            "vector_store_ids": ["your_knowledge_base_id"]
        }
    ],
    stream=True
)

for event in stream:
    # Respons model dimulai
    if event.type == "response.content_part.added":
        print("[Model Response]")
    # Cetak respons model secara streaming
    elif event.type == "response.output_text.delta":
        print(event.delta, end="", flush=True)
    # Ketika respons selesai, cetak penggunaan token
    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}")

Node.js

import OpenAI from "openai";
import process from 'process';

const openai = new OpenAI({
    // Jika Anda belum mengonfigurasi variabel lingkungan, ganti baris berikut dengan Kunci API Model Studio Anda: apiKey: "sk-xxx",
    apiKey: process.env.DASHSCOPE_API_KEY,
    // URL berikut untuk wilayah Singapura. Saat memanggil, ganti WorkspaceId dengan ID ruang kerja aktual Anda. URL bervariasi berdasarkan wilayah.
    baseURL: "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1"
});

async function main() {
    const stream = await openai.responses.create({
        model: "qwen3.7-plus",
        input: "Tell me about the Alibaba Cloud Model Studio X1 phone",
        tools: [
            {
                type: "file_search",
                // Ganti ini dengan ID basis pengetahuan Anda. Saat ini hanya satu yang didukung.
                vector_store_ids: ["your_knowledge_base_id"]
            }
        ],
        stream: true
    });

    for await (const event of stream) {
        // Respons model dimulai
        if (event.type === "response.content_part.added") {
            console.log("[Model Response]");
        }
        // Cetak respons model secara streaming
        else if (event.type === "response.output_text.delta") {
            process.stdout.write(event.delta);
        }
        // Ketika respons selesai, cetak penggunaan token
        else if (event.type === "response.completed") {
            const usage = event.response.usage;
            console.log(`\n\n[Token Usage] Input: ${usage.input_tokens}, Output: ${usage.output_tokens}, Total: ${usage.total_tokens}`);
        }
    }
}

main();

curl

# URL berikut untuk wilayah Singapura. Saat memanggil, ganti WorkspaceId dengan ID ruang kerja aktual Anda. URL bervariasi berdasarkan wilayah.
curl -X POST https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1/responses \
-H "Authorization: Bearer $DASHSCOPE_API_KEY" \
-H "Content-Type: application/json" \
-d '{
    "model": "qwen3.7-plus",
    "input": "Tell me about the Alibaba Cloud Model Studio X1 phone",
    "tools": [
        {
            "type": "file_search",
            "vector_store_ids": ["your_knowledge_base_id"]
        }
    ],
    "stream": true
}'

Parameter

Tool file_search mendukung parameter berikut:

Parameter

Wajib

Deskripsi

type

Harus diatur ke "file_search".

vector_store_ids

Daftar ID basis pengetahuan. Saat ini, Anda hanya dapat meneruskan satu ID basis pengetahuan. Anda dapat menemukan ID basis pengetahuan di halaman detail basis pengetahuan di Konsol Model Studio atau memperolehnya saat membuat basis pengetahuan menggunakan API.

Pastikan untuk meneruskan ID basis pengetahuan yang valid. Jika Anda meneruskan array kosong atau ID yang tidak valid, fitur knowledge retrieval tidak berfungsi. Model kemudian akan menggunakan pengetahuannya sendiri untuk menghasilkan respons dan tidak mengembalikan error.

Penagihan

Penagihan mencakup aspek-aspek berikut:

Biaya pemanggilan model: Konten yang diambil dari basis pengetahuan ditambahkan ke prompt, sehingga meningkatkan jumlah token input untuk model. Anda dikenai biaya berdasarkan harga standar model. Untuk detail harga, lihat Konsol Model Studio.
Biaya pemanggilan tool: Fitur basis pengetahuan saat ini gratis.