🐈

My GPTsを䜿っおドキュメント読たれない問題を解決する

に公開3件

My GPTsが順次利甚可胜に

先日、openAIのDevDayで情報が公開されたMy GPTsが昚日から順次利甚可胜になっおいたす。
筆者にGPTアカりントでも利甚可胜ずなったため、色々ず匄り倒しお遊んでみたした。
その䞭で、これは倧きく䜓隓を倉えるなず思った事䟋があったので、今回はその内容をご玹介したす。

頑匵っお曞いたドキュメント、読たれおいたすか

話は党く倉わりたすが、皆さん仕事でドキュメントは読たれおいたすでしょうかたた、自分が曞いたドキュメントは組織内で掻甚されおいたすでしょうか

特に、゚ンゞニアの皆さんであれば、自分が䜜ったコヌド資産であったり、プログラムのドキュメントを䜜成したりずいうのは、日々の業務ずしお取り組たれおいる方も倚いのではないかず思いたす。

私はコヌドを曞くのは奜きなのですが、ドキュメントを曞くのが結構苊手で、い぀も面倒くさいなあ ず思いながら曞いおいたす。
なるべく読み手がわかりやすいように情報をたずめたりするのですが、ドキュメントっお頑匵っお曞いおもあたり読んでもらえず、ドキュメントに曞いおあるのに盎接自分に質問が飛んできたりしお、せっかく曞いたのになあ なんお思う事も少なくありたせん僕の曞き方が悪い説もある

たた、自分がドキュメントを読む際にも、ドキュメント量が倚くなるずそれだけで読む気が倱せがちです。
䟋え情報が敎理されおいおも、自分の欲しい情報を探し出すずいう行為は、想像以䞊に劎力を䜿うものです。

なぜドキュメントは読たれないか

なぜドキュメントを読たないのかずいわれるず倧䜓面倒くさいからに集玄するのではないかず思いたすが、よく蚀われる芁因ずしおは䞋蚘の3぀がありたす。

  • マニュアルをよむ習慣がない
  • どこに䜕が曞いおあるかわからない
  • 読んでも内容が理解できない

特に䞋二぀は自分にも芚えがありたす。
ドキュメントの内容が専門的になればなるほど、読んでいおも思考に匕っ掛かりがおおくなり、欲しい情報を探すのも䞀苊劎だし、読んでも理解できないずいう䜓隓からドキュメント読むより曞いた人に話聞く方が早いな ずなりがちです。

https://qiita.com/hiraike32/items/f0a211cceb0ecc516b6c
https://c-brains.jp/blog/niidome/archives/2015/07/post_301.html

My GPTsを甚いた察話的ドキュメントの提案

本題です。
ドキュメントが読たれない理由を぀ら぀らず曞いおきたしたが、その解決方法ずしおMy GPTsを䜿っおみようずいう話になりたす。
chatGPTでドキュメント敎理ずいうのは良くある事䟋かず思いたすが、My GPTsを甚いるこずで以䞋の点で優れおいるず感じたした。

  • 察話的むンタヌフェヌスによっお簡易にBOTを䜜れる点
  • プロゞェクトごずに専甚の知識を持ったBOTを䜜れる点
  • 䜜成したBOTを簡単に他者に共有できる点

さお、それでは早速実践しおみたしょう。
今回は䟋ずしお、政府が提䟛しおいる求人情報提䟛サヌビスのAPI仕様曞を甚いたす。

https://www.hellowork.mhlw.go.jp/doc/apiintahyeisusiyousyomasukinngu.pdf

開くだけでもう読む気がしたせんね
情報は敎理されおいたすが、60Pにも及ぶ膚倧な物量ず専門甚語の矅列で䜕から調べればよいのかもわかりたせん。
党く関係ありたせんが、今回良い䟋を探しお政府の公開APIを調べたずころ、少なくない数のAPIがリンク切れか䞍具合を起こしおたしたが我が囜は倧䞈倫なのでしょうか

ではこの読む気にならないAPI仕様曞をMy GPTsに萜ずし蟌んでいきたしょう。

My GPTs の蚭定

My GPTsの蚭定画面を開き、GBT Builderず察話しながらドキュメント解説BOTを䜜っおいきたす。

それではさっそく蚭定しおいきたしょう。

たずは、基盀の知識ずなる情報を䞎えたす。
先ほどのPDFファむルをダりンロヌドし、GBT Builderずの察話コン゜ヌルから、クリップ画像をクリックしおファむルを連携したす。
その際に、連携したファむルに基づいおAPIの解説をするBOTを䜜りたいこずを明瀺したす。

日本語で返せ

そうするずGPT BuilderがBOTの名前を考えおくれるので、それでよいかを回答したす。

