Les extensions Vertex AI permettent aux LLM de se connecter à des données et des actions réelles via des API.
Les extensions traitent les requêtes utilisateur et communiquent avec de grands modèles de langage (LLM) pour exécuter des opérations pour le compte d'une application, telle qu'une application de chat.
Par exemple, supposons que vous créiez une extension Vertex AI pour une API de location de voiture, et que cette extension soit associée à une application de chat. Lorsqu'un utilisateur demande à l'application de louer une voiture, l'IA générative comprend le contexte de la question et appelle l'API d'extension permettant de louer une voiture.
Figure 1. Extension Vertex AI connectée à une application de chat du service client.
Le hub d'API simplifie la création d'extensions Vertex AI
Le hub d'API simplifie le processus de création d'une extension Vertex AI en utilisant les métadonnées existantes du hub d'API. Les données clés utilisées par le hub d'API pour créer une extension sont une spécification d'API et un déploiement, qui sont déjà validés par le hub d'API. La spécification fournit les opérations de l'API à l'extension, et le déploiement fournit le point de terminaison du serveur de l'API.
Créer une extension Vertex AI
Pour créer une extension Vertex AI dans l'API Hub :
Console
Pour créer une extension :
Dans la console Google Cloud, accédez à la page API du hub d'API.
Recherchez l'API à laquelle vous souhaitez ajouter une extension. Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API.
Si besoin, utilisez l'option Rechercher pour trouver une API.
Cliquez sur une API pour afficher sa page d'informations détaillées.
Cliquez sur Créer une extension Vertex.
Spécifiez les détails de l'extension dans le formulaire Créer une extension Vertex :
Nom de l'extension : (obligatoire) vous devez indiquer un nom d'extension.
Description (obligatoire) : ajoutez une description de l'extension.
Version : (obligatoire) sélectionnez une version d'API.
Fichier de spécification : (obligatoire) si une spécification est associée à la version de l'API, elle est automatiquement renseignée dans ce champ. Consultez la section Gérer les spécifications d'API.
Déploiement : (obligatoire) Si un déploiement est associé à la version de l'API, il est automatiquement renseigné dans ce champ. Consultez la section Gérer les déploiements.
Cliquez sur Créer une extension. Si vous ajoutez l'extension à la version par défaut, elle apparaît dans la section Extensions de la page d'informations de l'API. Si vous avez ajouté l'extension à une autre version, vous devez consulter la page d'informations de la version pour voir l'extension répertoriée.
Afficher la liste des extensions Vertex AI
Cette section explique comment lister les extensions de Vertex.
Console
Pour afficher toutes les extensions associées à une API enregistrée dans la console, procédez comme suit :
Dans la console Google Cloud, accédez à la page API Hub.
Localisez l'API que vous souhaitez inspecter. Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API.
Si besoin, utilisez l'option Rechercher pour trouver une API.
Sélectionnez une API.
Toutes les extensions ajoutées à la version par défaut sont listées dans la section "Extensions" de la page "Détails de l'API". Si une extension a été ajoutée à une autre version, vous devez consulter la page des informations de la version pour voir l'extension répertoriée.
Obtenir les détails de l'extension Vertex AI
Cette section explique comment obtenir des informations détaillées sur une extension Vertex AI.
Console
Pour afficher les détails de l'extension Vertex AI dans la console, procédez comme suit :
Dans la console Google Cloud, accédez à la page API Hub.
Localisez l'API que vous souhaitez inspecter. Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API.
Si besoin, utilisez l'option Rechercher pour trouver une API.
Sélectionnez une API.
Toutes les extensions ajoutées à la version par défaut sont répertoriées dans la section "Extensions" de la page d'informations de l'API. Si une extension a été ajoutée à une autre version, vous devez consulter la page des informations de la version pour voir l'extension répertoriée. Dans le tableau Extensions Vertex, cliquez sur une extension pour afficher ses informations détaillées.
Supprimer une extension Vertex AI
Cette section explique comment supprimer une extension Vertex.
Console
Pour supprimer une extension :
Dans la console Google Cloud, accédez à la page API Hub.
Localisez l'API qui inclut l'extension que vous souhaitez supprimer. Utilisez l'option Filtrer pour spécifier des mots clés afin de filtrer la liste des API.
Si besoin, utilisez l'option Rechercher pour trouver une API.
Sélectionnez une API.
Recherchez l'extension à supprimer.
Toutes les extensions ajoutées à la version par défaut sont répertoriées dans la section "Extensions" de la page des détails de l'API. Si une extension a été ajoutée à une autre version, vous devez consulter la page des informations de la version pour voir l'extension répertoriée.
Dans le menu Actions (à droite de la ligne contenant l'extension), cliquez sur Supprimer.
Sauf indication contraire, le contenu de cette page est régi par une licence Creative Commons Attribution 4.0, et les échantillons de code sont régis par une licence Apache 2.0. Pour en savoir plus, consultez les Règles du site Google Developers. Java est une marque déposée d'Oracle et/ou de ses sociétés affiliées.
Dernière mise à jour le 2025/09/03 (UTC).
[[["Facile à comprendre","easyToUnderstand","thumb-up"],["J'ai pu résoudre mon problème","solvedMyProblem","thumb-up"],["Autre","otherUp","thumb-up"]],[["Difficile à comprendre","hardToUnderstand","thumb-down"],["Informations ou exemple de code incorrects","incorrectInformationOrSampleCode","thumb-down"],["Il n'y a pas l'information/les exemples dont j'ai besoin","missingTheInformationSamplesINeed","thumb-down"],["Problème de traduction","translationIssue","thumb-down"],["Autre","otherDown","thumb-down"]],["Dernière mise à jour le 2025/09/03 (UTC)."],[[["\u003cp\u003eThis guide outlines the process of creating, listing, viewing, and deleting Vertex AI extensions within API hub, which applies to both Apigee and Apigee hybrid.\u003c/p\u003e\n"],["\u003cp\u003eVertex AI extensions enable large language models (LLMs) to interact with real-world data and actions through APIs, streamlining integration with applications like chat services.\u003c/p\u003e\n"],["\u003cp\u003eAPI hub simplifies the creation of Vertex AI extensions by leveraging existing API metadata, including API specifications and deployments, already validated within API hub.\u003c/p\u003e\n"],["\u003cp\u003eCreating a Vertex AI extension requires specifying details like the extension's name, description, API version, specification file, deployment, and optional authentication settings.\u003c/p\u003e\n"],["\u003cp\u003eExtensions can be viewed, managed, and deleted through the API hub console by navigating to the respective API's details page and accessing the extensions section, either in the default version or a specific version's details.\u003c/p\u003e\n"]]],[],null,["# Create Vertex AI extensions\n\n*This page\napplies to **Apigee** and **Apigee hybrid**.*\n\nThis topic explains how to create [Vertex AI extensions](/vertex-ai/generative-ai/docs/extensions/overview) within API hub.\n\nWhat is a Vertex AI extension?\n------------------------------\n\nVertex AI extensions allow LLMs to connect to real-world data and actions through APIs.\nExtensions process user queries and communicate\nwith large language models (LLMs) to execute operations on behalf of an application, such as\na chat app.\n\nFor example, suppose you create a Vertex AI extension for a car rental API, and this extension is linked\nto a chat application. When a user asks the application about renting a car, the generative AI understands\nthe context of the question and calls the extension API to rent a car.\n**Figure 1.** Vertex AI extension connected to a customer-service chat app.\n\nFor more information about Vertex AI extensions, see [Extensions overview](/vertex-ai/generative-ai/docs/extensions/overview).\n\nAPI hub streamlines Vertex AI extension creation\n------------------------------------------------\n\nAPI hub streamlines the process of creating a Vertex AI extension by using existing API hub\nmetadata. The key data used by API hub to create an extension are an API specification and\na deployment, which, conveniently, are already validated by API hub. The specification provides the operations of the API to the extension, and the\ndeployment provides the server endpoint of the API.\n\nCreate a Vertex AI extension\n----------------------------\n\nTo create a Vertex AI extension in API hub: \n\n### Console\n\nTo create an extension:\n\n1. In the Google Cloud console, go to the **APIs** page in **API hub**.\n\n [Go to API hub](https://console.cloud.google.com/apigee/api-hub/apis)\n2. Locate the API where you want to add an extension. Use [Filter](./search-apis#filter) to specify keywords to filter the list of APIs. If needed, use [Search](./search-apis) to locate an API.\n3. Click the API to view its details page.\n4. Click **Create Vertex Extension**.\n5. Specify extension details in the **Create a Vertex Extension** form:\n 1. **Extension name:** (Required) Enter a name for the extension.\n 2. **Description**: (Required) Add a description of the extension.\n 3. **Version**: (Required) Select an API version.\n 4. **Specification file** : (Required) If a specification is linked to the API version, it is automatically populated in this field. See [Manage API specifications](./manage-specifications). Vertex AI extension only supports OpenAPI specification files in YAML format. The spec file size limit is 1 MB.\n 5. **Deployment** : (Required) If a deployment is linked to the API version, it is automatically populated in this field. See [Manage deployments](./manage-api-deployments). **Note:** Because Vertex extensions only support one server endpoint per specification, we cannot allow deployments with multiple server endpoints. If a deployment contains multiple endpoints, we pick the first one.\n 6. **Authentication** : (Optional) Select an authentication type. The following authentication types are supported:\n - **No authentication**: Select this option if your extension does not require authentication.\n - **API key** : Use an API key for authentication. If selected, provide the following inputs:\n 1. **Parameter name**: Enter the name of the API key.\n 2. **API key Secret** : Enter the Secret Manager resource string that stores your API key. Use one of the following formats:\n - Global Secret: `projects/`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`/secrets/`\u003cvar translate=\"no\"\u003eSECRET_ID\u003c/var\u003e`/versions/`\u003cvar translate=\"no\"\u003eVERSION\u003c/var\u003e\n - Regional Secret: `projects/`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`/locations/`\u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e`/secrets/`\u003cvar translate=\"no\"\u003eSECRET_ID\u003c/var\u003e`/versions/`\u003cvar translate=\"no\"\u003eVERSION\u003c/var\u003e\n\n Where:\n - \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: Your Google Cloud project ID.\n - \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e: The region where the secret is stored (for example, `us-central1`). This is only required for regional secrets.\n - \u003cvar translate=\"no\"\u003eSECRET_ID\u003c/var\u003e: The name of your Secret Manager secret.\n - \u003cvar translate=\"no\"\u003eVERSION\u003c/var\u003e: The version of the secret.\n\n For more information about Secret Manager, see [Secret Manager documentation](/secret-manager/docs).\n 3. **HTTP element location**: Choose the location where the API key is stored in the HTTP request.\n - **HTTP basic** : Use HTTP basic authentication. If selected, provide the [SecretManager](/secret-manager) secret version resource that stores the base64-encoded credential in the **Credential secret** field. Use one of the following formats:\n - Global Secret: `projects/`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`/secrets/`\u003cvar translate=\"no\"\u003eSECRET_ID\u003c/var\u003e`/versions/`\u003cvar translate=\"no\"\u003eVERSION\u003c/var\u003e\n - Regional Secret: `projects/`\u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e`/locations/`\u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e`/secrets/`\u003cvar translate=\"no\"\u003eSECRET_ID\u003c/var\u003e`/versions/`\u003cvar translate=\"no\"\u003eVERSION\u003c/var\u003e\n\n Where:\n - \u003cvar translate=\"no\"\u003ePROJECT_ID\u003c/var\u003e: Your Google Cloud project ID.\n - \u003cvar translate=\"no\"\u003eLOCATION\u003c/var\u003e: The region where the secret is stored (for example, `us-central1`). This is only required for regional secrets.\n - \u003cvar translate=\"no\"\u003eSECRET_ID\u003c/var\u003e: The name of your Secret Manager secret.\n - \u003cvar translate=\"no\"\u003eVERSION\u003c/var\u003e: The version of the secret.\n\n To learn more about authentication types, see [Authentication configuration](/vertex-ai/generative-ai/docs/extensions/create-extension#authentication_configuration).\n6. Click **Create Extension**. If you add the extension to the default version, the extension will show up in the Extensions section of the API details page. If you added the extension to another version, you'll have to view the version's details page to see the extension listed there.\n\nList Vertex AI extensions\n-------------------------\n\nThis section explains how to list vertex extensions. \n\n### Console\n\nTo view all the extensions associated with a registered API in the console:\n\n1. In the Google Cloud console, go to the **API hub** page.\n\n [Go to API hub](https://console.cloud.google.com/apigee/api-hub/apis)\n2. Click **APIs**.\n3. Locate the API you wish to inspect. Use [Filter](./search-apis#filter) to specify keywords to filter the list of APIs. If needed, use [Search](./search-apis) to locate an API.\n4. Select an API.\n5. Any extensions that were added to the default version are listed in the Extensions section of the API details page. If an extension was added to another version, you'll have to view the version's details page to see the extension listed there.\n\nGet Vertex AI extension details\n-------------------------------\n\nThis section explains how to get the details about a Vertex AI extension. \n\n### Console\n\nTo view Vertex AI extension details in the console:\n\n1. In the Google Cloud console, go to the **API hub** page.\n\n [Go to API hub](https://console.cloud.google.com/apigee/api-hub/apis)\n2. Click **APIs**.\n3. Locate the API you wish to inspect. Use [Filter](./search-apis#filter) to specify keywords to filter the list of APIs. If needed, use [Search](./search-apis) to locate an API.\n4. Select an API.\n5. Any extensions that were added to the default version are listed in the Extensions section of the API details page. If an extension was added to another version, you'll have to view the version's details page to see the extension listed there. In the **Vertex extensions** table, click an extension to see its details page.\n\nDelete a Vertex AI extension\n----------------------------\n\nThis section explains how to delete a Vertex extension. \n\n### Console\n\nTo delete an extension:\n\n1. In the Google Cloud console, go to the **API hub** page.\n\n [Go to API hub](https://console.cloud.google.com/apigee/api-hub/apis)\n2. Click **APIs**.\n3. Locate the API that includes the extension you wish to delete. Use [Filter](./search-apis#filter) to specify keywords to filter the list of APIs. If needed, use [Search](./search-apis) to locate an API.\n4. Select an API.\n5. Locate the extension to delete. Any extensions that were added to the default version are listed in the Extensions section of the API details page. If an extension was added to another version, you'll have to view the version's details page to see the extension listed there.\n6. From the **Actions** menu (the right side of the row containing the extension), click **Delete**."]]
