Tato stránka obsahuje informace o podporovaných metodách ověřování a klientech. Poskytuje vzorový kód, který můžete použít k připojení výpočetních služeb k Azure OpenAI v modelech Foundry pomocí konektoru služby. Tato stránka obsahuje také výchozí názvy proměnných prostředí a hodnoty získané při vytváření připojení služeb.
Podporované výpočetní služby
Konektor služby se dá použít k připojení následujících výpočetních služeb k Azure OpenAI:
- Azure App Service
- Azure Container Apps
- Azure Functions
- Azure Kubernetes Service (AKS)
- Azure Spring Apps
Podporované typy ověřování a typy klientů
Tato tabulka ukazuje, které kombinace metod ověřování a klientů se podporují pro připojení výpočetní služby k Azure OpenAI pomocí konektoru služby. Ano označuje, že kombinace je podporovaná, zatímco "Ne" označuje, že není podporovaná.
| Typ klienta |
Spravovaná identita přiřazená systémem |
Spravovaná identita přiřazená uživatelem |
Tajný kód/připojovací řetězec |
Instanční objekt |
| platforma .NET |
Ano |
Ano |
Ano |
Ano |
| Java |
Ano |
Ano |
Ano |
Ano |
| Node.js |
Ano |
Ano |
Ano |
Ano |
| Python |
Ano |
Ano |
Ano |
Ano |
| Nic |
Ano |
Ano |
Ano |
Ano |
Tato tabulka označuje, že jsou podporovány všechny kombinace typů klientů a metod ověřování v tabulce. Všechny typy klientů můžou pro připojení k Azure OpenAI pomocí konektoru služby použít některou z metod ověřování.
Výchozí názvy proměnných prostředí nebo vlastnosti aplikace a ukázkový kód
Pomocí následujících podrobností o připojení připojte výpočetní služby k Azure OpenAI. Další informace najdete v tématu Konvence vytváření názvů konfigurace.
Spravovaná identita přiřazená systémem
| Výchozí název proměnné prostředí |
Popis |
Ukázková hodnota |
| AZURE_OPENAI_BASE |
Koncový bod Azure OpenAI |
https://<Azure-OpenAI-name>.openai.azure.com/ |
Ukázkový kód
Pokud se chcete připojit k Azure OpenAI pomocí spravované identity přiřazené systémem, projděte si následující kroky a kód.
Nainstalujte závislosti.
dotnet add package Azure.AI.OpenAI --prerelease
dotnet add package Azure.Identity
Ověřte se pomocí knihovny Identit Azure a získejte koncový bod Azure OpenAI z proměnných prostředí přidaných konektorem služby. Pokud použijete následující kód, odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.
using Azure.AI.OpenAI;
using Azure.Identity;
string endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_BASE");
// Uncomment the following lines corresponding to the authentication type you want to use.
// system-assigned managed identity
// var credential = new DefaultAzureCredential();
// user-assigned managed identity
// var credential = new DefaultAzureCredential(
// new DefaultAzureCredentialOptions
// {
// ManagedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTID");
// });
// service principal
// var tenantId = Environment.GetEnvironmentVariable("AZURE_OPENAI_TENANTID");
// var clientId = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTID");
// var clientSecret = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTSECRET");
// var credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
AzureOpenAIClient openAIClient = new(
new Uri(endpoint),
credential
);
Do souboru pom.xml přidejte následující závislosti:
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-openai</artifactId>
<version>1.0.0-beta.6</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-identity</artifactId>
<version>1.11.4</version>
</dependency>
Ověřte se pomocí azure-identity a získejte koncový bod Azure OpenAI z proměnných prostředí přidaných konektorem služby. Pokud použijete následující kód, odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.
// Uncomment the following lines corresponding to the authentication type you want to use.
// for system-managed identity
// DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
// for user-assigned managed identity
// DefaultAzureCredential credential = new DefaultAzureCredentialBuilder()
// .managedIdentityClientId(System.getenv("AZURE_OPENAI_CLIENTID"))
// .build();
// for service principal
// ClientSecretCredential credential = new ClientSecretCredentialBuilder()
// .clientId(System.getenv("AZURE_OPENAI_CLIENTID"))
// .clientSecret(System.getenv("AZURE_OPENAI_CLIENTSECRET"))
// .tenantId(System.getenv("AZURE_OPENAI_TENANTID"))
// .build();
String endpoint = System.getenv("AZURE_OPENAI_BASE");
OpenAIClient client = new OpenAIClientBuilder()
.credential(credential)
.endpoint(endpoint)
.buildClient();
Nainstalujte závislosti.
pip install openai
pip install azure-identity
Ověřte se pomocí azure-identity a získejte koncový bod Azure OpenAI z proměnných prostředí přidaných konektorem služby. Pokud použijete následující kód, odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.
import os
import OpenAI
from azure.identity import ManagedIdentityCredential, ClientSecretCredential, get_bearer_token_provider
# Uncomment the following lines corresponding to the authentication type you want to use.
# system-assigned managed identity
# cred = ManagedIdentityCredential()
# user-assigned managed identity
# managed_identity_client_id = os.getenv('AZURE_OPENAI_CLIENTID')
# cred = ManagedIdentityCredential(client_id=managed_identity_client_id)
# service principal
# tenant_id = os.getenv('AZURE_OPENAI_TENANTID')
# client_id = os.getenv('AZURE_OPENAI_CLIENTID')
# client_secret = os.getenv('AZURE_OPENAI_CLIENTSECRET')
# cred = ClientSecretCredential(tenant_id=tenant_id, client_id=client_id, client_secret=client_secret)
token_provider = get_bearer_token_provider(
cred, "https://cognitiveservices.azure.com/.default"
)
endpoint = os.getenv('AZURE_OPENAI_BASE')
client = AzureOpenAI(
api_version="2024-02-15-preview",
azure_endpoint=endpoint,
azure_ad_token_provider=token_provider
)
Nainstalujte závislosti.
npm install --save @azure/identity
npm install @azure/openai
Ověřte se pomocí @azure/identity a získejte koncový bod Azure OpenAI z proměnných prostředí přidaných konektorem služby. Pokud použijete následující kód, odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.
import { DefaultAzureCredential,ClientSecretCredential } from "@azure/identity";
// Uncomment the following lines corresponding to the authentication type you want to use.
// for system-assigned managed identity
// const credential = new DefaultAzureCredential();
// for user-assigned managed identity
// const clientId = process.env.AZURE_OPENAI_CLIENTID;
// const credential = new DefaultAzureCredential({
// managedIdentityClientId: clientId
// });
// for service principal
// const tenantId = process.env.AZURE_OPENAI_TENANTID;
// const clientId = process.env.AZURE_OPENAI_CLIENTID;
// const clientSecret = process.env.AZURE_OPENAI_CLIENTSECRET;
// const credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
const endpoint = process.env.AZURE_OPENAI_BASE;
const client = new OpenAIClient(endpoint, credential);
V jiných jazycích můžete použít informace o připojení, které Service Connector nastaví na proměnné prostředí pro připojení k Azure OpenAI. Podrobnosti o proměnné prostředí najdete v tématu Integrace Azure OpenAI s konektorem služby.
Spravovaná identita přiřazená uživatelem
| Výchozí název proměnné prostředí |
Popis |
Ukázková hodnota |
| AZURE_OPENAI_BASE |
Koncový bod Azure OpenAI |
https://<Azure-OpenAI-name>.openai.azure.com/ |
| AZURE_OPENAI_CLIENTID |
ID klienta |
<client-ID> |
Ukázkový kód
Pokud se chcete připojit k Azure OpenAI pomocí spravované identity přiřazené uživatelem, projděte si následující kroky a kód.
Nainstalujte závislosti.
dotnet add package Azure.AI.OpenAI --prerelease
dotnet add package Azure.Identity
Ověřte se pomocí knihovny Identit Azure a získejte koncový bod Azure OpenAI z proměnných prostředí přidaných konektorem služby. Pokud použijete následující kód, odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.
using Azure.AI.OpenAI;
using Azure.Identity;
string endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_BASE");
// Uncomment the following lines corresponding to the authentication type you want to use.
// system-assigned managed identity
// var credential = new DefaultAzureCredential();
// user-assigned managed identity
// var credential = new DefaultAzureCredential(
// new DefaultAzureCredentialOptions
// {
// ManagedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTID");
// });
// service principal
// var tenantId = Environment.GetEnvironmentVariable("AZURE_OPENAI_TENANTID");
// var clientId = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTID");
// var clientSecret = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTSECRET");
// var credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
AzureOpenAIClient openAIClient = new(
new Uri(endpoint),
credential
);
Do souboru pom.xml přidejte následující závislosti:
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-openai</artifactId>
<version>1.0.0-beta.6</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-identity</artifactId>
<version>1.11.4</version>
</dependency>
Ověřte se pomocí azure-identity a získejte koncový bod Azure OpenAI z proměnných prostředí přidaných konektorem služby. Pokud použijete následující kód, odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.
// Uncomment the following lines corresponding to the authentication type you want to use.
// for system-managed identity
// DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
// for user-assigned managed identity
// DefaultAzureCredential credential = new DefaultAzureCredentialBuilder()
// .managedIdentityClientId(System.getenv("AZURE_OPENAI_CLIENTID"))
// .build();
// for service principal
// ClientSecretCredential credential = new ClientSecretCredentialBuilder()
// .clientId(System.getenv("AZURE_OPENAI_CLIENTID"))
// .clientSecret(System.getenv("AZURE_OPENAI_CLIENTSECRET"))
// .tenantId(System.getenv("AZURE_OPENAI_TENANTID"))
// .build();
String endpoint = System.getenv("AZURE_OPENAI_BASE");
OpenAIClient client = new OpenAIClientBuilder()
.credential(credential)
.endpoint(endpoint)
.buildClient();
Nainstalujte závislosti.
pip install openai
pip install azure-identity
Ověřte se pomocí azure-identity a získejte koncový bod Azure OpenAI z proměnných prostředí přidaných konektorem služby. Pokud použijete následující kód, odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.
import os
import OpenAI
from azure.identity import ManagedIdentityCredential, ClientSecretCredential, get_bearer_token_provider
# Uncomment the following lines corresponding to the authentication type you want to use.
# system-assigned managed identity
# cred = ManagedIdentityCredential()
# user-assigned managed identity
# managed_identity_client_id = os.getenv('AZURE_OPENAI_CLIENTID')
# cred = ManagedIdentityCredential(client_id=managed_identity_client_id)
# service principal
# tenant_id = os.getenv('AZURE_OPENAI_TENANTID')
# client_id = os.getenv('AZURE_OPENAI_CLIENTID')
# client_secret = os.getenv('AZURE_OPENAI_CLIENTSECRET')
# cred = ClientSecretCredential(tenant_id=tenant_id, client_id=client_id, client_secret=client_secret)
token_provider = get_bearer_token_provider(
cred, "https://cognitiveservices.azure.com/.default"
)
endpoint = os.getenv('AZURE_OPENAI_BASE')
client = AzureOpenAI(
api_version="2024-02-15-preview",
azure_endpoint=endpoint,
azure_ad_token_provider=token_provider
)
Nainstalujte závislosti.
npm install --save @azure/identity
npm install @azure/openai
Ověřte se pomocí @azure/identity a získejte koncový bod Azure OpenAI z proměnných prostředí přidaných konektorem služby. Pokud použijete následující kód, odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.
import { DefaultAzureCredential,ClientSecretCredential } from "@azure/identity";
// Uncomment the following lines corresponding to the authentication type you want to use.
// for system-assigned managed identity
// const credential = new DefaultAzureCredential();
// for user-assigned managed identity
// const clientId = process.env.AZURE_OPENAI_CLIENTID;
// const credential = new DefaultAzureCredential({
// managedIdentityClientId: clientId
// });
// for service principal
// const tenantId = process.env.AZURE_OPENAI_TENANTID;
// const clientId = process.env.AZURE_OPENAI_CLIENTID;
// const clientSecret = process.env.AZURE_OPENAI_CLIENTSECRET;
// const credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
const endpoint = process.env.AZURE_OPENAI_BASE;
const client = new OpenAIClient(endpoint, credential);
V jiných jazycích můžete použít informace o připojení, které Service Connector nastaví na proměnné prostředí pro připojení k Azure OpenAI. Podrobnosti o proměnné prostředí najdete v tématu Integrace Azure OpenAI s konektorem služby.
Připojovací řetězec
| Výchozí název proměnné prostředí |
Popis |
Ukázková hodnota |
| AZURE_OPENAI_BASE |
Koncový bod Azure OpenAI |
https://<Azure-OpenAI-name>.openai.azure.com/ |
| AZURE_OPENAI_KEY |
Klíč rozhraní API Azure OpenAI |
<api-key> |
Ukázka kódu
Pokud se chcete připojit k Azure OpenAI pomocí připojovacího řetězce, projděte si následující kroky a kód.
Nainstalujte následující závislosti.
dotnet add package Azure.AI.OpenAI --prerelease
dotnet add package Azure.Core --version 1.40.0
Získejte koncový bod Azure OpenAI a klíč rozhraní API z proměnných prostředí přidaných konektorem služby.
using Azure.AI.OpenAI;
string endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_BASE")
string key = Environment.GetEnvironmentVariable("AZURE_OPENAI_KEY");
AzureOpenAIClient openAIClient = new(
new Uri(endpoint),
new AzureKeyCredential(key));
Do souboru pom.xml přidejte následující závislost:
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-core</artifactId>
<version>1.49.1</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-openai</artifactId>
<version>1.0.0-beta.6</version>
</dependency>
Získejte koncový bod Azure OpenAI a klíč rozhraní API z proměnných prostředí přidaných konektorem služby.
String endpoint = System.getenv("AZURE_OPENAI_BASE");
String key = System.getenv("AZURE_OPENAI_KEY");
OpenAIClient client = new OpenAIClientBuilder()
.credential(new AzureKeyCredential(key))
.endpoint(endpoint)
.buildClient();
Nainstalujte následující závislosti.
pip install openai
pip install azure-core
Získejte koncový bod Azure OpenAI a klíč rozhraní API z proměnných prostředí přidaných konektorem služby.
import os
from openai import AzureOpenAI
from azure.core.credentials import AzureKeyCredential
key = os.environ['AZURE_OPENAI_KEY']
endpoint = os.environ['AZURE_OPENAI_BASE']
client = AzureOpenAI(
api_version="2024-02-15-preview",
azure_endpoint=endpoint,
api_key=key
)
Nainstalujte následující závislosti.
npm install @azure/openai
npm install @azure/core-auth
Získejte koncový bod Azure OpenAI a klíč rozhraní API z proměnných prostředí přidaných konektorem služby.
import { OpenAIClient } from "@azure/openai";
import { AzureKeyCredential } from "@azure/core-auth";
const endpoint = process.env.AZURE_OPENAI_BASE;
const credential = new AzureKeyCredential(process.env.AZURE_OPENAI_KEY);
const client = new OpenAIClient(endpoint, credential);
V jiných jazycích můžete použít informace o připojení, které Service Connector nastaví na proměnné prostředí pro připojení k Azure OpenAI. Podrobnosti o proměnné prostředí najdete v tématu Integrace Azure OpenAI s konektorem služby.
Instanční objekt
| Výchozí název proměnné prostředí |
Popis |
Ukázková hodnota |
| AZURE_OPENAI_BASE |
Koncový bod Azure OpenAI |
https://<Azure-OpenAI-name>.openai.azure.com/ |
| AZURE_OPENAI_CLIENTID |
ID klienta |
<client-ID> |
| AZURE_OPENAI_CLIENTSECRET |
Tajný klíč klienta |
<client-secret> |
| AZURE_OPENAI_TENANTID |
ID vašeho tenanta |
<tenant-ID> |
Ukázkový kód
Pokud se chcete připojit k Azure OpenAI pomocí instančního objektu, projděte si následující kroky a kód.
Nainstalujte závislosti.
dotnet add package Azure.AI.OpenAI --prerelease
dotnet add package Azure.Identity
Ověřte se pomocí knihovny Identit Azure a získejte koncový bod Azure OpenAI z proměnných prostředí přidaných konektorem služby. Pokud použijete následující kód, odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.
using Azure.AI.OpenAI;
using Azure.Identity;
string endpoint = Environment.GetEnvironmentVariable("AZURE_OPENAI_BASE");
// Uncomment the following lines corresponding to the authentication type you want to use.
// system-assigned managed identity
// var credential = new DefaultAzureCredential();
// user-assigned managed identity
// var credential = new DefaultAzureCredential(
// new DefaultAzureCredentialOptions
// {
// ManagedIdentityClientId = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTID");
// });
// service principal
// var tenantId = Environment.GetEnvironmentVariable("AZURE_OPENAI_TENANTID");
// var clientId = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTID");
// var clientSecret = Environment.GetEnvironmentVariable("AZURE_OPENAI_CLIENTSECRET");
// var credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
AzureOpenAIClient openAIClient = new(
new Uri(endpoint),
credential
);
Do souboru pom.xml přidejte následující závislosti:
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-ai-openai</artifactId>
<version>1.0.0-beta.6</version>
</dependency>
<dependency>
<groupId>com.azure</groupId>
<artifactId>azure-identity</artifactId>
<version>1.11.4</version>
</dependency>
Ověřte se pomocí azure-identity a získejte koncový bod Azure OpenAI z proměnných prostředí přidaných konektorem služby. Pokud použijete následující kód, odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.
// Uncomment the following lines corresponding to the authentication type you want to use.
// for system-managed identity
// DefaultAzureCredential credential = new DefaultAzureCredentialBuilder().build();
// for user-assigned managed identity
// DefaultAzureCredential credential = new DefaultAzureCredentialBuilder()
// .managedIdentityClientId(System.getenv("AZURE_OPENAI_CLIENTID"))
// .build();
// for service principal
// ClientSecretCredential credential = new ClientSecretCredentialBuilder()
// .clientId(System.getenv("AZURE_OPENAI_CLIENTID"))
// .clientSecret(System.getenv("AZURE_OPENAI_CLIENTSECRET"))
// .tenantId(System.getenv("AZURE_OPENAI_TENANTID"))
// .build();
String endpoint = System.getenv("AZURE_OPENAI_BASE");
OpenAIClient client = new OpenAIClientBuilder()
.credential(credential)
.endpoint(endpoint)
.buildClient();
Nainstalujte závislosti.
pip install openai
pip install azure-identity
Ověřte se pomocí azure-identity a získejte koncový bod Azure OpenAI z proměnných prostředí přidaných konektorem služby. Pokud použijete následující kód, odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.
import os
import OpenAI
from azure.identity import ManagedIdentityCredential, ClientSecretCredential, get_bearer_token_provider
# Uncomment the following lines corresponding to the authentication type you want to use.
# system-assigned managed identity
# cred = ManagedIdentityCredential()
# user-assigned managed identity
# managed_identity_client_id = os.getenv('AZURE_OPENAI_CLIENTID')
# cred = ManagedIdentityCredential(client_id=managed_identity_client_id)
# service principal
# tenant_id = os.getenv('AZURE_OPENAI_TENANTID')
# client_id = os.getenv('AZURE_OPENAI_CLIENTID')
# client_secret = os.getenv('AZURE_OPENAI_CLIENTSECRET')
# cred = ClientSecretCredential(tenant_id=tenant_id, client_id=client_id, client_secret=client_secret)
token_provider = get_bearer_token_provider(
cred, "https://cognitiveservices.azure.com/.default"
)
endpoint = os.getenv('AZURE_OPENAI_BASE')
client = AzureOpenAI(
api_version="2024-02-15-preview",
azure_endpoint=endpoint,
azure_ad_token_provider=token_provider
)
Nainstalujte závislosti.
npm install --save @azure/identity
npm install @azure/openai
Ověřte se pomocí @azure/identity a získejte koncový bod Azure OpenAI z proměnných prostředí přidaných konektorem služby. Pokud použijete následující kód, odkomentujte část fragmentu kódu pro typ ověřování, který chcete použít.
import { DefaultAzureCredential,ClientSecretCredential } from "@azure/identity";
// Uncomment the following lines corresponding to the authentication type you want to use.
// for system-assigned managed identity
// const credential = new DefaultAzureCredential();
// for user-assigned managed identity
// const clientId = process.env.AZURE_OPENAI_CLIENTID;
// const credential = new DefaultAzureCredential({
// managedIdentityClientId: clientId
// });
// for service principal
// const tenantId = process.env.AZURE_OPENAI_TENANTID;
// const clientId = process.env.AZURE_OPENAI_CLIENTID;
// const clientSecret = process.env.AZURE_OPENAI_CLIENTSECRET;
// const credential = new ClientSecretCredential(tenantId, clientId, clientSecret);
const endpoint = process.env.AZURE_OPENAI_BASE;
const client = new OpenAIClient(endpoint, credential);
V jiných jazycích můžete použít informace o připojení, které Service Connector nastaví na proměnné prostředí pro připojení k Azure OpenAI. Podrobnosti o proměnné prostředí najdete v tématu Integrace Azure OpenAI s konektorem služby.
Související obsah