Question Answering Projects - Update Sources

Serviço:: Azure AI Services

Versão da API:: 2023-04-01

Atualiza as fontes de um projeto.

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}/sources?api-version=2023-04-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
Endpoint	path	True	string (uri)	Ponto de extremidade dos Serviços Cognitivos com suporte (por exemplo, https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	O nome do projeto a ser usado.
api-version	query	True	string minLength: 1	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
body	UpdateSourceRecord[]	Atualize os parâmetros de origem de um projeto.

Respostas

Nome	Tipo	Description
202 Accepted		A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído. Cabeçalhos Operation-Location: string
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada. Cabeçalhos x-ms-error-code: string

Nome

Tipo

Description

202 Accepted

A solicitação foi aceita para processamento, mas o processamento ainda não foi concluído.

Cabeçalhos

Operation-Location: string

Other Status Codes

ErrorResponse

Uma resposta de erro inesperada.

Cabeçalhos

x-ms-error-code: string

Segurança

Ocp-Apim-Subscription-Key

Tipo: apiKey
Em: header

OAuth2Auth

Tipo: oauth2
Flow: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Escopos

Nome	Description
https://cognitiveservices.azure.com/.default

Exemplos

Successful query

Solicitação de exemplo

HTTP

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/proj1/sources?api-version=2023-04-01

[
  {
    "op": "add",
    "value": {
      "displayName": "source3",
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context",
      "sourceKind": "url",
      "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/cognitive-services-support-options?context=/azure/cognitive-services/qnamaker/context/context"
    }
  },
  {
    "op": "replace",
    "value": {
      "displayName": "source1",
      "refresh": true,
      "source": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview",
      "sourceKind": "url",
      "sourceUri": "https://docs.microsoft.com/en-us/azure/cognitive-services/qnamaker/overview/overview"
    }
  },
  {
    "op": "delete",
    "value": {
      "displayName": "source2",
      "source": "surface-guide.pdf",
      "sourceKind": "file",
      "sourceUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf"
    }
  }
]

Resposta de exemplo

Código de status:: 202

Operation-Location: https:///language/authoring/query-knowledgebases/projects/proj1/sources/jobs/job1?api-version=2023-04-01

Definições

Nome	Description
Error	O objeto de erro.
ErrorCode	Código de erro legível por humanos.
ErrorResponse	Resposta de erro.
InnerErrorCode	Código de erro legível por humanos.
InnerErrorModel	Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
sourceContentStructureKind	Tipo de estrutura de conteúdo para fontes.
sourceKind	Tipos de origem com suporte.
updateOperationKind	Atualize o tipo de operação para ativos.
UpdateQnaSourceRecord	Atualizar registro de origem.
UpdateSourceRecord	Fonte a ser atualizada.

Error

Objeto

O objeto de erro.

Nome	Tipo	Description
code	ErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
details	Error[]	Uma matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Uma representação legível pelo ser humano do erro.
target	string	O destino do erro.

ErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest	Erro de solicitação inválido
InvalidArgument	Erro de argumento inválido
Unauthorized	Erro de acesso não autorizado
Forbidden	Erro de acesso proibido
NotFound	Erro não encontrado
ProjectNotFound	Erro não encontrado no projeto
OperationNotFound	Erro de operação não encontrada
AzureCognitiveSearchNotFound	Erro não encontrado no Azure Cognitive Search
AzureCognitiveSearchIndexNotFound	Erro não encontrado no índice do Azure Cognitive Search
TooManyRequests	Erro de muitas solicitações
AzureCognitiveSearchThrottling	Erro de limitação do Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Erro atingido no limite de índice do Azure Cognitive Search
InternalServerError	Erro interno do servidor
ServiceUnavailable	Erro de serviço indisponível
Timeout	Erro de tempo limite
QuotaExceeded	Erro de cota excedido
Conflict	Erro de conflito
Warning	Erro de aviso

ErrorResponse

Objeto

Resposta de erro.

Nome	Tipo	Description
error	Error	O objeto de erro.

InnerErrorCode

Enumeração

Código de erro legível por humanos.

Valor	Description
InvalidRequest	Erro de solicitação inválido
InvalidParameterValue	Erro de valor de parâmetro inválido
KnowledgeBaseNotFound	Erro não encontrado na base de dados de conhecimento
AzureCognitiveSearchNotFound	Erro não encontrado no Azure Cognitive Search
AzureCognitiveSearchThrottling	Erro de limitação do Azure Cognitive Search
ExtractionFailure	Erro de falha de extração
InvalidRequestBodyFormat	Erro de formato do corpo da solicitação inválido
EmptyRequest	Erro de solicitação vazia
MissingInputDocuments	Erro de documentos de entrada ausentes
InvalidDocument	Erro de documento inválido
ModelVersionIncorrect	Erro incorreto da versão do modelo
InvalidDocumentBatch	Erro em lote de documento inválido
UnsupportedLanguageCode	Erro de código de idioma sem suporte
InvalidCountryHint	Erro de dica de país inválido

InnerErrorModel

Objeto

Um objeto que contém informações mais específicas sobre o erro. De acordo com as diretrizes da API do Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Description
code	InnerErrorCode	Um de um conjunto definido pelo servidor de códigos de erro.
details	object	Detalhes do erro.
innererror	InnerErrorModel	Um objeto que contém informações mais específicas do que o objeto atual sobre o erro.
message	string	Mensagem de erro.
target	string	Destino de erro.

sourceContentStructureKind

Enumeração

Tipo de estrutura de conteúdo para fontes.

Valor	Description
unstructured	Desestruturado.

sourceKind

Enumeração

Tipos de origem com suporte.

Valor	Description
file	Fonte do arquivo.
url	Fonte do URI.

updateOperationKind

Enumeração

Atualize o tipo de operação para ativos.

Valor	Description
add	Adicionar operação.
delete	Operação de exclusão.
replace	Substitua a operação.

UpdateQnaSourceRecord

Objeto

Atualizar registro de origem.

Nome	Tipo	Valor padrão	Description
contentStructureKind	sourceContentStructureKind	unstructured	Tipo de estrutura de conteúdo para fontes.
displayName	string minLength: 1 maxLength: 200		Nome amigável da origem.
refresh	boolean		Sinalizador booleano usado para atualizar dados da Origem.
source	string		Identificador de origem exclusivo. Nome do arquivo se for uma fonte de 'arquivo'; caso contrário, o URL completo se for uma fonte de 'url'.
sourceKind	sourceKind		Tipos de origem com suporte.
sourceUri	string (uri)		Local do URI para o arquivo ou url.

UpdateSourceRecord

Objeto

Fonte a ser atualizada.

Nome	Tipo	Description
op	updateOperationKind	Atualize o tipo de operação para ativos.
value	UpdateQnaSourceRecord	Atualizar registro de origem.

Compartilhar via

Question Answering Projects - Update Sources

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

Ocp-Apim-Subscription-Key

OAuth2Auth

Escopos

Exemplos

Successful query

Solicitação de exemplo

Resposta de exemplo

Definições

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

sourceContentStructureKind

sourceKind

updateOperationKind

UpdateQnaSourceRecord

UpdateSourceRecord