Criar solicitação de classificação do arquivo

Artigo
04/08/2023

Cria uma solicitação para classificar um ou mais arquivos usando o modelo de compreensão de documentos aplicado. (Para obter mais informações, confira o exemplo.)

O serviço REST do SharePoint Online (e do SharePoint 2016 e posterior local) oferece suporte à combinação de várias solicitações. As solicitações são combinadas em uma única chamada de serviço, usando a opção de consulta OData $batch. Esse método pode ser usado para sequenciar itens do trabalho de classificação para centenas de documentos ao mesmo tempo.

Solicitação HTTP

POST /_api/machinelearning/workItems HTTP/1.1

Parâmetros de URI

Nenhum

Cabeçalhos de solicitação

Cabeçalho	Valor
Aceitar	application/json;odata=verbose
Content-Type	application/json;odata=verbose;charset=utf-8
x-requestdigest	O resumo apropriado para o site atual

Corpo da solicitação

Nome	Tipo	Descrição
_metadata	string	Definir o metadado do objeto no SPO. Sempre use o valor: {"type": "Microsoft.Office.Server.ContentCenter.SPMachineLearningWorkItemEntityData"}.
TargetSiteId	guid	A ID do site onde está localizado o arquivo a ser classificado. Isso pode ser omitido quando TargetSiteUrl tiver um valor.
TargetSiteUrl	cadeia de caracteres	A URL completa do site onde está localizado o arquivo a ser classificado. Isso pode ser omitido quando TargeSiteId tiver um valor.
TargetWebId	guid	A ID da Web onde está localizado o arquivo a ser classificado. Isso pode ser omitido quando TargetWebServerRelativeUrl tiver um valor.
TargetWebServerRelativeUrl	cadeia de caracteres	A URL relativa do servidor da Web onde está localizado o arquivo a ser classificado. Isso pode ser omitido quando TargetWebId tiver um valor.
TargetUniqueId	guid	A ID da pasta a ser classificada. Isso pode ser omitido quando TargetServerRelativeUrl tiver um valor.
TargetServerRelativeUrl	cadeia de caracteres	A URL relativa do servidor do arquivo a ser classificado está localizado. Isso pode ser omitido quando TargetUniqueId tiver um valor.

Respostas

Nome	Tipo	Descrição
201 Criado		A resposta é personalizada. Se houver falha, ainda poderá retornar o 201 Created. O chamador deve verificar o corpo da resposta para determinar o resultado exato.

Exemplos

Enfileirar uma solicitação para classificar um arquivo da ID "e6cff8b7-c90c-4564-b5b8-033449090932"

Solicitação de amostra

{
    "__metadata": {
        "type": "Microsoft.Office.Server.ContentCenter.SPMachineLearningWorkItemEntityData"
    },
    "TargetSiteId": "f686e63b-aba7-48e5-97c7-68c4c1df292f",
    "TargetWebId": "66d6b64d-6f88-4dd9-b3db-47e6f00c53e8",
    "TargetUniqueId": "e6cff8b7-c90c-4564-b5b8-033449090932"
}

Resposta de amostra

Código de status: 201

{
    "ErrorMessage":  null,
    "StatusCode":  201
}

{
    "ErrorMessage":  null,
    "StatusCode":  201
}

Confira também

API REST do modelo de compreensão de documentos do Syntex

Compartilhar via