Atualizar Conjunto de Habilidades (API REST do Azure AI Search)
Você pode atualizar um conjunto de habilidades existente e um repositório de conhecimento usando um HTTP PUT, especificando o nome do conjunto de habilidades a ser atualizado no URI de solicitação.
PUT https://[servicename].search.windows.net/skillsets/[skillset name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Observação
Os conjuntos de habilidades são a base do enriquecimento de IA no Azure AI Search. Um recurso gratuito está disponível para processamento limitado, mas para cargas de trabalho maiores e mais frequentes, um recurso de Serviços Cognitivos faturável é necessário. Para obter mais informações, consulte Anexar um recurso dos Serviços Cognitivos a um conjunto de habilidades do Azure AI Search.
Parâmetros de URI
Parâmetro | Descrição |
---|---|
nome do serviço | Obrigatórios. Defina isso como o nome exclusivo definido pelo usuário do serviço de pesquisa. |
nome do conjunto de habilidades | Obrigatórios. O URI de solicitação especifica o nome do conjunto de habilidades a ser atualizado. |
api-version | Obrigatórios. A versão estável atual é api-version=2020-06-30 . Consulte Versões de API para obter mais versões. |
disableCacheReprocessingChangeDetection | Opcional. Usado para enriquecimento incremental (false por padrão). Defina como true para evitar atualizações em documentos existentes com base na ação atual. Para obter mais informações, consulte Gerenciamento de cache. |
Cabeçalhos de solicitação
A tabela a seguir descreve os cabeçalhos de solicitação necessários e opcionais
Campos | Descrição |
---|---|
Tipo de conteúdo | Obrigatórios. Defina-o como application/json |
chave de API | Opcional se você estiver usando funções do Azure e um token de portador for fornecido na solicitação, caso contrário, uma chave será necessária. Uma chave de api é uma cadeia de caracteres exclusiva gerada pelo sistema que autentica a solicitação para o serviço de pesquisa. As solicitações de atualização devem incluir um api-key cabeçalho definido como sua chave de administrador (em vez de uma chave de consulta). Confira Conectar-se ao Azure AI Search usando a autenticação de chave para obter detalhes. |
Corpo da solicitação
A sintaxe do corpo da solicitação é a mesma que para Criar Conjunto de Habilidades.
Ao atualizar um conjunto de habilidades existente, toda a definição é substituída pelo conteúdo do corpo da solicitação. Em geral, o melhor padrão a ser usado para atualizações é recuperar a definição do conjunto de habilidades com um GET, modificá-la e atualizá-la com PUT.
Resposta
Para uma solicitação bem-sucedida, você deverá ver o código de status “201 (Criado)”.
Por padrão, o corpo da resposta conterá o JSON para a definição de índice que foi criado. Porém, se o cabeçalho da solicitação preferido for definido como retorno=mínimo , o corpo da resposta estará vazio e o código de status de êxito será "204 Sem Conteúdo" em vez de "201 Criado". Isso ocorre independentemente de PUT ou POST ter sido usado para criar o conjunto de qualificações.
Exemplos
Exemplo: Atualizar um conjunto de habilidades
O exemplo a seguir atualiza um conjunto de habilidades usado para enriquecer uma coleção de documentos financeiros.
PUT https://[servicename].search.windows.net/skillsets/financedocenricher?api-version=2020-06-30
api-key: [admin key]
Content-Type: application/json
O corpo da solicitação é um documento JSON. Este conjunto de habilidades específico usa duas habilidades de forma assíncrona, processando independentemente a substância de /document/content
como duas transformações diferentes. Como alternativa, você pode direcionar a saída de uma transformação para ser a entrada de outra. Para obter mais informações, confira Como definir um conjunto de qualificações.
{
"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>"
}
}
Exemplo: Remover chave dos Serviços Cognitivos
Se você quiser atualizar um conjunto de habilidades existente e remover a chave de serviços cognitivos anexada a ele, modifique a cognitiveServices
seção definindo como @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"
}
}