Zdroj dat – index Učení Azure Machine (Preview)
Konfigurovatelné možnosti indexu Azure Machine Učení při použití Azure OpenAI ve vašich datech. Tento zdroj dat je podporován ve verzi 2024-02-15-preview
rozhraní API .
Name | Type | Požadováno | Popis |
---|---|---|---|
parameters |
Parametry | True | Parametry, které se mají použít při konfiguraci indexu služby Azure Machine Učení. |
type |
string | True | Musí být azure_ml_index . |
Parametry
Název | Type | Požadováno | Popis |
---|---|---|---|
project_resource_id |
string | True | ID prostředku projektu Azure Machine Učení. |
name |
string | True | Název indexu azure machine Učení. |
version |
string | True | Verze indexu Azure Machine Učení. |
authentication |
Jeden z AccessTokenAuthenticationOptions, SystemAssignedManagedIdentityAuthenticationOptions, UserAssignedManagedIdentityAuthenticationOptions | True | Metoda ověřování, která se má použít při přístupu k definovanému zdroji dat. |
in_scope |
boolean | False | Určuje, jestli se dotazy mají omezit na použití indexovaných dat. Výchozí hodnota je True . |
role_information |
string | False | Poskytněte modelu pokyny, jak by se měl chovat, a jakýkoli kontext, na který by měl odkazovat při generování odpovědi. Můžete popsat osobnost asistenta a říct jí, jak formátovat odpovědi. |
strictness |
integer | False | Nakonfigurovaná striktnost filtrování relevance vyhledávání. Čím vyšší je striktnost, tím vyšší přesnost, ale nižší úplnost odpovědi. Výchozí hodnota je 3 . |
top_n_documents |
integer | False | Nakonfigurovaný nejvyšší počet dokumentů, které se mají použít pro nakonfigurovaný dotaz. Výchozí hodnota je 5 . |
filter |
string | False | Filtr hledání. Podporuje se jenom v případě, že index azure machine Učení je typu Azure Search. |
Možnosti ověřování přístupového tokenu
Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití přístupového tokenu.
Name | Type | Požadováno | Popis |
---|---|---|---|
access_token |
string | True | Přístupový token, který se má použít k ověřování. |
type |
string | True | Musí být access_token . |
Možnosti ověřování spravované identity přiřazené systémem
Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití spravované identity přiřazené systémem
Name | Type | Požadováno | Popis |
---|---|---|---|
type |
string | True | Musí být system_assigned_managed_identity . |
Možnosti ověřování spravované identity přiřazené uživatelem
Možnosti ověřování pro Azure OpenAI Ve vašich datech při použití spravované identity přiřazené uživatelem.
Name | Type | Požadováno | Popis |
---|---|---|---|
managed_identity_resource_id |
string | True | ID prostředku spravované identity přiřazené uživatelem, které se má použít k ověřování. |
type |
string | True | Musí být user_assigned_managed_identity . |
Příklady
Požadavky:
- Nakonfigurujte přiřazení rolí ze systému Azure OpenAI přiřazené spravované identity k prostředku pracovního prostoru Učení Azure Machine. Požadovaná role:
AzureML Data Scientist
. - Nakonfigurujte přiřazení rolí od uživatele k prostředku Azure OpenAI. Požadovaná role:
Cognitive Services OpenAI User
. - Nainstalujte Az CLI a spusťte
az login
. - Definujte následující proměnné prostředí:
AzureOpenAIEndpoint
,ChatCompletionsDeploymentName
ProjectResourceId
,IndexName
, ,IndexVersion
. - Pokud používáte MINGW, spusťte
export MSYS_NO_PATHCONV=1
ho.
export AzureOpenAIEndpoint=https://example.openai.azure.com/
export ChatCompletionsDeploymentName=turbo
export ProjectResourceId='/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/Microsoft.MachineLearningServices/workspaces/{workspace-id}'
export IndexName=testamlindex
export IndexVersion=2
Nainstalujte nejnovější balíčky openai
pip , azure-identity
.
import os
from openai import AzureOpenAI
from azure.identity import DefaultAzureCredential, get_bearer_token_provider
endpoint = os.environ.get("AzureOpenAIEndpoint")
deployment = os.environ.get("ChatCompletionsDeploymentName")
project_resource_id = os.environ.get("ProjectResourceId")
index_name = os.environ.get("IndexName")
index_version = os.environ.get("IndexVersion")
token_provider = get_bearer_token_provider(
DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default")
client = AzureOpenAI(
azure_endpoint=endpoint,
azure_ad_token_provider=token_provider,
api_version="2024-02-15-preview",
)
completion = client.chat.completions.create(
model=deployment,
messages=[
{
"role": "user",
"content": "Who is DRI?",
},
],
extra_body={
"data_sources": [
{
"type": "azure_ml_index",
"parameters": {
"project_resource_id": project_resource_id,
"name": index_name,
"version": index_version,
"authentication": {
"type": "system_assigned_managed_identity"
},
}
}
]
}
)
print(completion.model_dump_json(indent=2))