LLMs.txt
EMQXドキュメントでは、llms.txtファイルを提供しています。これは大規模言語モデル(LLM)向けに構造化されたドキュメントインデックスであり、AIツールやエージェントがEMQXのドキュメント内容を迅速に発見・参照できるように設計されています。これにより、エージェント構築やAIコーディングアシスタント利用時に、より正確で関連性の高い結果を得ることができます。
llms.txtとは?
llms.txtは、製品の主要なドキュメントページを一覧化したプレーンテキストファイルで、標準的なURLパスに配置されます。これはドキュメントをAIに優しい形で提供するためのオープン標準であるllms.txt仕様に準拠しています。
AIツールがllms.txtに対応している場合、このファイルを指定するだけで、手動で内容を貼り付けることなく、EMQXドキュメントへの構造化された最新アクセスを可能にします。
TIP
llms.txtファイルはドキュメントのビルドごとに自動生成されるため、常に最新のドキュメント構造と内容を反映しています。
利用可能なファイル
トップレベルのインデックスファイルには、EMQX製品およびバージョンごとのすべてのllms.txtファイルが一覧化されています:
https://docs.emqx.com/llms.txtEMQXドキュメントは製品とバージョンごとに整理されており、各製品バージョンごとに専用のllms.txtがあります。例:
https://docs.emqx.com/en/emqx/latest/llms.txt
https://docs.emqx.com/en/emqx/v6.0/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ドキュメントページは、URLの.htmlを.mdに置き換えることで、Markdownの生データとして取得可能です。これは特定ページを直接AIツールやスクリプトに渡す際に便利です:
# HTMLページ
https://docs.emqx.com/en/emqx/latest/guides/access-control/authn/jwt.html
# 同ページのMarkdown
https://docs.emqx.com/en/emqx/latest/guides/access-control/authn/jwt.md