Question Answering Projects - Update Sources

Service:

Azure AI Services

Version d'API:

2021-10-01

Met à jour les sources d’un projet.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string	Point de terminaison Cognitive Services pris en charge (par exemple, https://.api.cognitiveservices.azure.com).
projectName	path	True	string maxLength: 100	Nom du projet à utiliser.
api-version	query	True	string	Version de l’API cliente.

En-tête de la demande

Nom	Obligatoire	Type	Description
Ocp-Apim-Subscription-Key	True	string

Corps de la demande

Nom	Type	Description
body	UpdateSourceRecord[]	Mettez à jour les paramètres sources d’un projet.

Réponses

Nom	Type	Description
202 Accepted		Un appel réussi donne un en-tête Operation-Location utilisé pour vérifier l’état du travail. En-têtes Operation-Location: string
Other Status Codes	ErrorResponse	Réponse d’erreur.

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

Exemples

Successful query

Exemple de requête

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

Exemple de réponse

Code d’état:

202

Operation-Location: job1

Définitions

Nom	Description
Error	Objet d’erreur.
ErrorCode	Code d’erreur lisible par l’homme.
ErrorResponse	Réponse d’erreur.
InnerErrorCode	Code d’erreur lisible par l’homme.
InnerErrorModel	Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
sourceContentStructureKind	Type de structure de contenu pour les sources.
sourceKind	Types sources pris en charge.
updateOperationKind	Mettre à jour le type d’opération pour les ressources.
UpdateQnaSourceRecord	Mettre à jour l’enregistrement source.
UpdateSourceRecord	Source à mettre à jour.

Error

Object

Objet d’erreur.

Nom	Type	Description
code	ErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	Error[]	Tableau de détails sur des erreurs spécifiques qui ont conduit à cette erreur signalée.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Représentation lisible par l’homme de l’erreur.
target	string	Cible de l’erreur.

ErrorCode

Énumération

Code d’erreur lisible par l’homme.

Valeur	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

Réponse d’erreur.

Nom	Type	Description
error	Error	Objet d’erreur.

InnerErrorCode

Énumération

Code d’erreur lisible par l’homme.

Valeur	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

Objet contenant des informations plus spécifiques sur l’erreur. Conformément aux instructions de l’API Microsoft One - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nom	Type	Description
code	InnerErrorCode	Un ensemble de codes d’erreur définis par le serveur.
details	object	Détails de l’erreur.
innererror	InnerErrorModel	Objet contenant des informations plus spécifiques que l’objet actuel sur l’erreur.
message	string	Message d'erreur.
target	string	Cible d’erreur.

sourceContentStructureKind

Énumération

Type de structure de contenu pour les sources.

Valeur	Description
unstructured

sourceKind

Énumération

Types sources pris en charge.

Valeur	Description
file
url

updateOperationKind

Énumération

Mettre à jour le type d’opération pour les ressources.

Valeur	Description
add
delete
replace

UpdateQnaSourceRecord

Object

Mettre à jour l’enregistrement source.

Nom	Type	Valeur par défaut	Description
contentStructureKind	sourceContentStructureKind	Unstructured	Type de structure de contenu pour les sources.
displayName	string minLength: 1 maxLength: 200		Nom convivial de la source.
refresh	boolean		Indicateur booléen utilisé pour actualiser les données de la source.
source	string		Identificateur source unique. Nom du fichier s’il s’agit d’une source « fichier » ; sinon, l’URL complète s’il s’agit d’une source « URL ».
sourceKind	sourceKind	url	Types sources pris en charge.
sourceUri	string (uri)		Emplacement de l’URI pour le fichier ou l’URL.

UpdateSourceRecord

Object

Source à mettre à jour.

Nom	Type	Description
op	updateOperationKind	Mettre à jour le type d’opération pour les ressources.
value	UpdateQnaSourceRecord	Mettre à jour l’enregistrement source.