IDs de enriquecimento

Se você deseja aplicar um enriquecimento personalizado que criou para uma coleção para outra coleção, você deve conhecer o ID exclusivo que foi gerado para o enriquecimento quando ele foi criado. Use a API para listar enriquecimentos a partir do projeto em que o enriquecimento personalizado está em uso. A lista que é retornada inclui informações de ID de enriquecimento.

Para os enriquecimentos pré-construídos, os IDs exclusivos não mudam. A tabela a seguir relaciona os IDs que estão associados a cada tipo de enriquecimento pré-construído e identifica as linguagens de coleta para as quais o enriquecimento é suportado. Um enriquecimento não pode ser aplicado a uma coleção, a menos que a linguagem de coleta seja apoiada pelo enriquecimento.

Para obter mais informações sobre todos os idiomas suportados, consulte Suporte ao Idioma.

Aplicar enriquecimentos usando a API

Para aplicar um enriquecimento usando a API, conclua as etapas a seguir:

1. Determine a base URL para o endpoint e o token ou a chave de API para sua implantação.

   Para obter mais informações, consulte Construindo aplicativos personalizados com a API.

2. Obtem o ID do projeto para o seu projeto.

   A partir da interface do usuário do produto, acesse a página Integrar e Impletar > Visualizar informações da API e, em seguida, copiar o ID do projeto.

3. Se você não souber o ID da coleção que deseja aplicar o enriquecimento para, obtenha uma lista de suas coleções para localizá-lo.

   Por exemplo:

   GET $authentication $url/v2/projects/$project_id/collections?version=2019-11-22
   

   O collection_id é retornado.

4. Envie uma solicitação GET para retornar a configuração da coleção que lista os enriquecimentos aplicados.

   Por exemplo:

   GET $authentication $url/v2/projects/$project_id/collections/$collection_id?version=2019-11-22
   

   Para os IDs de enriquecimento para os enriquecimentos pré-construídos, consulte IDs de Enriquecimento.

5. Adicio o enriquecimento que você deseja aplicar.

   Por exemplo, para incluir o enriquecimento Palavras-chave, é possível incluir o enriquecimento na lista de enriquecimentos. Primeiro, obtenha seu ID da tabela.

   O ID de enriquecimento de Palavras-chave é 701db916-fc83-57ab-0000-000000000018 Para indicar que você deseja aplicar o enriquecimento de Palavras-chave ao conteúdo no campo text dos documentos na coleta, é possível representá-lo no formato JSON da seguinte forma:

   {
       "enrichment_id" : "701db916-fc83-57ab-0000-000000000018",
       "fields" : [ "text" ]
   }
   

   Quaisquer enriquecimentos que você especificar substituem os enriquecimentos inadimplentes. Portanto, se você deseja manter um enriquecimento padrão, não se esqueça de incluê-lo na lista de enriquecimentos que você aplica à coleção. Para obter uma lista de enriquecimentos inadimplentes por tipo de projeto, consulte enriquecimentos padrão por tipo de projeto.

   Por exemplo, para reter o enriquecimento Entities e incluir o enriquecimento Keywords, é possível especificar o seguinte no corpo da solicitação:

   "enrichments": [
     {
       "enrichment_id": "701db916-fc83-57ab-0000-00000000001e",
       "fields": [
         "text"
       ]
     },
     {
       "enrichment_id": "701db916-fc83-57ab-0000-000000000018",
       "fields": [
         "text"
       ]
     }
   ]
   

6. Envie o corpo de solicitação JSON atualizado com o método update collection para aplicar o enriquecimento em sua coleção.

   Por exemplo:

   POST $authentication -d '$requestBody' $url/v2/projects/$project_id/collections/$collection_id?version=2019-11-22