Update Skillset (API REST do Azure AI Search)
Pode atualizar um conjunto de competências e arquivo de conhecimento existente com um HTTP PUT, especificando o nome do conjunto de competências a atualizar no URI do pedido.
PUT https://[servicename].search.windows.net/skillsets/[skillset name]?api-version=[api-version]
Content-Type: application/json
api-key: [admin key]
Nota
Os conjuntos de competências são a base do melhoramento de IA no Azure AI Search. Está disponível um recurso gratuito para processamento limitado, mas para cargas de trabalho maiores e mais frequentes, é necessário um recurso dos Serviços Cognitivos faturável. Para obter mais informações, veja Anexar um recurso dos Serviços Cognitivos a um conjunto de competências da Pesquisa de IA do Azure.
Parâmetros do URI
Parâmetro | Description |
---|---|
nome do serviço | Obrigatório. Defina-o como o nome exclusivo e definido pelo utilizador do seu serviço de pesquisa. |
nome do conjunto de competências | Obrigatório. O URI do pedido especifica o nome do conjunto de competências a atualizar. |
api-version | Obrigatório. A versão estável atual é api-version=2020-06-30 . Veja Versões da API para obter mais versões. |
disableCacheReprocessingChangeDetection | Opcional. Utilizado para o melhoramento incremental (false por predefinição). Defina como para true impedir atualizações para documentos existentes com base na ação atual. Para obter mais informações, veja Gestão da cache. |
Cabeçalhos do Pedido
A tabela seguinte descreve os cabeçalhos de pedido obrigatórios e opcionais.
Campos | Description |
---|---|
Content-Type | Obrigatório. Defina esta opção como application/json |
api-key | Opcional se estiver a utilizar funções do Azure e for fornecido um token de portador no pedido, caso contrário, é necessária uma chave. Uma chave de api é uma cadeia exclusiva gerada pelo sistema que autentica o pedido no seu serviço de pesquisa. Os pedidos de atualização têm de incluir um api-key cabeçalho definido para a sua chave de administrador (em oposição a uma chave de consulta). Veja Ligar à Pesquisa de IA do Azure com a autenticação de chaves para obter detalhes. |
Corpo do Pedido
A sintaxe do corpo do pedido é a mesma que para Criar Conjunto de Competências.
Ao atualizar um conjunto de competências existente, toda a definição é substituída pelo conteúdo do corpo do pedido. Em geral, o melhor padrão a utilizar para atualizações é obter a definição do conjunto de competências com um GET, modificá-lo e, em seguida, atualizá-lo com PUT.
Resposta
Para um pedido com êxito, deverá ver o código de estado "201 Criado".
Por predefinição, o corpo da resposta irá conter o JSON para a definição do conjunto de competências que foi criada. No entanto, se o cabeçalho Preferir pedido estiver definido como return=minimal, o corpo da resposta estará vazio e o código de estado de êxito será "204 Sem Conteúdo" em vez de "201 Criado". Isto é verdade independentemente de PUT ou POST ser utilizado para criar o conjunto de competências.
Exemplos
Exemplo: Atualizar um conjunto de competências
O exemplo seguinte atualiza um conjunto de competências utilizado 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 do pedido é um documento JSON. Este conjunto de competências específico utiliza duas competências de forma assíncrona, processando independentemente a substância de /document/content
como duas transformações diferentes. Em alternativa, pode direcionar a saída de uma transformação para ser a entrada de outra. Para obter mais informações, veja Como definir um conjunto de competências.
{
"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 quiser atualizar um conjunto de competências existente e remover a chave dos Serviços Cognitivos anexada à mesma, modifique a cognitiveServices
secção ao definir 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"
}
}