Fonte de dados - Índice do Azure Machine Learning (visualização)

Artigo
10/16/2024

As opções configuráveis do índice do Azure Machine Learning ao usar o Azure OpenAI On Your Data. Esta fonte de dados é suportada na versão 2024-02-15-previewda API.

Nome	Type	Obrigatório	Description
`parameters`	Parâmetros	True	Os parâmetros a serem usados ao configurar o índice do Azure Machine Learning.
`type`	string	True	Deve ser `azure_ml_index`.

Parâmetros

Nome	Type	Obrigatório	Description
`project_resource_id`	string	True	A ID do recurso do projeto Azure Machine Learning.
`name`	string	True	O nome do índice do Azure Machine Learning.
`version`	string	True	A versão do índice do Azure Machine Learning.
`authentication`	Uma das AccessTokenAuthenticationOptions, SystemAssignedManagedIdentityAuthenticationOptions, UserAssignedManagedIdentityAuthenticationOptions	True	O método de autenticação a ser usado ao acessar a fonte de dados definida.
`in_scope`	boolean	False	Se as consultas devem ser restritas ao uso de dados indexados. A predefinição é `True`.
`role_information`	string	False	Dê instruções ao modelo sobre como ele deve se comportar e qualquer contexto que ele deve referenciar ao gerar uma resposta. Pode descrever a personalidade do assistente e dizer-lhe como formatar as respostas.
`strictness`	integer	False	O rigor configurado da filtragem de relevância da pesquisa. Quanto maior o rigor, maior a precisão, mas menor a recordação da resposta. A predefinição é `3`.
`top_n_documents`	integer	False	O número superior configurado de documentos a serem apresentados para a consulta configurada. A predefinição é `5`.
`filter`	string	False	Filtro de pesquisa. Com suporte somente se o índice do Azure Machine Learning for do tipo Azure Search.

Opções de autenticação de token de acesso

As opções de autenticação para o Azure OpenAI On Your Data ao usar o token de acesso.

Nome	Type	Obrigatório	Description
`access_token`	string	True	O token de acesso a ser usado para autenticação.
`type`	string	True	Deve ser `access_token`.

Opções de autenticação de identidade gerenciada atribuída pelo sistema

As opções de autenticação para o Azure OpenAI On Your Data ao usar uma identidade gerenciada atribuída ao sistema.

Nome	Type	Obrigatório	Description
`type`	string	True	Deve ser `system_assigned_managed_identity`.

Opções de autenticação de identidade gerenciada atribuída pelo usuário

As opções de autenticação para o Azure OpenAI On Your Data ao usar uma identidade gerenciada atribuída pelo usuário.

Nome	Type	Obrigatório	Description
`managed_identity_resource_id`	string	True	A ID do recurso da identidade gerenciada atribuída pelo usuário a ser usada para autenticação.
`type`	string	True	Deve ser `user_assigned_managed_identity`.

Exemplos

Pré-requisitos:

Configure as atribuições de função do sistema Azure OpenAI atribuído identidade gerenciada ao recurso de espaço de trabalho do Azure Machine Learning. Função requerida: AzureML Data Scientist.
Configure as atribuições de função do usuário para o recurso do Azure OpenAI. Função requerida: Cognitive Services OpenAI User.
Instale o Az CLI e execute az logino .
Defina as seguintes variáveis de ambiente: AzureOpenAIEndpoint, ChatCompletionsDeploymentName, ProjectResourceId, IndexName, IndexVersion.
Execute export MSYS_NO_PATHCONV=1 se você estiver usando MINGW.

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

Python 1.x
REST

Instale os pacotes openaipip mais recentes, 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))


az rest --method POST \
 --uri $AzureOpenAIEndpoint/openai/deployments/$ChatCompletionsDeploymentName/chat/completions?api-version=2024-02-15-preview \
 --resource https://cognitiveservices.azure.com/ \
 --body \
'
{
    "data_sources": [
      {
        "type": "azure_ml_index",
        "parameters": {
          "project_resource_id": "'$ProjectResourceId'",
          "name": "'$IndexName'",
          "version": "'$IndexVersion'",
          "authentication": {
            "type": "system_assigned_managed_identity"
          },
        }
      }
    ],
    "messages": [
      {
        "role": "user",
        "content": "Who is DRI?"
      }
    ]
}
'

Partilhar via