LLMs.txt
EMQX Cloudドキュメントは、LLM(大規模言語モデル)向けに構造化されたドキュメントインデックスであるllms.txtファイルを提供しています。これらのファイルは、AIツールやエージェントがEMQX Cloudドキュメントの内容を迅速に発見・参照できるようにし、エージェントの構築やAIコーディングアシスタントの利用時に、より正確で関連性の高い結果を得られるようにします。
llms.txtとは?
llms.txtは、製品の主要なドキュメントページを一覧化したプレーンテキストファイルで、標準的なURLパスに配置されます。これは、ドキュメントをAIフレンドリーにするためのオープン標準であるllms.txt仕様に準拠しています。
AIツールがllms.txtに対応している場合、このファイルを指定することで、内容を手動で貼り付けることなく、EMQX Cloudドキュメントへの構造化された最新のアクセスが可能になります。
TIP
llms.txtファイルはドキュメントのビルドごとに自動生成されるため、常に最新のドキュメント構造と内容を反映しています。
利用可能なファイル
トップレベルのインデックスファイルには、EMQX製品およびバージョンごとに利用可能なすべてのllms.txtファイルが一覧化されています:
https://docs.emqx.com/llms.txtEMQX Cloudドキュメント専用のllms.txtも用意されています:
https://docs.emqx.com/en/cloud/latest/llms.txtAIツールにトップレベルのインデックスを指定すれば、全リストを自動で検出し、適切な製品へナビゲートできます。
AIツールでの利用方法
AIツールやコーディングアシスタントにトップレベルのllms.txt URLを指定してください:
https://docs.emqx.com/llms.txt追加方法はツールによって異なります。設定画面で直接ドキュメントソースを登録できるものもあれば、URLをプロンプトに貼り付けるだけのものもあります。わからない場合は、AIツールに直接問い合わせてください。例えば:
How do I add https://docs.emqx.com/llms.txt as a documentation source?AIは自身のインターフェースに応じた最新の手順を案内してくれます。
Markdown形式でドキュメントにアクセス
EMQX Cloudの任意のドキュメントページは、URLの.htmlを.mdに置き換えることで、生のMarkdown形式で取得できます。これは特定ページを直接AIツールやスクリプトに渡す際に便利です:
# HTMLページ
https://docs.emqx.com/en/cloud/latest/deployments/auth_overview.html
# 同ページのMarkdown
https://docs.emqx.com/en/cloud/latest/deployments/auth_overview.md