Documentation sur Oracle Cloud Infrastructure

Clés d'API

Les clés d'API du service d'intelligence artificielle générative pour OCI sont des jetons de données d'identification sécurisés utilisés pour authentifier les appelants et autoriser l'accès aux grands modèles de langage hébergés par le service d'intelligence artificielle générative pour OCI.

À propos de la clé d'API

Une clé d'API du service d'intelligence artificielle générative pour OCI est un jeton de clé secrète (chaîne) propre au service d'intelligence artificielle générative pour OCI. Vous pouvez générer une clé d'API et l'utiliser pour accéder aux grands modèles de langage hébergés par le service.

Cette clé d'API est différente d'une clé d'API IAM OCI, qui utilise une paire de clés publique/privée pour fournir un accès à la location OCI général.

Fonctionnement de la clé d'API

Chaque clé d'API du service d'intelligence artificielle générative pour OCI comprend deux clés secrètes distinctes, telles que key-one et key-two. Les deux secrets sont des chaînes uniques.

  • Vous créez la clé d'API au moyen du service d'intelligence artificielle générative et de son nom, puis vous définissez les dates d'expiration de ses deux clés secrètes.
  • Chaque clé secrète fournit le même niveau d'accès et est liée à la même clé d'API. Vous pouvez utiliser une clé secrète de manière interchangeable dans des applications.
  • Lorsque votre application appelle un point d'extrémité de modèle du service d'intelligence artificielle générative pour OCI, incluez l'une des clés secrètes dans l'en-tête d'autorisation.
Important

La clé d'API doit se trouver dans la même région que le modèle avec lequel vous voulez l'utiliser.

Comment utiliser la clé d'API

Vous pouvez générer des clés d'API du service d'intelligence artificielle générative pour OCI et les utiliser pour accéder à des points d'extrémité de modèle de langage volumineux hébergés par le service d'intelligence artificielle générative à l'aide de l'API REST ou de la trousse SDK openai native. Voici les étapes pour utiliser les clés d'API.

  1. Dans le service d'intelligence artificielle générative pour OCI, créez une clé d'API dans une région prise en charge pour le modèle que vous voulez utiliser.
  2. Dans OCI IAM, ajoutez des autorisations de clé d'API.
  3. Utilisez cette clé lorsque vous appelez un modèle pris en charge dans une région prise en charge au moyen des options suivantes :

Modèles pris en charge

Modèles pour l'API de achèvements de clavardage
Modèles pour l'API de réponses
Important

Appels externes aux modèles Grok xAI

Les modèles Grok xAI sont hébergés dans un centre de données OCI, dans une location provisionnée pour xAI. Les modèles Grok xAI, accessibles au moyen du service d'intelligence artificielle générative pour OCI, sont gérés par xAI.

Utilisation de clés d'API avec l'API REST

Vous pouvez utiliser les clés d'API dans les en-têtes d'API REST et curl. Voici les points d'extrémité que vous pouvez utiliser pour l'API REST.

Points d'extrémité pris en charge

Achèvements de clavardage
https://inference.generativeai.<region-identifier>.oci.oraclecloud.com/20231130/actions/v1/chat/completions
Réponses possibles
https://inference.generativeai.<region-identifier>.oci.oraclecloud.com/20231130/actions/v1/responses

Exemple avec curl :

curl 
--location 'https://inference.generativeai.us-chicago-1.oci.oraclecloud.com/20231130/actions/v1/chat/completions' \
--header 'Authorization: Bearer sk-XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data '{
"model": "xai.grok-4",
"messages": [
    {
    "role": "user",
    "content": "What's the capital of France?"
    }
]
}'

Utilisation de clés d'API avec des trousses SDK OpenAI

Vous pouvez utiliser les clés d'API avec la trousse SDK OpenAI. Voici les points d'extrémité que vous pouvez utiliser pour la trousse SDK OpenAI.

Points d'extrémité pris en charge

Spécifiez base_url comme 
https://inference.generativeai.<region-identifier>.oci.oraclecloud.com/20231130/actions/v1
Achèvements de clavardage
Utilisez cette méthode : client.chat.completions.create
Réponses possibles
Utilisez cette méthode : client.responses.create
Exemple 
from openai import OpenAI
import os

API_KEY=os.getenv("OPENAI_API_KEY")

print(API_KEY)

