大規模言語モデル (LLM) は、プライベートデータに関する質問に回答できません。ナレッジ検索ツールは、ナレッジベースからコンテンツを取得し、LLM に提供します。これにより、モデルはより正確で関連性の高い回答を生成できます。
前提条件
-
ナレッジベースを作成し、その ID を取得します。ナレッジベースは、以下のいずれかの方法で作成できます。
-
コンソールで作成：Model Studio コンソールのナレッジベースページでナレッジベースを作成します。詳細については、「ナレッジベースの作成と使用」をご参照ください。
-
API を使用して作成：Alibaba Cloud Model Studio の SDK を介して API を呼び出し、ナレッジベースを作成できます。詳細については、「ナレッジベース API ガイド」をご参照ください。
API を使用してナレッジベースを作成する前に、Model Studio コンソールからワークスペース ID (
workspace_id) を取得してください。ドキュメント検索とデータクエリの 2 種類のナレッジベースのみがサポートされています。これらのタイプは、基本的なドキュメントの Q&A ペアに適しており、リッチテキストや画像を含む応答はサポートされていません。
ナレッジベース ID は、Model Studio コンソールのナレッジベース詳細ページで確認できます。
-
使用方法
知識検索機能は、file_search ツールを tools パラメーターに追加し、vector_store_ids パラメーターでナレッジベース ID を指定することで、Responses API を介して呼び出すことができます。
開始する前に、ナレッジベースを作成して使用し、その ID を取得します。現在、
vector_store_idsパラメーターは 1 つのナレッジベース ID のみをサポートしています。
# 依存関係のインポートとクライアントの作成はここでは省略しています。完全な実行可能コードについては、下記の「クイックスタート」をご参照ください。
response = client.responses.create(
model="qwen3.8-max",
input="Alibaba Cloud Model Studio X1 スマートフォンについて教えてください",
tools=[
{
"type": "file_search",
# これを実際のナレッジベース ID に置き換えてください。現在サポートされているのは 1 つだけです。
"vector_store_ids": ["your_knowledge_base_id"]
}
]
)
print(response.output_text)
サポートされるモデル
- Qwen-Max：Qwen3.8-Max シリーズおよび Qwen3.7-Max シリーズ
- Qwen-Plus：Qwen3.7-Plus シリーズ、Qwen3.6-Plus シリーズ、および Qwen3.5-Plus シリーズ
- Qwen-Flash：Qwen3.7-Flash シリーズ、Qwen3.6-Flash シリーズ、および Qwen3.5-Flash シリーズ
- Qwen3.8 オープンソースシリーズ
- Qwen3.6 オープンソースシリーズ (qwen3.6-27b を除く)
- Qwen3.5 オープンソースシリーズ
この機能は、Responses API を介してのみ呼び出すことができます。
クイックスタート
次のコードを実行して、Responses API を介してナレッジ検索ツールを呼び出します。このツールは、指定されたナレッジベースから関連コンテンツを取得して応答を生成します。
サンプルコード内の
vector_store_idsを、お使いのナレッジベース ID に置き換えてください。
警告有効なナレッジベース ID を渡すようにしてください。空の配列や無効な ID を渡した場合、ナレッジ検索ツールは機能しません。その場合、モデルは自身の知識を使用して応答を生成しますが、エラーは返されません。
import os
from openai import OpenAI
client = OpenAI(
# 環境変数を設定していない場合は、次の行を実際の Model Studio API キーに置き換えてください： api_key="sk-xxx" (非推奨)
api_key=os.getenv("DASHSCOPE_API_KEY"),
# 次の URL はシンガポールリージョン用です。{WorkspaceId} を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。
base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1"
)
response = client.responses.create(
model="qwen3.8-max",
input="Alibaba Cloud Model Studio X1 スマートフォンについて教えてください",
tools=[
{
"type": "file_search",
# これを実際のナレッジベース ID に置き換えてください。現在サポートされているのは 1 つだけです。
"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}")
import OpenAI from "openai";
import process from 'process';
const openai = new OpenAI({
// 環境変数を設定していない場合は、次の行を実際の Model Studio API キーに置き換えてください： apiKey: "sk-xxx",
apiKey: process.env.DASHSCOPE_API_KEY,
// 次の URL はシンガポールリージョン用です。{WorkspaceId} を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。
baseURL: "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1"
});
async function main() {
const response = await openai.responses.create({
model: "qwen3.8-max",
input: "Alibaba Cloud Model Studio X1 スマートフォンについて教えてください",
tools: [
{
type: "file_search",
// これを実際のナレッジベース ID に置き換えてください。現在サポートされているのは 1 つだけです。
"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();
# 次の URL はシンガポールリージョン用です。{WorkspaceId} を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。
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.8-max",
"input": "Alibaba Cloud Model Studio X1 スマートフォンについて教えてください",
"tools": [
{
"type": "file_search",
"vector_store_ids": ["your_knowledge_base_id"]
}
]
}'
コードを実行すると、次のような応答が返されます：
[Model Response]
ナレッジベースのコンテンツに基づき、この製品の要点は以下の通りです：
1. **コア機能**：この製品は...を提供します。
2. **シナリオ**：...に適しています。
3. **技術的属性**：...に基づいています。
...
[Token Usage] Input: 1568, Output: 1724, Total: 3292
ストリーミング出力
ナレッジ検索ツールは、ナレッジベース内でセマンティック検索を実行するため、処理に時間がかかる場合があります。ストリーミング出力を有効にすると、中間結果をリアルタイムで取得できます。
import os
from openai import OpenAI
client = OpenAI(
# 環境変数を設定していない場合は、次の行を実際の Model Studio API キーに置き換えてください： api_key="sk-xxx" (非推奨)
api_key=os.getenv("DASHSCOPE_API_KEY"),
# 次の URL はシンガポールリージョン用です。{WorkspaceId} を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。
base_url="https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1"
)
stream = client.responses.create(
model="qwen3.8-max",
input="Alibaba Cloud Model Studio X1 スマートフォンについて教えてください",
tools=[
{
"type": "file_search",
# これを実際のナレッジベース ID に置き換えてください。現在サポートされているのは 1 つだけです。
"vector_store_ids": ["your_knowledge_base_id"]
}
],
stream=True
)
for event in stream:
# モデルの応答が開始
if event.type == "response.content_part.added":
print("[Model Response]")
# モデルの応答をストリームで出力
elif event.type == "response.output_text.delta":
print(event.delta, end="", flush=True)
# 応答が完了したら、トークン使用量を出力
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}")
import OpenAI from "openai";
import process from 'process';
const openai = new OpenAI({
// 環境変数を設定していない場合は、次の行を実際の Model Studio API キーに置き換えてください： apiKey: "sk-xxx",
apiKey: process.env.DASHSCOPE_API_KEY,
// 次の URL はシンガポールリージョン用です。{WorkspaceId} を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。
baseURL: "https://{WorkspaceId}.ap-southeast-1.maas.aliyuncs.com/compatible-mode/v1"
});
async function main() {
const stream = await openai.responses.create({
model: "qwen3.8-max",
input: "Alibaba Cloud Model Studio X1 スマートフォンについて教えてください",
tools: [
{
type: "file_search",
// これを実際のナレッジベース ID に置き換えてください。現在サポートされているのは 1 つだけです。
"vector_store_ids": ["your_knowledge_base_id"]
}
],
stream: true
});
for await (const event of stream) {
// モデルの応答が開始
if (event.type === "response.content_part.added") {
console.log("[Model Response]");
}
// モデルの応答をストリームで出力
else if (event.type === "response.output_text.delta") {
process.stdout.write(event.delta);
}
// 応答が完了したら、トークン使用量を出力
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();
# 次の URL はシンガポールリージョン用です。{WorkspaceId} を実際のワークスペース ID に置き換えてください。URL はリージョンによって異なります。
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.8-max",
"input": "Alibaba Cloud Model Studio X1 スマートフォンについて教えてください",
"tools": [
{
"type": "file_search",
"vector_store_ids": ["your_knowledge_base_id"]
}
],
"stream": true
}'
パラメーター
file_search ツールは、以下のパラメーターをサポートしています。
| パラメーター | 必須 | 説明 |
|---|---|---|
| はい |
|
| はい | ナレッジベース ID のリストです。現在、渡すことができるナレッジベース ID は1 つだけです。ナレッジベース ID は、Model Studio コンソールのナレッジベース詳細ページで確認するか、API を使用してナレッジベースを作成する際に取得できます。
|
課金
課金には、以下の要素が含まれます：
- モデル呼び出し料金：ナレッジベースから取得されたコンテンツがプロンプトに追加されます。これにより、モデルの入力トークン数が増加します。料金は、モデルの標準価格に基づいて請求されます。料金の詳細については、Model Studio コンソールをご参照ください。
- ツール呼び出し料金：現在、ナレッジベース機能は無料でご利用いただけます。