Vaardighedenset bijwerken (Azure AI Search REST API)

  • Artikel

U kunt een bestaande vaardighedenset en kennisarchief bijwerken met behulp van een HTTP PUT, waarbij u de naam opgeeft van de vaardighedenset die moet worden bijgewerkt op de aanvraag-URI.

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

Notitie

Vaardighedensets vormen de basis van AI-verrijking in Azure AI Search. Er is een gratis resource beschikbaar voor beperkte verwerking, maar voor grotere en frequentere workloads is een factureerbare Cognitive Services-resource vereist. Zie Een Cognitive Services-resource koppelen aan een azure AI Search-vaardighedenset voor meer informatie.

URI-parameters

Parameter Beschrijving
servicenaam Vereist. Stel deze in op de unieke, door de gebruiker gedefinieerde naam van uw zoekservice.
naam van vaardighedenset Vereist. De aanvraag-URI geeft de naam op van de vaardighedenset die moet worden bijgewerkt.
api-versie Vereist. De huidige stabiele versie is api-version=2020-06-30. Zie API-versies voor meer versies.
disableCacheReprocessingChangeDetection Optioneel. Wordt standaard gebruikt voor incrementele verrijking.false Stel in op true om te voorkomen dat bestaande documenten worden bijgewerkt op basis van de huidige actie. Zie Cachebeheer voor meer informatie.

Aanvraagheaders

In de volgende tabel worden de vereiste en optionele aanvraagheaders beschreven.

Velden Description
Content-Type Vereist. Stel dit in op application/json
api-sleutel Optioneel als u Azure-rollen gebruikt en er een bearer-token wordt opgegeven voor de aanvraag, anders is een sleutel vereist. Een API-sleutel is een unieke, door het systeem gegenereerde tekenreeks die de aanvraag verifieert bij uw zoekservice. Bijwerkaanvragen moeten een api-key header bevatten die is ingesteld op uw beheerderssleutel (in plaats van een querysleutel). Zie Verbinding maken met Azure AI Search met behulp van sleutelverificatie voor meer informatie.

Aanvraagbody

De syntaxis van de aanvraagtekst is hetzelfde als voor Vaardigheden maken.

Bij het bijwerken van een bestaande vaardighedenset wordt de volledige definitie vervangen door de inhoud van de aanvraagbody. Over het algemeen is het beste patroon voor updates om de definitie van de vaardighedenset op te halen met een GET, deze te wijzigen en vervolgens bij te werken met PUT.

Antwoord

Voor een geslaagde aanvraag ziet u statuscode '201 Gemaakt'.

Standaard bevat de antwoordtekst de JSON voor de definitie van de vaardighedenset die is gemaakt. Als de voorkeursaanvraagheader echter is ingesteld op return=minimal, is de antwoordtekst leeg en is de statuscode '204 No Content' in plaats van '201 Created'. Dit geldt ongeacht of PUT of POST wordt gebruikt om de vaardighedenset te maken.

Voorbeelden

Voorbeeld: Een vaardighedenset bijwerken

In het volgende voorbeeld wordt een vaardighedenset bijgewerkt die wordt gebruikt voor het verrijken van een verzameling financiële documenten.

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

De hoofdtekst van de aanvraag is een JSON-document. Deze specifieke vaardighedenset maakt asynchroon gebruik van twee vaardigheden, waarbij de inhoud van /document/content als twee verschillende transformaties onafhankelijk wordt verwerkt. U kunt de uitvoer van de ene transformatie ook instellen als invoer van een andere transformatie. Zie How to define a skillset (Een vaardighedenset definiëren) voor meer informatie.

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

Voorbeeld: Cognitive Services-sleutel verwijderen

Als u een bestaande vaardighedenset wilt bijwerken en de daaraan gekoppelde Cognitive Services-sleutel wilt verwijderen, wijzigt u de cognitiveServices sectie door de @odata.type in te stellen op #Microsoft.Azure.Search.DefaultCognitiveServices.

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

Zie ook