Aktualisieren von Skillset (Azure AI Search-REST-API)

  • Artikel

Sie können ein vorhandenes Skillset und einen Wissensspeicher mithilfe eines HTTP-PUT aktualisieren und dabei den Namen des Skillsets angeben, der für den Anforderungs-URI aktualisiert werden soll.

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

Hinweis

Skillsets sind die Grundlage der KI-Anreicherung in Azure AI Search. Eine kostenlose Ressource ist für begrenzte Verarbeitung verfügbar, aber für größere und häufigere Workloads ist eine abrechenbare Cognitive Services-Ressource erforderlich. Weitere Informationen finden Sie unter Anfügen einer Cognitive Services-Ressource an ein Azure AI Search-Skillset.

URI-Parameter

Parameter BESCHREIBUNG
Dienstname Erforderlich. Legen Sie dies auf den eindeutigen, benutzerdefinierten Namen Ihres Suchdiensts fest.
Skillsetname Erforderlich. Der Anforderungs-URI gibt den Namen des zu aktualisierenden Skillsets an.
api-version Erforderlich. Die aktuelle stabile Version ist api-version=2020-06-30. Weitere Versionen finden Sie unter API-Versionen .
disableCacheReprocessingChangeDetection Optional. Wird für die inkrementelle Anreicherung verwendet (false standardmäßig). Legen Sie auf fest true , um Aktualisierungen vorhandener Dokumente basierend auf der aktuellen Aktion zu verhindern. Weitere Informationen finden Sie unter Cacheverwaltung.

Anforderungsheader

Die folgende Tabelle beschreibt die erforderlichen und optionalen Anforderungsheader.

Felder BESCHREIBUNG
Content-Type Erforderlich. Auf application/json
api-key Optional, wenn Sie Azure-Rollen verwenden und ein Bearertoken für die Anforderung bereitgestellt wird, andernfalls ist ein Schlüssel erforderlich. Ein API-Schlüssel ist eine eindeutige, vom System generierte Zeichenfolge, die die Anforderung bei Ihrem Suchdienst authentifiziert. Updateanforderungen müssen einen api-key Header enthalten, der auf Ihren Administratorschlüssel (im Gegensatz zu einem Abfrageschlüssel) festgelegt ist. Weitere Informationen finden Sie unter Herstellen einer Verbindung mit Azure AI Search mithilfe der Schlüsselauthentifizierung .

Anforderungstext

Die Syntax des Anforderungstexts ist identisch mit der Syntax für "Skillset erstellen".

Beim Aktualisieren eines vorhandenen Skillsets wird die gesamte Definition durch den Inhalt des Anforderungstexts ersetzt. Im Allgemeinen besteht das beste Muster für Updates darin, die Skillsetdefinition mit einem GET abzurufen, sie zu ändern und sie dann mit PUT zu aktualisieren.

Antwort

Bei einer erfolgreichen Anforderung wird der Statuscode „201 – erstellt“ angezeigt.

Standardmäßig enthält der Antworttext das JSON-Schema für die erstellte Skillsetdefinition. Wenn der Prefer-Anforderungsheader jedoch auf „return=minimal“ festgelegt ist, ist der Antworttext leer und der Statuscode lautet „204 – kein Inhalt“ statt „201 – erstellt“. Dies gilt unabhängig davon, ob zum Erstellen des Skillsets eine PUT- oder eine POST-Anforderung verwendet wurde.

Beispiele

Beispiel: Aktualisieren eines Skillsets

Im folgenden Beispiel wird ein Skillset aktualisiert, das zum Anreichern einer Sammlung von Finanzdokumenten verwendet wird.

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

Der Anforderungstext ist ein JSON-Dokument. Dieses spezielle Skillset verwendet zwei Skills asynchron und verarbeitet unabhängig die Substanz von /document/content zwei verschiedenen Transformationen. Alternativ dazu können Sie auch die Ausgabe einer Transformation als Eingabe an die nächste Transformation weiterleiten. Weitere Informationen finden Sie unter Definieren eines Skillsets.

{
  "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>"
  }
}

Beispiel: Entfernen des Cognitive Services-Schlüssels

Wenn Sie ein vorhandenes Skillset aktualisieren und den an ihn angefügten Cognitive Services-Schlüssel entfernen möchten, ändern Sie den cognitiveServices Abschnitt, indem Sie auf @odata.type#Microsoft.Azure.Search.DefaultCognitiveServicesfestlegen.

{
  "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"
  }
}

Weitere Informationen