APIリファレンスの使い方

いきなりこのようなリファレンスマニュアルを読んでゆくものでは無いでしょう。何か実装するときに、これを読むより先に近い処理のサンプルコードを見ることが多いと思います。丸パクリできるならそれをそのまま使い、自分の要件に足りない処理があるならそれを実装するためのロジックを考え、それを実現する際に必要な（サンプルコードに出てこない）APIを探す時に、このようなリファレンスを紐解きます。

また既存コードのメンテをしていて知らないAPIがあったり、その仕様を知りたい時にリファレンスに当たることも多いです。エンジニアとして強いなどとはと関係なく、いずれもごく自然な使い方です。

（続き）何を読み取るのか。APIはApplication Programming Interface、つまりインターフェースであり、APIを利用する呼び出し元が居て、APIの先には処理の実装があります。そしてその両者のやり取りはまさにインターフェースを介して行われるので、その仕様が肝要です。

簡単に言うと「入力としてどういう値を入れたら、どういう値が処理の結果として戻って来るのか」の定義です。入力値はひとつだけではなく複数のケースも多くあるし、値のデータとしての型（分かりやすく言うと数字なのか文字なのか、それらの組み合わせた型なのか、のような分類）も千差万別有り得ます。そのようなデータ型を含め、インターフェースの仕様がAPIリファレンスでは定義されています。

このライブラリを使いたいなら初めに見るのはReadme.mdでそこからQuickstart, FAQs, Examplesなどを見ていき、基本的な使い方で動かしてみます。APIリファレンスは辞書なので、最初から読むものではなくサンプルコードに載っているオプションの意味を調べるようなとっかかりがよいと思います。今風ならNotebookLMにリファレンスを全部入れた状態でやりたいことを実現できるメソッドを聞いてみるのもいいかもしれません。