初めに
OCI Enterprise AI を使うときに、最初に確認しておきたいページをまとめます。
今回は、以下の内容を中心に確認します。
1. Project の作成
2. API Key の作成
3. Supported API Endpoint の確認
4. 利用できる Generative AI Models の確認
5. OCI OpenAI-Compatible Endpoints の確認
OCI Enterprise AI は、OpenAI 互換の API 形式で利用できるため、既存の OpenAI API に慣れている場合でも比較的理解しやすいです。
ただし、OCI では Project、API Key、Region、Model、Endpoint などを確認してから使う必要があります。
この記事では、詳しい実装ではなく、まずどの公式ドキュメントや参考記事を見るべきかを整理します。
■ Project の作成
OCI Enterprise AI を使う場合、まず Project を作成します。
Project は、OCI Generative AI 上で AI アプリケーションやエージェント関連のリソースを管理するための単位です。
Project ごとに、会話、ファイル、コンテナ、メモリーなどを分けて管理できます。
Project の作成手順は、以下の記事が参考になります。
この記事では、OCI コンソールから Generative AI を開き、Project を作成する流れが画面付きで説明されています。
確認するポイントは以下です。
- Project 名
- 説明
- コンパートメント
- レスポンス保持期間
- 会話保持期間
- メモリー設定
まず検証するだけであれば、細かいメモリー設定はデフォルトに近い形でも進められます。
■ API Key の作成
次に API Key を作成します。
API Key は、アプリケーションから OCI Enterprise AI の API を呼び出すために使う認証情報です。
API Key の作成手順は、以下の記事が参考になります。
確認するポイントは以下です。
- API Key 名
- 説明
- コンパートメント
- Key one name
- Key expiration date/time
- Key two name
- Key expiration date/time
API Key は作成するだけではなく、必要な権限も追加する必要があります。
ここは忘れやすいポイントです。
API Key を作成する
+
必要な IAM 権限を設定する
=
API から利用できる
検証用と本番用では、API Key を分けて管理するのが良いと思います。
■ Supported API Endpoint の確認
API Key を作成したら、次に API Endpoint を確認します。
OCI Chat Completions API の Supported API Endpoint は、以下の公式ドキュメントで確認できます。
このページでは、Chat Completions API の Base URL と Endpoint Path を確認できます。
形式は以下です。
Base URL:
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1
Endpoint Path:
/chat/completions
つまり、実際に使う URL は以下のようになります。
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1/chat/completions
${region} には、自分が利用する OCI リージョンを入れます。
例です。
https://inference.generativeai.us-chicago-1.oci.oraclecloud.com/openai/v1/chat/completions
Chat Completions API は、既存の OpenAI Chat Completions API 形式に近い形で使いたい場合に確認すると分かりやすいです。
■ Generative AI Models by Region の確認
次に、利用できる LLM を確認します。
OCI Generative AI のモデルは、リージョンによって利用可否が異なります。
Asia Pacific のモデル対応状況は、以下の公式ドキュメントで確認できます。
ここでは、リージョンごとにどのモデルが利用できるかを確認できます。
確認するポイントは以下です。
- 利用したいリージョン
- 利用したいモデル
- on-demand で利用できるか
- Dedicated AI Cluster が必要か
ドキュメント上では、モデルの利用可否が記号で表示されています。
✓ 利用可能
✓o on-demand only
✓d dedicated AI clusters only
- 利用不可
たとえば日本リージョンで使う場合は、Japan Central (Osaka) の列を確認します。
モデルを選ぶときは、モデル名だけでなく、そのリージョンで本当に利用できるかを確認することが大事です。
■ OCI OpenAI-Compatible Endpoints の確認
OCI Enterprise AI では、OpenAI-compatible endpoint も提供されています。
詳細は以下の公式ドキュメントで確認できます。
このページでは、OCI で利用できる OpenAI-compatible API の全体像を確認できます。
主な Endpoint Path は以下です。
/responses
/conversations
/chat/completions
/files
/vector_stores/{id}/files
/vector_stores/{id}/search
新しくアプリケーションを作る場合は、Responses API を中心に確認するとよいです。
既存の Chat Completions API 形式のコードを利用したい場合は、/chat/completions を確認します。
Base URL は以下です。
https://inference.generativeai.${region}.oci.oraclecloud.com/openai/v1
アプリケーション側では、最終的に以下のような情報を整理しておくと分かりやすいです。
- Region
- Base URL
- Endpoint Path
- Project OCID
- API Key
- Model name
■ まとめ
OCI Enterprise AI を使い始める前に、まず以下のリンクを確認すると全体像をつかみやすいです。
1. Project の作成
2. API Key の作成
3. Supported API Endpoint
4. Generative AI Models by Region
5. OCI OpenAI-Compatible Endpoints
特に最初は、以下の順番で確認すると分かりやすいです。
Project を作成する
↓
API Key を作成する
↓
API Endpoint を確認する
↓
使いたい Region の Model を確認する
↓
OpenAI-compatible API の使い方を確認する
いきなりコードを書くよりも、先に Project、API Key、Endpoint、Model を整理しておくと、後続の API 呼び出しがかなり分かりやすくなります。