ai-agents-for-beginners

Руководство по настройке Azure AI Search

Это руководство поможет вам настроить Azure AI Search с помощью портала Azure. Следуйте приведённым ниже шагам, чтобы создать и настроить сервис Azure AI Search.

Требования

Перед началом убедитесь, что у вас есть следующее:

Шаг 1: Создайте учетную запись хранения Azure

  1. Следуйте этой инструкции, Создать учетную запись хранения Azure, чтобы создать новую учетную запись хранения Azure. ПРИМЕЧАНИЕ: Убедитесь, что тип учетной записи хранения — Standard General Purpose V2.
  1. Войдите в Azure портал.
  2. В левой панели навигации нажмите Создать ресурс.
  3. В строке поиска введите “Azure AI Search” и выберите Azure AI Search из списка результатов.
  4. Нажмите кнопку Создать.
  5. В вкладке Основные укажите следующую информацию:
    • Подписка: Выберите вашу подписку Azure.
    • Группа ресурсов: Создайте новую группу ресурсов или выберите существующую.
    • Имя ресурса: Введите уникальное имя для вашего сервиса поиска.
    • Регион: Выберите ближайший к вашим пользователям регион.
    • Ценовой уровень: Выберите ценовой уровень, соответствующий вашим требованиям. Для тестирования можно начать с бесплатного уровня.
  6. Нажмите Проверить + создать.
  7. Проверьте настройки и нажмите Создать, чтобы создать сервис поиска.
  1. После завершения развертывания перейдите к вашему сервису поиска в портале Azure.
  2. В панели обзора сервиса поиска скопируйте URL. Он должен выглядеть как https://<service-name>.search.windows.net.
  3. (Рекомендуется) Включите доступ без ключа с помощью Microsoft Entra ID (RBAC), как показано в шаге 4 ниже — ключ не требуется. Примеры в этом руководстве создают/обновляют индексы и загружают документы, что требует ролей Search Service Contributor и Search Index Data Contributor (или для аутентификации с ключом — основного ключа администратора, а не ключа запроса). Только если вы не можете использовать RBAC, откройте панель Настройки > Ключи и скопируйте основной ключ администратора.
  4. Следуйте шагам на странице Руководство по быстрому старту, чтобы создать индекс, загрузить данные и выполнить поиск.

Azure AI Search интегрируется с различными инструментами для расширения возможностей поиска. Вы можете использовать Azure CLI, Python SDK, .NET SDK и другие инструменты для продвинутой настройки и операций.

Использование Azure CLI

  1. Установите Azure CLI, следуя инструкциям на странице Установка Azure CLI.
  2. Войдите в Azure CLI с помощью команды:

    az login
    
  3. (Рекомендуется) Включите доступ без ключа с Microsoft Entra ID (RBAC):

     az search service update --name <service-name> --resource-group <resource-group> --auth-options aadOrApiKey
     az role assignment create --assignee <your-user-or-principal-id> --role "Search Service Contributor" --scope $(az search service show -g <resource-group> -n <service-name> --query id -o tsv)
     az role assignment create --assignee <your-user-or-principal-id> --role "Search Index Data Contributor" --scope $(az search service show -g <resource-group> -n <service-name> --query id -o tsv)
     # az search service show не содержит поля "endpoint"; сформируйте URL из имени сервиса.
     export AZURE_SEARCH_SERVICE_ENDPOINT="https://<service-name>.search.windows.net"
    

    При включенном RBAC примеры для Python и .NET SDK ниже аутентифицируются с DefaultAzureCredential, который использует вашу сессию az login при локальной разработке — ключ администратора не нужен. Подробнее смотрите Подключение к Azure AI Search с использованием ролей.

  4. (Запасной вариант) Аутентификация с использованием ключа — только если вы не можете использовать RBAC, сохраните также ключ администратора:

Сохраните и конечную точку, и ключ API вашего экземпляра Azure AI Search в переменные окружения.

```bash
# zsh/bash
# az search service show не содержит поле "endpoint"; сформируйте URL из имени сервиса.
export AZURE_SEARCH_SERVICE_ENDPOINT="https://<service-name>.search.windows.net"
export AZURE_SEARCH_API_KEY=$(az search admin-key show -g <resource-group> --service-name <service-name> --query "primaryKey" -o tsv)
```

```powershell
# PowerShell
# az search service show не содержит поле "endpoint"; сформируйте URL из имени сервиса.
$env:AZURE_SEARCH_SERVICE_ENDPOINT = "https://<service-name>.search.windows.net"
$env:AZURE_SEARCH_API_KEY = $(az search admin-key show -g <resource-group> --service-name <service-name> --query "primaryKey" -o tsv)
```

