大規模言語モデル (LLM) は、プライベートデータに関する質問に回答できません。ナレッジ検索ツールは、ナレッジベースからコンテンツを取得し、LLM に提供します。これにより、モデルはより正確で関連性の高い回答を生成できます。
使用方法
Responses API を通じてナレッジ検索機能を呼び出すには、tools パラメーターに file_search ツールを追加し、vector_store_ids パラメーターでナレッジベース ID を指定します。
開始する前に、ナレッジベースを作成して使用し、その ID を取得してください。現在、vector_store_ids パラメーターは 1 つのナレッジベース ID のみをサポートしています。# 依存関係をインポートしてクライアントを作成...
response = client.responses.create(
model="qwen3.7-plus",
input="Alibaba Cloud Model Studio X1 スマートフォンについて教えてください",
tools=[
{
"type": "file_search",
# これをナレッジベース ID に置き換えてください。現在、1 つのみサポートされています。
"vector_store_ids": ["your_knowledge_base_id"]
}
]
)
print(response.output_text)
サポートされているモデル
-
Qwen-Plus : Qwen3.7-Plus シリーズ、Qwen3.6-Plus シリーズ、Qwen3.5-Plus シリーズ
-
Qwen-Flash : Qwen3.6-Flash シリーズ、Qwen3.5-Flash シリーズ
-
Qwen3.6 オープンソースシリーズ (qwen3.6-27b を除く)
-
Qwen3.5 オープンソースシリーズ
この機能は Responses API を通してのみ呼び出すことができます。
前提条件
-
ナレッジベースを作成し、その ID を取得します。ナレッジベースは次のいずれかの方法で作成できます:
-
コンソールで作成: Alibaba Cloud Model Studio コンソールのナレッジベースページでナレッジベースを作成します。詳細については、「ナレッジベースの作成と使用」をご参照ください。
-
API を使用して作成: Alibaba Cloud Model Studio SDK を通じて API を呼び出し、ナレッジベースを作成します。詳細については、「ナレッジベース API ガイド」をご参照ください。
API を使用してナレッジベースを作成する前に、Alibaba Cloud Model Studio コンソールからワークスペース ID (
workspace_id) を取得してください。サポートされているナレッジベースのタイプは、ドキュメント検索とデータクエリの 2 種類のみです。これらのタイプは基本的なドキュメント Q&A に適していますが、リッチテキストや画像を含むレスポンスはサポートされていません。
ナレッジベース ID は、Alibaba Cloud Model Studio コンソールのナレッジベース詳細ページで確認してください。
-
使用開始
次のコードを実行して、Responses API を通じてナレッジ検索ツールを呼び出します。このツールは、指定されたナレッジベースから関連コンテンツを取得してレスポンスを生成します。
サンプルコード内の vector_store_ids をナレッジベース 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.7-plus",
input="Alibaba Cloud Model Studio X1 スマートフォンについて教えてください",
tools=[
{
"type": "file_search",
# これをナレッジベース ID に置き換えてください。現在、1 つのみサポートされています。
"vector_store_ids": ["your_knowledge_base_id"]
}
]
)
print("[モデルレスポンス]")
print(response.output_text)
print(f"\n[トークン使用量] 入力:{response.usage.input_tokens}、出力:{response.usage.output_tokens}、合計:{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.7-plus",
input: "Alibaba Cloud Model Studio X1 スマートフォンについて教えてください",
tools: [
{
type: "file_search",
// これをナレッジベース ID に置き換えてください。現在、1 つのみサポートされています。
vector_store_ids: ["your_knowledge_base_id"]
}
]
});
console.log("[モデルレスポンス]");
console.log(response.output_text);
const usage = response.usage;
console.log(`\n[トークン使用量] 入力:${usage.input_tokens}、出力:${usage.output_tokens}、合計:${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.7-plus",
"input": "Alibaba Cloud Model Studio X1 スマートフォンについて教えてください",
"tools": [
{
"type": "file_search",
"vector_store_ids": ["your_knowledge_base_id"]
}
]
}'コードを実行すると、次のようなレスポンスが返されます:
[モデルレスポンス]
ナレッジベースのコンテンツに基づくと、この製品の主なポイントは次のとおりです:
1. **コア機能**:この製品は...を提供します
2. **シナリオ**:...に適しています
3. **技術属性**:...に基づいています
...
[トークン使用量] 入力: 1568、出力: 1724、合計: 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.7-plus",
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("[モデルレスポンス]")
# モデルレスポンスをストリームで出力します
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[トークン使用量] 入力:{usage.input_tokens}、出力:{usage.output_tokens}、合計:{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.7-plus",
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("[モデルレスポンス]");
}
// モデルレスポンスをストリームで出力します
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[トークン使用量] 入力:${usage.input_tokens}、出力:${usage.output_tokens}、合計:${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.7-plus",
"input": "Alibaba Cloud Model Studio X1 スマートフォンについて教えてください",
"tools": [
{
"type": "file_search",
"vector_store_ids": ["your_knowledge_base_id"]
}
],
"stream": true
}'パラメーター
file_search ツールは次のパラメーターをサポートしています:
|
パラメーター |
必須 |
説明 |
|
|
はい |
|
|
|
はい |
ナレッジベース ID のリスト。現在、1 つのナレッジベース ID のみを渡すことができます。ナレッジベース ID は、Alibaba Cloud Model Studio コンソールのナレッジベース詳細ページで確認できます。また、API を使用してナレッジベースを作成する際に取得することもできます。 有効なナレッジベース ID を渡してください。空の配列または無効な ID を渡した場合、ナレッジ検索ツールは機能しません。モデルは自身の知識を使用してレスポンスを生成し、エラーは返されません。 |
課金
課金には、次の要素が含まれます:
-
モデル呼び出し料金:ナレッジベースから取得したコンテンツがプロンプトに追加されるため、モデルの入力トークン数が増加します。課金はモデルの標準料金に基づいて行われます。料金の詳細については、Alibaba Cloud Model Studio コンソールをご参照ください。
-
ツール呼び出し料金:ナレッジベース機能は現在無料です。