CLI (v2) Esquema YAML de conexão do Azure AI Search
APLICA-SE A: Azure CLI ml extension v2 (atual)
Nota
A sintaxe YAML detalhada neste documento é baseada no esquema JSON para a versão mais recente da extensão ML CLI v2. Esta sintaxe é garantida apenas para funcionar com a versão mais recente da extensão ML CLI v2. Você pode encontrar os esquemas para versões de extensão mais antigas em https://azuremlschemasprod.azureedge.net/.
Sintaxe YAML
Chave | Tipo | Description | Valores permitidos | Default value |
---|---|---|---|---|
$schema |
string | O esquema YAML. Se você usar a extensão de código do Visual Studio do Aprendizado de Máquina do Azure para criar o arquivo YAML, inclua $schema na parte superior do arquivo para invocar o esquema e as completações de recursos. |
||
name |
string | Obrigatório. O nome da conexão. | ||
description |
string | A descrição da conexão. | ||
tags |
objeto | O dicionário de marcas de conexão. | ||
type |
string | Obrigatório. O tipo de conexão. | azure_ai_search |
azure_ai_search |
is_shared |
boolean | true se a conexão for compartilhada entre outros projetos no hub; caso contrário, false . |
true |
|
endpoint |
string | Obrigatório. A URL do ponto de extremidade. | ||
api_key |
string | A chave de API usada para autenticar a conexão. Se não for fornecida, a conexão será autenticada por meio do Microsoft Entra ID (autenticação sem credenciais). |
Observações
Embora os az ml connection
comandos possam ser usados para gerenciar as conexões do Azure Machine Learning e do Azure AI Studio, a conexão do Azure AI Search é específica do Azure AI Studio.
Exemplos
Esses exemplos seriam na forma de arquivos YAML e usados a partir da CLI. Por exemplo, az ml connection create -f <file-name>.yaml
.
YAML: Chave API
#AzureContentSafetyConnection.yml
name: myazaics_apk
type: azure_ai_search
endpoint: https://contoso.search.windows.net/
api_key: XXXXXXXXXXXXXXX
YAML: ID do Microsoft Entra (visualização)
#AzureContentSafetyConnection.yml
name: myazaics_ei
type: azure_ai_search
endpoint: https://contoso.search.windows.net/