client = OpenAI(
    api_key=API_KEY,
    base_url="https://inference.generativeai.us-chicago-1.oci.oraclecloud.com/20231130/actions/v1"
)

# Responses API
response = client.responses.create(
    model="openai.gpt-oss-120b",
    # model="xai.grok-3",
    # meta models are not supported with the Responses API
    input="Write a one-sentence bedtime story about a unicorn."
)
print(response)

# Completion API
response = client.chat.completions.create(
    # model="openai.gpt-oss-120b",
    # model="meta.llama-3.3-70b-instruct",
    model="xai.grok-3",
    messages=[{
        "role": "user", 
        "content": "Write a one-sentence bedtime story about a unicorn."
        }
    ]
)
print(response)
Référence
Référentiel Oracle GitHub

Régions prises en charge

Régions

Pour les trousses SDK OpenAI, les régions OCI prises en charge à utiliser avec les clés d'API sont limitées aux éléments suivants :

  • Allemagne - Centre (Francfort)
  • Inde - Sud (Hyderabad)
  • Japon - Centre (Osaka)
  • États-Unis - Est (Ashburn)
  • États-Unis - Midwest (Chicago)
  • États-Unis - Ouest (Phoenix)

Pour confirmer les régions utilisables d'un modèle pour l'ensemble OCI OpenAI, effectuez les tâches suivantes.

  1. Ouvrez la carte du modèle dans la documentation sur l'IA générative :
  2. Notez les régions répertoriées pour ce modèle.
  3. Sélectionnez une région pour le modèle qui s'affiche dans les deux régions disponibles du modèle ET dans les six régions OCI OpenAI précédentes.
  4. Vérifiez si le modèle est disponible dans le mode dont vous avez besoin (sur demande ou dédié).

    Pour l'accès aux modèles en mode dédié, les points d'extrémité publics et privés sont pris en charge.

Rotation ou remplacement d'une clé

Pour effectuer la rotation d'une clé d'API du service d'intelligence artificielle générative pour OCI, vous pouvez modifier son état dans la console OCI ou à l'aide de l'opération SetApiKeyState avec l'API. Voici les étapes :

  1. Activez la clé secrète de secours. Activez la clé secrète non utilisée (par exemple, key-two) et mettez à jour vos applications pour l'utiliser.
  2. Vérifiez le basculement. Confirmez que les demandes s'authentifient avec la clé secrète nouvellement activée et que les charges de travail se poursuivent sans interruption.
  3. Révoquer ou désactiver la première clé secrète.
    • Si vous soupçonnez une fuite ou qu'il est temps de retirer le premier secret, révoquez-le. Une fois la modification propagée, les demandes utilisant la clé secrète révoquée sont rejetées. La révocation d'une clé secrète la désactive définitivement et l'action est irréversible.
    • Si vous prévoyez de réutiliser la première clé secrète, désactivez-la. Une fois la modification propagée, les demandes utilisant la clé secrète désactivée sont rejetées jusqu'à ce que vous la réactiviez.
    Conseil

    Désactiver une clé secrète pour une suspension ou une enquête à court terme. Révoquer une clé secrète si elle a été compromise ou si vous devez la retirer définitivement.

Pour savoir comment effectuer ces tâches, voir Gestion des clés d'API.

Important

Copiez immédiatement les clés secrètes nouvelles ou régénérées et stockez-les en toute sécurité. Ils n'apparaissent qu'une seule fois.

Meilleures pratiques

Stockez toujours les clés secrètes de clé de l'API du service d'intelligence artificielle générative pour OCI dans un gestionnaire de clés secrètes approuvé. Ne les confiez jamais au contrôle de la source ou ne les intégrez jamais dans du code côté client.

  • Utilisez la configuration à deux clés secrètes pour une rotation fluide sans temps d'arrêt et définissez des expirations pour actualiser régulièrement les clés.
  • Limitez l'accès aux clés à l'aide de compartiments et de politiques offrant le moins de privilèges.
  • Surveillez l'utilisation, configurez des alertes et faites pivoter les clés immédiatement si vous détectez une activité suspecte.

Gestion des clés d'API

Après avoir obtenu l'autorisation IAM pour la ressource de clé d'API du service d'intelligence artificielle générative pour OCI, vous pouvez gérer les clés d'API à l'aide des opérations suivantes :

Exemples sur GitHub

Pour une expérience pratique, voir des exemples dans le référentiel Oracle GitHub.