何が問題か
Azure OpenAIのAPIバージョンはとても早いスパンで更新されています。
それゆえ、公式ドキュメントへの反映が間に合っていないことがあります。
例えば以下の画像は、2023/12/7時点での公式ドキュメントに記載されている「サポートされているAPIバージョン」の一覧です。
実際にはこの時点で以下の３つのバージョンがドキュメントに掲載されいないが、実際にはすでに定義されてCallできる状態になっています。
- 2023-09-01-preview
- 2023-10-01-preview
- 2023-12-01-preview
この記事では、最新のAzure OpenAIのAPIバージョンとその中のインターフェース（スキーマ）を確認する方法を紹介します。
確認する方法
Azure OpenAIに限らずAzureサービスのAPIインターフェースは基本的にはOpenAPI形式で定義され、GitHubで公開されています。
Azure OpenAIのAPIバージョンには安定版のstableとプレビュー版のpreviewがあります。
特にPreviewは安定版ではないためリリースされてもアナウンスが大々的に行われることは少ない一方で、最近だとJSON Modeが使えるようになったり、と最新の機能がPreviewでリリースされていることが多いです。ただしPreview版はその名の通りプレビュー状態なので、問題が発生した場合でもサポートが受けられない可能性や、仕様が変更されたり、早めにディスコンになったりする可能性があります。
以下のリンクからStable/PreviewのAPI定義を確認できます。パスを見るとわかりますがどちらも上記のAzureのAPI定義が置かれているリポジトリの中にあります。
Stable
Preview
上記のいずれかにアクセスすると、APIのバージョン一覧が表示されるので確認したいバージョンを選択します。
各バージョンの中にはinference.jsonファイルがあるので、それを選択します。
すると、APIのインターフェース定義が表示されます。これがOpenAPI形式で定義されたそのバージョンのAPIインターフェース定義です。
この定義が確認できれば後はいかようにでもツールを使ってクライアントコードを生成したり、ドキュメントを生成したりできますが、今回Swagger UIを使ってインターフェースを確認だけしてみます。
「Raw」を選択します。
.jsonで終わるjsonファイルのURLを取得します。
Swagger UIにアクセスして、先ほど取得したURLを入力し、「Explore」をクリックします。
これで特定バージョンのAPIインターフェースを確認できました。ちなみに、Swagger UIを使うと実際にAPIを呼び出すこともできます。
Discussion