Aktualizowanie zestawu umiejętności (interfejs API REST usługi Azure AI Search)

  • Artykuł

Możesz zaktualizować istniejący zestaw umiejętności i magazyn wiedzy przy użyciu protokołu HTTP PUT, określając nazwę zestawu umiejętności do zaktualizowania identyfikatora URI żądania.

PUT https://[servicename].search.windows.net/skillsets/[skillset name]?api-version=[api-version]
  Content-Type: application/json
  api-key: [admin key]

Uwaga

Zestawy umiejętności są podstawą wzbogacania sztucznej inteligencji w usłudze Azure AI Search. Bezpłatny zasób jest dostępny do ograniczonego przetwarzania, ale w przypadku większych i częstszych obciążeń wymagany jest zasób rozliczanych usług Cognitive Services. Aby uzyskać więcej informacji, zobacz Dołączanie zasobu usług Cognitive Services do zestawu umiejętności usługi Azure AI Search.

Parametry identyfikatora URI

Parametr Opis
nazwa usługi Wymagane. Ustaw tę wartość na unikatową, zdefiniowaną przez użytkownika nazwę usługi wyszukiwania.
nazwa zestawu umiejętności Wymagane. Identyfikator URI żądania określa nazwę zestawu umiejętności do zaktualizowania.
api-version Wymagane. Bieżąca stabilna wersja to api-version=2020-06-30. Zobacz Wersje interfejsu API , aby uzyskać więcej wersji.
disableCacheReprocessingChangeDetection Opcjonalny. Służy do wzbogacania przyrostowego (false domyślnie). Ustaw wartość , aby true zapobiec aktualizacjom istniejących dokumentów na podstawie bieżącej akcji. Aby uzyskać więcej informacji, zobacz Zarządzanie pamięcią podręczną.

Nagłówki żądań

W poniższej tabeli opisano wymagane i opcjonalne nagłówki żądań.

Pola Opis
Content-Type Wymagane. Ustaw tę wartość na application/json
api-key Opcjonalnie, jeśli używasz ról platformy Azure , a token elementu nośnego jest udostępniany w żądaniu, w przeciwnym razie wymagany jest klucz. Klucz api-key to unikatowy, generowany przez system ciąg, który uwierzytelnia żądanie w usłudze wyszukiwania. Żądania aktualizacji muszą zawierać api-key nagłówek ustawiony na klucz administratora (w przeciwieństwie do klucza zapytania). Aby uzyskać szczegółowe informacje, zobacz Nawiązywanie połączenia z usługą Azure AI Search przy użyciu uwierzytelniania klucza .

Treść żądania

Składnia treści żądania jest taka sama jak w przypadku tworzenia zestawu umiejętności.

Podczas aktualizowania istniejącego zestawu umiejętności cała definicja jest zastępowana zawartością treści żądania. Ogólnie rzecz biorąc, najlepszym wzorcem do użycia w przypadku aktualizacji jest pobranie definicji zestawu umiejętności przy użyciu polecenia GET, zmodyfikowanie go, a następnie zaktualizowanie go za pomocą funkcji PUT.

Reakcja

W przypadku pomyślnego żądania powinien zostać wyświetlony kod stanu "201 Utworzony".

Domyślnie treść odpowiedzi będzie zawierać kod JSON dla utworzonej definicji zestawu umiejętności. Jeśli jednak nagłówek preferuj żądanie ma wartość return=minimum, treść odpowiedzi będzie pusta, a kod stanu powodzenia będzie mieć wartość "204 Brak zawartości" zamiast "201 Utworzono". Jest to prawdziwe niezależnie od tego, czy put czy POST jest używany do tworzenia zestawu umiejętności.

Przykłady

Przykład: Aktualizowanie zestawu umiejętności

Poniższy przykład aktualizuje zestaw umiejętności używany do wzbogacania kolekcji dokumentów finansowych.

PUT https://[servicename].search.windows.net/skillsets/financedocenricher?api-version=2020-06-30
api-key: [admin key]
Content-Type: application/json

Treść żądania jest dokumentem JSON. Ten konkretny zestaw umiejętności używa dwóch umiejętności asynchronicznie, niezależnie przetwarza substancję /document/content jako dwie różne przekształcenia. Alternatywnie można kierować dane wyjściowe jednej transformacji tak, aby mogły być danymi wejściowymi innego. Aby uzyskać więcej informacji, zobacz How to define a skillset (Jak zdefiniować zestaw umiejętności).

{
  "name": "financedocenricher",
  "description": 
  "An updated version of a skillset used to extract sentiment from financial records, extract company names, and then find additional information about each company mentioned. This version changes the target names.",
  "skills":
  [
    {
      "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill",
      "categories": [ "Organization" ],
      "defaultLanguageCode": "en",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "organizations",
          "targetName": "companies"
        }
      ]
    },
    {
      "@odata.type": "#Microsoft.Skills.Text.SentimentSkill",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "score",
          "targetName": "positivityscore"
        }
      ]
    },
  ],
  "cognitiveServices": 
  {
  "@odata.type": "#Microsoft.Azure.Search.CognitiveServicesByKey",
  "description": "mycogsvcs resource in West US 2",
  "key": "<your key goes here>"
  }
}

Przykład: Usuwanie klucza usług Cognitive Services

Jeśli chcesz zaktualizować istniejący zestaw umiejętności i usunąć dołączony do niego klucz usług Cognitive Services, zmodyfikuj cognitiveServices sekcję, ustawiając wartość @odata.type#Microsoft.Azure.Search.DefaultCognitiveServicesna .

{
  "name": "financedocenricher"
  "skills":
  [
    {
      "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill",
      "categories": [ "Organization" ],
      "defaultLanguageCode": "en",
      "inputs": [
        {
          "name": "text",
          "source": "/document/content"
        }
      ],
      "outputs": [
        {
          "name": "organizations",
          "targetName": "companies"
        }
      ]
    },
  ],
  "cognitiveServices": 
  {
  "@odata.type": "#Microsoft.Azure.Search.DefaultCognitiveServices"
  }
}

Zobacz też