Question Answering Projects - Update Sources

Servicio:: Azure AI Services

Versión de la API:: 2023-04-01

Actualiza los orígenes de un proyecto.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string (uri)	Punto de conexión de Cognitive Services admitido (por ejemplo, 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]$	Nombre del proyecto que se va a usar.
api-version	query	True	string minLength: 1	La versión de API que se va a utilizar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
body	UpdateSourceRecord[]	Actualizar los parámetros de origen de un proyecto.

Respuestas

Nombre	Tipo	Description
202 Accepted		La solicitud ha sido aceptada para su procesamiento, pero el procesamiento aún no se ha completado. Encabezados Operation-Location: string
Other Status Codes	ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

202 Accepted

La solicitud ha sido aceptada para su procesamiento, pero el procesamiento aún no se ha completado.

Encabezados

Operation-Location: string

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

Ejemplos

Successful query

Solicitud de ejemplo

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"
    }
  }
]

Respuesta de muestra

status code:: 202

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

Definiciones

Nombre	Description
Error	Objeto de error.
ErrorCode	Código de error legible para personas.
ErrorResponse	Respuesta de error.
InnerErrorCode	Código de error legible para personas.
InnerErrorModel	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
sourceContentStructureKind	Tipo de estructura de contenido para fuentes.
sourceKind	Tipos de origen admitidos.
updateOperationKind	Actualizar el tipo de operación para los activos.
UpdateQnaSourceRecord	Actualizar registro de origen.
UpdateSourceRecord	Fuente a actualizar.

Error

Object

Objeto de error.

Nombre	Tipo	Description
code	ErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

ErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
InvalidRequest	Error de solicitud no válido
InvalidArgument	Error de argumento no válido
Unauthorized	Error de acceso no autorizado
Forbidden	Error de acceso prohibido
NotFound	Error no encontrado
ProjectNotFound	Error de proyecto no encontrado
OperationNotFound	Error de operación no encontrado
AzureCognitiveSearchNotFound	Error no encontrado de Azure Cognitive Search
AzureCognitiveSearchIndexNotFound	Error no encontrado en el índice de Azure Cognitive Search
TooManyRequests	Error de demasiadas solicitudes
AzureCognitiveSearchThrottling	Error de limitación de Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Error alcanzado el límite de índices de Azure Cognitive Search
InternalServerError	Error interno del servidor
ServiceUnavailable	Error de servicio no disponible
Timeout	Error de tiempo de espera
QuotaExceeded	Error de cuota superada
Conflict	Error de conflicto
Warning	Error de advertencia

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

InnerErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
InvalidRequest	Error de solicitud no válido
InvalidParameterValue	Error de valor de parámetro no válido
KnowledgeBaseNotFound	Error de base de conocimiento no encontrado
AzureCognitiveSearchNotFound	Error no encontrado de Azure Cognitive Search
AzureCognitiveSearchThrottling	Error de limitación de Azure Cognitive Search
ExtractionFailure	Error de extracción
InvalidRequestBodyFormat	Error de formato de cuerpo de solicitud no válido
EmptyRequest	Error de solicitud vacía
MissingInputDocuments	Error de documentos de entrada que faltan
InvalidDocument	Error de documento no válido
ModelVersionIncorrect	Error incorrecto de la versión del modelo
InvalidDocumentBatch	Error de lote de documento no válido
UnsupportedLanguageCode	Error de código de idioma no admitido
InvalidCountryHint	Error de sugerencia de país no válido

InnerErrorModel

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	InnerErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	object	Detalles del error.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Mensaje de error.
target	string	Destino de error.

sourceContentStructureKind

Enumeración

Tipo de estructura de contenido para fuentes.

Valor	Description
unstructured	Desestructurado.

sourceKind

Enumeración

Tipos de origen admitidos.

Valor	Description
file	Fuente del archivo.
url	Fuente URI.

updateOperationKind

Enumeración

Actualizar el tipo de operación para los activos.

Valor	Description
add	Agregar operación.
delete	Operación de eliminación.
replace	Operación de reemplazo.

UpdateQnaSourceRecord

Object

Actualizar registro de origen.

Nombre	Tipo	Valor predeterminado	Description
contentStructureKind	sourceContentStructureKind	unstructured	Tipo de estructura de contenido para fuentes.
displayName	string minLength: 1 maxLength: 200		Nombre descriptivo del origen.
refresh	boolean		Marca booleana utilizada para actualizar los datos del origen.
source	string		Identificador único de origen. Nombre del archivo si es una fuente de 'archivo'; de lo contrario, la URL completa si es una fuente de 'url'.
sourceKind	sourceKind		Tipos de origen admitidos.
sourceUri	string (uri)		Ubicación del URI del archivo o la dirección URL.

UpdateSourceRecord

Object

Fuente a actualizar.

Nombre	Tipo	Description
op	updateOperationKind	Actualizar el tipo de operación para los activos.
value	UpdateQnaSourceRecord	Actualizar registro de origen.

Compartir a través de

Question Answering Projects - Update Sources

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

OAuth2Auth

Ámbitos

Ejemplos

Successful query

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

sourceContentStructureKind

sourceKind

updateOperationKind

UpdateQnaSourceRecord

UpdateSourceRecord