AIに本ドキュメントを参照させる方法
このページでは、本ドキュメントサイトの情報をAIに参照させたい場合の、便利な方法についてご紹介します。
llms.txtとは
llms.txtとは、生成AI(LLM)に対してWebサイトの概要や重要なページへのリンクをMarkdown形式で伝えるためのテキストファイルです。
本ドキュメントサイトでは、AIに「駅すぱあと API」の情報(概要、仕様など)を効率的に参照できるように llms.txt を公開しています。
本ドキュメントサイトのllms.txtのURL:
https://docs.ekispert.com/llms.txt
llms.txtでは各ページのURLやその概要をまとめており、その情報をAIに読み込ませることで「駅すぱあと API」の仕様・機能の把握やコード生成などにご活用いただけます。
用途例
- 「駅すぱあと API」で実現できそうなことや、使用すべきAPI・パラメータをAIに調べてもらいたい
- 「駅すぱあと API」を実行するためのプログラムコードをAIに生成してもらいたい
- 「駅すぱあと API」を活用して新機能を開発する作業をAIに手伝ってもらいたい
利用方法(プロンプト例)
AIに指示を行う際に、llms.txtのURLを添えるだけです。
下記は一例であり、それ以外にも様々な用途でご活用いただけます。
例1:使うべきAPIの特定
https://docs.ekispert.com/llms.txt を参照してください。
出発地と目的地の間の経路と運賃を取得したい場合、
どのAPIのどのパラメータを利用するとよいですか?
例2:サンプルコードの生成
https://docs.ekispert.com/llms.txt を参照してください。
東京駅から新宿駅までの経路を探索し、
所要時間と運賃を取得するJavaScriptのサンプルコードを書いてください。
例3:実装に必要なAPIの確認
https://docs.ekispert.com/llms.txt を参照してください。
交通費精算システムを開発したいです。
定期区間控除を含む運賃計算に必要なAPIの一覧と、それぞれの役割を整理してください。
Attention!
llms.txtの内容をAIに読み込ませるには、ご利用のAIがWebページを参照できる機能(Webブラウジング機能)を備えている必要があります。
note
ご利用のAIがWebページを参照できない場合は、llms.txtの内容を直接プロンプトに貼り付ければ、AIに情報を渡すことができます。