Question Answering Projects - Update Sources

Servicio:

Azure AI Services

Versión de la API:

2021-10-01

Actualiza los orígenes de un proyecto.

PATCH {Endpoint}/language/query-knowledgebases/projects/{projectName}/sources?api-version=2021-10-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	Nombre del proyecto que se va a usar.
api-version	query	True	string	Versión de la API de cliente.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Cuerpo de la solicitud

Nombre	Tipo	Description
body	UpdateSourceRecord[]	Actualice los parámetros de orígenes de un proyecto.

Respuestas

Nombre	Tipo	Description
202 Accepted		Una llamada correcta devuelve un encabezado Operation-Location que se usa para comprobar el estado del trabajo. Encabezados Operation-Location: string
Other Status Codes	ErrorResponse	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Successful query

Solicitud de ejemplo

HTTP

PATCH {Endpoint}/language/query-knowledgebases/projects/proj1/sources?api-version=2021-10-01


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

Respuesta de muestra

status code:

202

Operation-Location: job1

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 orígenes.
sourceKind	Tipos de origen admitidos.
updateOperationKind	Tipo de operación de actualización para los recursos.
UpdateQnaSourceRecord	Actualice el registro de origen.
UpdateSourceRecord	Origen que se va 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
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

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
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

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 orígenes.

Valor	Description
unstructured

sourceKind

Enumeración

Tipos de origen admitidos.

Valor	Description
file
url

updateOperationKind

Enumeración

Tipo de operación de actualización para los recursos.

Valor	Description
add
delete
replace

UpdateQnaSourceRecord

Object

Actualice el registro de origen.

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

UpdateSourceRecord

Object

Origen que se va a actualizar.

Nombre	Tipo	Description
op	updateOperationKind	Tipo de operación de actualización para los recursos.
value	UpdateQnaSourceRecord	Actualice el registro de origen.