Wiki は、エージェントのソースファイルを非同期でコンパイルし、相互にリンクされた構造化 Markdown ページを生成します。これらのページはパスで一覧表示、読み取り、検索ができます。Wiki を使用して、製品仕様、操作マニュアル、プロジェクト規約など、セッション間で共有する必要があるエージェントレベルの資料を保存します。
Wiki は、ページ、ページ間リンク、出典、セマンティック検索を提供します。エンティティのトリプルを保存したり、グラフクエリインターフェイスを公開したりすることはありません。グラフデータベーススタイルのエンティティクエリやリレーションシップクエリが必要な場合は、別のデータモデルを使用してください。
前提条件
メモリストアの作成。メモリストアは様々な入力タイプをサポートしていますが、Wiki 機能でコンパイルできるのは特定のファイルタイプのみです。
このトピックの SDK の例を使用するには、以下が必要です:
認証用の API キー。
https://<instance>.<region>.ots.aliyuncs.comの形式の Tablestore インスタンスエンドポイント。Tablestore インスタンス名。
インストール済みの
tablestore_agent_storagePython SDK パッケージ。
現在の Agent Storage SDK は、高レベルの Wiki メソッドを提供していません。このトピックのすべての SDK の例では、低レベルの ots_client.request(Action, body) 呼び出しを使用します。
コンソールでは、Wiki の操作は [知識のコンパイル Wiki] 配下の以下のページで構成されます:
[RAW ファイル] — コンパイル用のソースファイルを管理します。
[知識グラフ] — 公開されたページ、メタデータ、リンクを表示します。
[知識検索] — 公開されたページを検索します。
リソース境界
各 Wiki は、1 つのメモリストアと 3 部構成の Agent Scope に属します:
memoryStoreName + appId / tenantId / agentIdWiki は
runIdを使用しません。同じエージェントの異なるセッションが 1 つの Wiki を共有します。3 つの Scope フィールドはすべて必須で、最大 128 バイトまで含めることができます。
/やワイルドカード*を含めることはできません。
サポート対象のソースファイル
| タイプ | 拡張子 | 書き込みメソッド | ファイルごとの制限 |
| Markdown、テキスト | .md、.txt | content | 100 KiB |
.pdf | contentBase64 + mediaType | 2,000,000 バイト | |
| Word | .doc、.docx | contentBase64 + mediaType | 2,000,000 バイト |
| Excel | .xls、.xlsx | contentBase64 + mediaType | 2,000,000 バイト |
| PowerPoint | .ppt、.pptx | contentBase64 + mediaType | 2,000,000 バイト |
| 画像 | .jpg、.jpeg、.png | contentBase64 + mediaType | 2,000,000 バイト |
バイナリファイルには標準の Base64 を使用します。拡張子、mediaType、およびファイルシグネチャは一致している必要があります。
クォータと制限
| 項目 | 制限 |
| Wikiごとのソースファイル数 | 2,000 |
| ビルドごとの一意のバイナリソース数 | 50 |
| ビルドごとの合計ソースサイズ | 20 MiB |
| ビルドごとのページ数 | 500 |
| 単一ページの本文 | 100 KiB |
| ビルドごとの合計ページサイズ | 20 MiB |
ListWikiPages のデフォルト/最大 limit | 50 / 100 |
SearchWikiPages のデフォルト/最大 limit | 10 / 100 |
Wiki のクエリ
現在の Agent Scope の Wiki を取得または作成し、最新のビルドステータスを表示します。最初の呼び出しで Wiki が自動的に作成されます。wikiId、ビルド ID、タスク ID は不要です。
コンソール
Tablestore コンソールで、対象のメモリストアを開きます。[知識のコンパイル Wiki] > [知識グラフ] に移動し、[application]、[tenant]、[agent] を設定してから、Wiki のステータスとページ数を表示します。
SDK
Python
from tablestore_agent_storage import AgentStorageClient
client = AgentStorageClient(
api_key="",
ots_endpoint="https://..ots.aliyuncs.com",
ots_instance_name="",
)
wiki = client.ots_client.request("GetWiki", {
"memoryStoreName": "agent_memory",
"scope": {"appId": "app-001", "tenantId": "user-001", "agentId": "assistant"},
})
print(f"Status: {wiki.get('status')}, Page count: {wiki.get('pageCount')}, Pending build: {wiki.get('hasPendingChanges')}")API
GetWiki を呼び出して Wiki を照会します。フィールドの詳細については、「GetWiki」をご参照ください。
Wiki のビルド
/.wiki/raw/ 配下のソースファイルを非同期でコンパイルして新しいページのセットを生成し、アトミックに公開します。
ビルドする前に、ソースファイルを /.wiki/raw/ ディレクトリに書き込みます。コンソールでは、[RAW マテリアルの追加] または [一括アップロード] を使用します。SDK では、/.wiki/raw/ 配下のパスを指定して add_item を呼び出します。
ビルドを開始した後、GetWiki を呼び出して status フィールドを確認します。ステータスが ready になると、新しいページが公開され、読み取りと検索ができるようになります。ステータスが failed の場合は、errorMessage を確認し、ソースを修正して新しいビルドを開始してください。ステータスが conflict の場合は、最新のステータスを取得して新しいビルドを開始してください。
ビルドが成功すると、GetWiki.latestBuild.quality はソースカバレッジ、ページの出典ステータス、リンクの品質などのメトリクスを返します。ビルドが成功しても、すべてのソースが完全に反映されていることや、すべてのファクトが正確であることが保証されるわけではありません。重要なページは手動で検証してください。フィールドの詳細については、GetWiki API リファレンスをご参照ください。
一般的なビルドステータス:
| ステータス | 説明 |
pending、processing | ビルドが受理されたか、処理中です。 |
accepting_output、sealing、validating、indexing、publishing | ページが生成、検証、インデックス付け、または公開されています。 |
ready | 新しいページがアトミックに公開され、読み取りと検索ができます。 |
failed | ビルドに失敗しました。errorMessage を確認し、ソースを修正して新しいビルドを開始してください。 |
conflict | ビルド中にソースまたは現在のバージョンが変更されました。ステータスを取得し、新しいビルドを開始してください。 |
コンソール
[知識のコンパイル Wiki] > [RAW ファイル] ページで、[RAW マテリアルの追加] または [一括アップロード] をクリックして、ソースファイルを
/.wiki/raw/に書き込みます。[Wiki のビルド] をクリックします。サービスが非同期でページをコンパイルします。
[知識グラフ] ページで公開されたページを表示します。ビルド中も既存のページは読み取り可能なままです。
SDK
Python
from tablestore_agent_storage import AgentStorageClient
client = AgentStorageClient(
api_key="",
ots_endpoint="https://..ots.aliyuncs.com",
ots_instance_name="",
)
# 1. ソースファイルを書き込みます (add_item については、ファイルメモリのドキュメントをご参照ください)
client.add_item({
"memoryStoreName": "agent_memory",
"scope": {"appId": "app-001", "tenantId": "user-001", "agentId": "assistant"},
"path": "/.wiki/raw/product/payment.md",
"content": "# 支払いに関する注意\n\n支払いコールバックでは、べき等性キーを検証する必要があります。",
})
# 2. ビルドを開始します
resp = client.ots_client.request("IngestWiki", {
"memoryStoreName": "agent_memory",
"scope": {"appId": "app-001", "tenantId": "user-001", "agentId": "assistant"},
"clientToken": "wiki-build-001",
})
print(resp)API
IngestWiki を呼び出して Wiki をビルドします。フィールドの詳細については、「IngestWiki」をご参照ください。
IngestWiki は非同期操作です。安全にリトライするために、同じ clientToken を使用してください。レスポンスの reused は同じビルドが再利用されたことを示し、skipped はソースが変更されておらず再ビルドが不要であることを示します。
ページの一覧表示
パス、タイトル、概要などの公開済みページのメタデータを、ページネーション付きで一覧表示します。
ページは、ビルドして公開した後にのみ利用できるようになります。ビルドが実行されていない場合、サービスはリソースが見つからないというエラーを返します。
limitのデフォルト値は 50 で、最大値は 100 です。nextTokenを解析したり変更したりしないでください。ページネーションの結果は、同じ公開バージョンに紐付けられたままです。
コンソール
[知識グラフ] ページで、パス、タイトル、概要を含む公開済みページの一覧を表示します。
SDK
Python
from tablestore_agent_storage import AgentStorageClient
client = AgentStorageClient(
api_key="",
ots_endpoint="https://..ots.aliyuncs.com",
ots_instance_name="",
)
resp = client.ots_client.request("ListWikiPages", {
"memoryStoreName": "agent_memory",
"scope": {"appId": "app-001", "tenantId": "user-001", "agentId": "assistant"},
"limit": 50,
})
for p in resp.get("pages", []):
print(p.get("path"), p.get("title"))API
ListWikiPages を呼び出してページを一覧表示します。フィールドの詳細については、「ListWikiPages」をご参照ください。
ページの読み取り
パスを指定して、公開済みページの全文を読み取ります。ListWikiPages を使用して、利用可能なページのパスを取得します。
コンソール
[知識グラフ] ページで、対象のページをクリックして、その全文、出典、被リンクと発リンクを表示します。
SDK
Python
from tablestore_agent_storage import AgentStorageClient
client = AgentStorageClient(
api_key="",
ots_endpoint="https://..ots.aliyuncs.com",
ots_instance_name="",
)
resp = client.ots_client.request("GetWikiPage", {
"memoryStoreName": "agent_memory",
"scope": {"appId": "app-001", "tenantId": "user-001", "agentId": "assistant"},
"path": "/wiki/payment-callback.md",
})
print(resp.get("content"))API
GetWikiPage を呼び出してページを読み取ります。フィールドの詳細については、「GetWikiPage」をご参照ください。
ページの検索
自然言語を使用して、公開済みのページをセマンティックに検索します。検索結果として、一致したページのパス、タイトル、概要、スコアが返されます。
コンソール
[知識検索] ページで、キーワードを入力して、ビルドされたページをタイトル、概要、本文で検索します。
SDK
Python
from tablestore_agent_storage import AgentStorageClient
client = AgentStorageClient(
api_key="",
ots_endpoint="https://..ots.aliyuncs.com",
ots_instance_name="",
)
resp = client.ots_client.request("SearchWikiPages", {
"memoryStoreName": "agent_memory",
"scope": {"appId": "app-001", "tenantId": "user-001", "agentId": "assistant"},
"query": "支払いコールバックはどのようにしてべき等性を保証しますか",
"limit": 5,
})
for p in resp.get("pages", []):
print(f"[{p.get('score')}] {p.get('path')} - {p.get('title')}")API
SearchWikiPages を呼び出してページを検索します。フィールドの詳細については、「SearchWikiPages」をご参照ください。
Wiki の更新
Wikiの名前または概要を更新します。
コンソール
[知識のコンパイル Wiki] ページで、[設定] をクリックして名前または概要を変更します。
SDK
Python
from tablestore_agent_storage import AgentStorageClient
client = AgentStorageClient(
api_key="",
ots_endpoint="https://..ots.aliyuncs.com",
ots_instance_name="",
)
client.ots_client.request("UpdateWiki", {
"memoryStoreName": "agent_memory",
"scope": {"appId": "app-001", "tenantId": "user-001", "agentId": "assistant"},
"name": "支払いと照合の Wiki",
"summary": "支払いコールバック、照合、べき等性の規約が含まれます",
})API
UpdateWiki を呼び出して Wiki を更新します。フィールドの詳細については、「UpdateWiki」をご参照ください。