Actualización del conjunto de aptitudes (API rest de Azure AI Search)

  • Artículo

Puede actualizar un conjunto de aptitudes y un almacén de conocimiento existentes mediante HTTP PUT, especificando el nombre del conjunto de aptitudes que se va a actualizar en el URI de solicitud.

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

Nota

Los conjuntos de aptitudes son la base del enriquecimiento con ia en Azure AI Search. Hay disponible un recurso gratuito para un procesamiento limitado, pero para cargas de trabajo más grandes y frecuentes, se requiere un recurso de Cognitive Services facturable. Para más información, consulte Asociación de un recurso de Cognitive Services a un conjunto de aptitudes de Azure AI Search.

Parámetros de identificador URI

Parámetro Descripción
nombre del servicio Necesario. Establézcalo en el nombre único definido por el usuario del servicio de búsqueda.
nombre del conjunto de aptitudes Necesario. El URI de solicitud especifica el nombre del conjunto de aptitudes que se va a actualizar.
api-version Necesario. La versión estable actual es api-version=2020-06-30. Consulte Versiones de API para obtener más versiones.
disableCacheReprocessingChangeDetection Opcional. Se usa para el enriquecimiento incremental (false de forma predeterminada). Establézcalo en true para evitar actualizaciones en documentos existentes en función de la acción actual. Para más información, consulte Administración de caché.

Encabezados de solicitud

En la siguiente tabla se describen los encabezados de solicitud obligatorios y opcionales.

Campos Descripción
Content-Type Necesario. Establézcalo en application/json
api-key Opcional si usa roles de Azure y se proporciona un token de portador en la solicitud; de lo contrario, se requiere una clave. Una clave de API es una cadena única generada por el sistema que autentica la solicitud en el servicio de búsqueda. Las solicitudes de actualización deben incluir un api-key encabezado establecido en la clave de administración (en lugar de una clave de consulta). Consulte Conexión a Azure AI Search mediante la autenticación de claves para más información.

Cuerpo de la solicitud

La sintaxis del cuerpo de la solicitud es la misma que para Create Skillset.

Al actualizar un conjunto de aptitudes existente, toda la definición se reemplaza por el contenido del cuerpo de la solicitud. En general, el mejor patrón que se debe usar para las actualizaciones es recuperar la definición del conjunto de aptitudes con get, modificarla y, a continuación, actualizarla con PUT.

Response

Para una solicitud correcta, debería ver el código de estado "201 Created".

De forma predeterminada, el cuerpo de la respuesta contendrá el JSON de la definición del conjunto de aptitudes que se creó, pero si se establece el encabezado de la solicitud Prefer en return=minimal, el cuerpo de respuesta quedará vacío y el código de estado correcto será "204 Sin contenido", en lugar de "201 Creado". Esto es cierto independientemente de si se usa PUT o POST para crear el conjunto de aptitudes.

Ejemplos

Ejemplo: Actualización de un conjunto de aptitudes

En el ejemplo siguiente se actualiza un conjunto de aptitudes que se usa para enriquecer una colección de documentos financieros.

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

El cuerpo de solicitud es un documento JSON. Este conjunto de aptitudes concreto usa dos aptitudes de forma asincrónica, procesando de forma independiente la sustancia de /document/content como dos transformaciones diferentes. Como alternativa, puede dirigir la salida de una transformación para que sea la entrada de otra. Para más información, vea How to define a skillset (Cómo definir un conjunto de aptitudes).

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

Ejemplo: Eliminación de la clave de Cognitive Services

Si desea actualizar un conjunto de aptitudes existente y quitar la clave de Cognitive Services asociada, modifique la cognitiveServices sección estableciendo en @odata.type#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"
  }
}

Consulte también