Schéma YAML des connexions Recherche Azure AI avec CLI (v2)
S’APPLIQUE À : Extension ml Azure CLI v2 (actuelle)
Remarque
La syntaxe YAML détaillée dans ce document est basée sur le schéma JSON pour la dernière version de l’extension ML CLI v2. Le fonctionnement de cette syntaxe est garanti uniquement avec la dernière version de l’extension ML CLI v2. Vous trouverez les schémas des versions d’extension plus anciennes sur https://azuremlschemasprod.azureedge.net/.
Syntaxe YAML
Clé | Type | Description | Valeurs autorisées | Valeur par défaut |
---|---|---|---|---|
$schema |
string | Schéma YAML. Si vous utilisez l’extension de Visual Studio Code pour Azure Machine Learning afin de créer le fichier YAML, incluez $schema en haut de votre fichier pour appeler les complétions du schéma et de la ressource. |
||
name |
string | Obligatoire. Nom de la connexion. | ||
description |
string | La description de la connexion. | ||
tags |
object | Le dictionnaire des étiquettes de connexion. | ||
type |
string | Obligatoire. Type de la connexion. | azure_ai_search |
azure_ai_search |
is_shared |
booléen | true si la connexion est partagée avec d’autres projets du hub. Sinon, false . |
true |
|
endpoint |
string | Obligatoire. URL du point de terminaison. | ||
api_key |
string | La clé API utilisée pour authentifier la connexion. Si elle n’est pas fournie, la connexion est authentifiée via l’ID Microsoft Entra (authentification sans informations d’identification). |
Notes
Même si les commandes az ml connection
peuvent être utilisées pour gérer à la fois les connexions Azure Machine Learning et Azure AI Studio, la connexion Recherche Azure AI est spécifique à Azure AI Studio.
Exemples
Ces exemples sont sous la forme de fichiers YAML et utilisés à partir de l’interface CLI. Par exemple : az ml connection create -f <file-name>.yaml
.
YAML : clé API
#AzureContentSafetyConnection.yml
name: myazaics_apk
type: azure_ai_search
endpoint: https://contoso.search.windows.net/
api_key: XXXXXXXXXXXXXXX
YAML : Microsoft Entra ID (préversion)
#AzureContentSafetyConnection.yml
name: myazaics_ei
type: azure_ai_search
endpoint: https://contoso.search.windows.net/