Question Answering Projects - Update Sources

Service:

Azure AI Services

Version d'API:

2023-04-01

Met à jour les sources d’un projet.

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
Endpoint	path	True	string (uri)	Point de terminaison Cognitive Services pris en charge (par exemple, https://< nom-ressource.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]$	Nom du projet à utiliser.
api-version	query	True	string minLength: 1	Version de l’API à utiliser pour cette opération.

Corps de la demande

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

Réponses

Nom	Type	Description
202 Accepted		Le traitement de la demande a été accepté, mais le traitement n’est pas encore terminé. En-têtes Operation-Location: string
Other Status Codes	ErrorResponse	Réponse d’erreur inattendue. En-têtes x-ms-error-code: string

Sécurité

Ocp-Apim-Subscription-Key

Type: apiKey
Dans: header

OAuth2Auth

Type: oauth2
Flux: implicit
URL d’autorisation: https://login.microsoftonline.com/common/oauth2/authorize

Étendues

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

Exemples

Successful query

Exemple de requête

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

Exemple de réponse

Code d’état:

202

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

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 de 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
InvalidRequest	Erreur de requête non valide
InvalidArgument	Erreur d’argument non valide
Unauthorized	Erreur d’accès non autorisé
Forbidden	Erreur d’accès interdit
NotFound	Erreur introuvable
ProjectNotFound	Erreur de projet introuvable
OperationNotFound	Erreur d’opération introuvable
AzureCognitiveSearchNotFound	Erreur introuvable dans Recherche cognitive Azure
AzureCognitiveSearchIndexNotFound	Erreur introuvable dans l’index Recherche cognitive Azure
TooManyRequests	Trop d’erreurs de requêtes
AzureCognitiveSearchThrottling	Erreur de limitation de Recherche cognitive Azure
AzureCognitiveSearchIndexLimitReached	Erreur atteinte à la limite d’index Recherche cognitive Azure
InternalServerError	Erreur interne du serveur
ServiceUnavailable	Erreur d’indisponibilité du service
Timeout	Erreur de délai d’expiration
QuotaExceeded	Erreur de dépassement du quota
Conflict	Erreur de conflit
Warning	Erreur d’avertissement

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
InvalidRequest	Erreur de requête non valide
InvalidParameterValue	Erreur de valeur de paramètre non valide
KnowledgeBaseNotFound	Erreur introuvable dans la base de connaissances
AzureCognitiveSearchNotFound	Erreur introuvable dans Recherche cognitive Azure
AzureCognitiveSearchThrottling	Erreur de limitation de Recherche cognitive Azure
ExtractionFailure	Erreur d’échec d’extraction
InvalidRequestBodyFormat	Erreur de format du corps de la demande non valide
EmptyRequest	Erreur de requête vide
MissingInputDocuments	Erreur des documents d’entrée manquants
InvalidDocument	Erreur de document non valide
ModelVersionIncorrect	Erreur incorrecte de version du modèle
InvalidDocumentBatch	Erreur de lot de documents non valide
UnsupportedLanguageCode	Erreur de code de langue non prise en charge
InvalidCountryHint	Erreur d’indicateur de pays non valide

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	Non structurées.

sourceKind

Énumération

Types de sources pris en charge.

Valeur	Description
file	Source du fichier.
url	Source de l’URI.

updateOperationKind

Énumération

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

Valeur	Description
add	Ajouter une opération.
delete	Opération de suppression.
replace	Remplacer l’opération.

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 de 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		Types de sources pris en charge.
sourceUri	string (uri)		Emplacement de l’URI du fichier ou de 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.