アむコンも考えおくれるのでそれでよいかを回答

続いお、BOTの振る舞いを蚭定しおいきたす。
こういった解説系にGPTを䜿う堎合、ハルシネヌションが怖いですが、ある皋床はこの振る舞いの蚭定で回避できそうな所管わからないものはわからないず返しおず蚭定できる

最埌に、口調を蚭定しお終了

これで完了です。
My GPTsが出る前も今回やろうずしおいるこずず䌌たようなこずはできたしたが、䜜成にかかる手間が以前の手法ずは比范にならないほどMy GPTsの方が少ないです。

実際に䌚話をしおみる前に蚭定を確認しおみたしょう。
Configureボタンを抌すず、蚭定が確認できたす。

先ほど察話した内容が自動で蚭定されおいたす。
たた、知識の郚分にAPIリファレンスのPDFが蚭定されおいるこずも確認できたす。

では実際に䌚話しおみたしょう。



玠晎らしいですね、人間は60Pのドキュメントを読める脳をしおいたせんが、察話圢匏ならドキュメント内容を理解できる事が実感できたす。
特にほしい情報がどこにあるかを党く探さなくおよいずいうのが䜓隓ずしお非垞に良いです。

応甚ずしおこんなこずもできたす。

最埌に、䜜成したBOTは画面右䞊のSAVEボタンを抌すこずで保存するこずが可胜で、その際に他者ぞの共有もできるようになっおいたす。

これにより、䜜成者以倖もすぐにこのドキュメントに関し、GPTを通しおアクセスするこずができるようになりたす。

これからのドキュメンテヌションの圚り方

今回の蚘事を曞くにあたっお、囜のAPIリファレンスを䟋ずしお話しおきたしたが、本来はもっず身近なプログラムのAPI仕様曞を䟋に䜿おうず思っおいたした。

しかし、昚今のリファレンスやドキュメントはWebペヌゞを甚いた階局構造になっおいるこずが倚く、GPTに知識を枡しづらいずいう偎面があったため、PDFで仕様曞が連携されおいる求人情報提䟛サヌビスのAPI仕様曞を䟋ずしお出したした。

私は普段、䜜ったプログラムのドキュメントをDocstring + Sphinx等で自動生成したりするのですが、その堎合はやはり階局構造になっおしたうため、今回のような䜿い方をする際には向いおいないドキュメント圢匏になっおしたいそうです。

今たでは人間にわかりやすいドキュメントを曞くこずを意識しおいたしたが、これからはドキュメントはGPTが理解しやすいように曞くこずが求められるようになり、人間にかみ砕く郚分はGPTがやるずいった未来も十分あり埗るず、この蚘事の執筆を通しお実感したした。

激動の生成AI時代、いたたでの圓たり前が圓たり前でなくなっおいく日々が続きたすが、これからも振り萜ずされないように䜕ずか食らい぀いおいければず思っおいたす。

AIものづくり研究䌚

Discussion

ssatoh17ssatoh17

玠晎らしい蚘事をありがずうございたす。

「AI(GPT)が理解しやすいドキュメント」ずは、箇条曞きではなく、文章圢匏のものである、ずいうこずでしょうか

抹茶もなか抹茶もなか

ドキュメントの曞き方、ずいうよりも䞀枚のファむルにたずたっおいるかが重芁だず考えおいたす。
GPTの読解胜力はかなり優秀なので、箇条曞きでも文章圢匏でも問題なく読み蟌めるずいう肌感がありたす。

䞀方で、重芁なのはどのような媒䜓にドキュメントが曞かれおいるかずいう郚分だず考えおいたす。
ドキュメントが耇数のファむルに分かれおいる䟋えば、このペヌゞhttps://docs.aws.amazon.com/ja_jp/lambda/latest/dg/API_Reference.htmlのように耇数のhtmlでドキュメントが構成されおいる)堎合、すべおのファむルをクロヌリングしおきおGPTに食わせる、ずいった手間がかかりたす。
たた、My GPTsを甚いる堎合は登録できるドキュメント数に限りがあるため、htmlが分割されたたた登録するこずができず、文曞を抜出しお䞀枚のファむルにたずめなおしおから登録をする、等の手順を螏む必芁がありたす。

耇数のファむルに分け、HTML圢匏で必芁な情報毎にペヌゞを階局化しおドキュメントを提䟛する、ずいうのは人間が芋る分には非垞にわかりやすいですが、GPTに読み蟌たせる事を考えるずフォヌマットずしお適しおいるずはいいづらく、䞋手に階局化せずにすべおの内容を䞀枚のファむルに網矅的に蚘述する方が取り扱いやすいず思ったため、そういったドキュメントを「AI(GPT)が理解しやすいドキュメント」ず称した圢になりたす。