Использование Python SDK

  1. Установите клиентскую библиотеку Azure Cognitive Search и Azure Identity для Python:

    pip install azure-search-documents azure-identity
    
  2. Используйте следующий код на Python для создания индекса и загрузки документов:

     import os
     from azure.identity import DefaultAzureCredential
     from azure.search.documents import SearchClient
     from azure.search.documents.indexes import SearchIndexClient
     from azure.search.documents.indexes.models import SearchIndex, SimpleField, edm
    
     service_endpoint = os.getenv("AZURE_SEARCH_SERVICE_ENDPOINT")
     index_name = "sample-index"
    
     # Без ключа (рекомендуется): использует вашу учетную запись `az login` через RBAC Entra ID.
     # Требуются роли "Search Service Contributor" и "Search Index Data Contributor".
     credential = DefaultAzureCredential()
     # Запасной вариант (аутентификация с помощью ключа):
     # из azure.core.credentials импортировать AzureKeyCredential
     # credential = AzureKeyCredential(os.getenv("AZURE_SEARCH_API_KEY"))
     index_client = SearchIndexClient(service_endpoint, credential)
    
     fields = [
         SimpleField(name="id", type=edm.String, key=True),
         SimpleField(name="content", type=edm.String, searchable=True),
     ]
    
     index = SearchIndex(name=index_name, fields=fields)
    
     index_client.create_index(index)
    
     search_client = SearchClient(service_endpoint, index_name, credential)
    
     documents = [
         {"id": "1", "content": "Hello world"},
         {"id": "2", "content": "Azure Cognitive Search"}
     ]
    
     search_client.upload_documents(documents)
    

Использование .NET SDK

  1. Выполните следующую команду для создания индекса и загрузки документов:

     dotnet run ./AzureSearch.cs
    

    Ниже приведён пример для .NET с использованием DefaultAzureCredential, который может использовать ваш вход в Azure CLI через az login во время локальной разработки.

  2. Вот исходный код AzureSearch.cs на .NET:

     #:package Azure.Search.Documents@11.*
     #:package Azure.Identity@1.21.0
     #:property PublishAot=false
    
     using Azure;
     using Azure.Identity;
     using Azure.Search.Documents;
     using Azure.Search.Documents.Indexes;
     using Azure.Search.Documents.Indexes.Models;
    
     var serviceEndpoint = new Uri(Environment.GetEnvironmentVariable("AZURE_SEARCH_SERVICE_ENDPOINT")!);
     var indexName = "sample-index";
    
     // Keyless (recommended): uses your `az login` identity via Entra ID RBAC.
     // Requires the "Search Service Contributor" and "Search Index Data Contributor" roles.
     var credential = new DefaultAzureCredential();
     // Fallback (key-based auth): the `using Azure;` directive above already imports
     // AzureKeyCredential; replace the credential line above with:
     // var credential = new AzureKeyCredential(Environment.GetEnvironmentVariable("AZURE_SEARCH_API_KEY")!);
     var indexClient = new SearchIndexClient(serviceEndpoint, credential);
    
     var fields = new List<SearchField>()
     {
         new SimpleField("id", SearchFieldDataType.String) { IsKey = true },
         new SearchableField("content")
     };
    
     var index = new SearchIndex(name: indexName, fields: fields);
    
     var response = await indexClient.CreateOrUpdateIndexAsync(index);
     Console.WriteLine($"Index '{response.Value.Name}' ready.");
    
     var searchClient = new SearchClient(serviceEndpoint, indexName, credential);
    
     var documents = new[]
     {
         new { id = "1", content = "Hello world" },
         new { id = "2", content = "Azure Cognitive Search" }
     };
    
     var result = await searchClient.UploadDocumentsAsync(documents);
     Console.WriteLine($"Uploaded {result.Value.Results.Count} documents to index '{response.Value.Name}'.");
    

Для получения более подробной информации обратитесь к следующей документации:

Заключение

Вы успешно настроили Azure AI Search с помощью портала Azure и интегрированных инструментов. Теперь вы можете изучать более продвинутые функции и возможности Azure AI Search для улучшения ваших решений поиска.

Для получения дополнительной помощи посетите документацию по Azure Cognitive Search.


Отказ от ответственности: Этот документ был переведен с использованием сервиса машинного перевода Co-op Translator. Несмотря на наши усилия по обеспечению точности, имейте в виду, что автоматический перевод может содержать ошибки или неточности. Оригинальный документ на его исходном языке следует считать авторитетным источником. Для получения критически важной информации рекомендуется обратиться к профессиональному человеческому переводу. Мы не несем ответственности за любые недоразумения или неправильные толкования, возникшие в результате использования этого перевода.