Question Answering Projects - Update Sources

Dienst:

Azure AI Services

API-Version:

2023-04-01

Aktualisiert die Quellen eines Projekts.

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

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
Endpoint	path	True	string (uri)	Unterstützter Cognitive Services-Endpunkt (z. B. 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]$	Der Name des zu verwendenden Projekts.
api-version	query	True	string minLength: 1	Hierbei handelt es sich um die für diesen Vorgang zu verwendende API-Version.

Anforderungstext

Name	Typ	Beschreibung
body	UpdateSourceRecord[]	Aktualisieren Sie die Quellparameter eines Projekts.

Antworten

Name	Typ	Beschreibung
202 Accepted		Die Anforderung wurde zur Verarbeitung angenommen, die Verarbeitung ist jedoch noch nicht abgeschlossen. Header Operation-Location: string
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort. Header x-ms-error-code: string

Sicherheit

Ocp-Apim-Subscription-Key

Typ: apiKey
In: header

OAuth2Auth

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
https://cognitiveservices.azure.com/.default

Beispiele

Successful query

Beispielanforderung

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

Beispiel für eine Antwort

Statuscode:

202

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

Definitionen

Name	Beschreibung
Error	Das Fehlerobjekt.
ErrorCode	Lesbarer Fehlercode.
ErrorResponse	Fehlerantwort.
InnerErrorCode	Lesbarer Fehlercode.
InnerErrorModel	Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
sourceContentStructureKind	Inhaltsstrukturtyp für Quellen.
sourceKind	Unterstützte Quelltypen.
updateOperationKind	Aktualisieren des Vorgangstyps für Anlagen.
UpdateQnaSourceRecord	Aktualisieren des Quelldatensatzes.
UpdateSourceRecord	Quelle wird noch aktualisiert.

Error

Objekt

Das Fehlerobjekt.

Name	Typ	Beschreibung
code	ErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	Error[]	Ein Array von Details zu bestimmten Fehlern, die zu diesem gemeldeten Fehler geführt haben.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Eine lesbare Darstellung des Fehlers.
target	string	Das Ziel des Fehlers.

ErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
InvalidRequest	Ungültiger Anforderungsfehler
InvalidArgument	Ungültiger Argumentfehler
Unauthorized	Fehler beim nicht autorisierten Zugriff
Forbidden	Fehler beim unzulässigen Zugriff
NotFound	Fehler nicht gefunden
ProjectNotFound	Fehler beim Fehler "Projekt nicht gefunden"
OperationNotFound	Fehler beim Vorgang nicht gefunden
AzureCognitiveSearchNotFound	Fehler bei Azure Cognitive Search nicht gefunden
AzureCognitiveSearchIndexNotFound	Der Azure Cognitive Search-Index wurde nicht gefunden
TooManyRequests	Fehler bei zu vielen Anforderungen
AzureCognitiveSearchThrottling	Fehler bei der Drosselung von Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search Index limit reached error
InternalServerError	Interner Serverfehler
ServiceUnavailable	Fehler "Dienst nicht verfügbar"
Timeout	Timeout-Fehler
QuotaExceeded	Fehler "Kontingent überschritten"
Conflict	Konfliktfehler
Warning	Warnungsfehler

ErrorResponse

Objekt

Fehlerantwort.

Name	Typ	Beschreibung
error	Error	Das Fehlerobjekt.

InnerErrorCode

Enumeration

Lesbarer Fehlercode.

Wert	Beschreibung
InvalidRequest	Ungültiger Anforderungsfehler
InvalidParameterValue	Ungültiger Parameterwertfehler
KnowledgeBaseNotFound	Fehler in der Knowledge Base nicht gefunden
AzureCognitiveSearchNotFound	Fehler bei Azure Cognitive Search nicht gefunden
AzureCognitiveSearchThrottling	Fehler bei der Drosselung von Azure Cognitive Search
ExtractionFailure	Fehler bei Extraktionsfehlern
InvalidRequestBodyFormat	Ungültiger Fehler beim Anforderungstextformat
EmptyRequest	Fehler "Leere Anforderung"
MissingInputDocuments	Fehler bei fehlenden Eingabedokumenten
InvalidDocument	Ungültiger Dokumentfehler
ModelVersionIncorrect	Fehler bei der Modellversion
InvalidDocumentBatch	Ungültiger Dokumentbatchfehler
UnsupportedLanguageCode	Fehler beim nicht unterstützten Sprachcode
InvalidCountryHint	Ungültiger Fehler im Landhinweis

InnerErrorModel

Objekt

Ein Objekt, das spezifischere Informationen zum Fehler enthält. Gemäß den Microsoft One-API-Richtlinien – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Beschreibung
code	InnerErrorCode	Eine serverdefinierte Gruppe von Fehlercodes.
details	object	Fehlerdetails.
innererror	InnerErrorModel	Ein Objekt, das spezifischere Informationen enthält als das aktuelle Objekt über den Fehler.
message	string	Fehlermeldung.
target	string	Fehlerziel.

sourceContentStructureKind

Enumeration

Inhaltsstrukturtyp für Quellen.

Wert	Beschreibung
unstructured	Unstrukturiert.

sourceKind

Enumeration

Unterstützte Quelltypen.

Wert	Beschreibung
file	Quelle der Datei.
url	URI-Quelle.

updateOperationKind

Enumeration

Aktualisieren des Vorgangstyps für Anlagen.

Wert	Beschreibung
add	Vorgang hinzufügen.
delete	Vorgang löschen.
replace	Vorgang ersetzen.

UpdateQnaSourceRecord

Objekt

Aktualisieren des Quelldatensatzes.

Name	Typ	Standardwert	Beschreibung
contentStructureKind	sourceContentStructureKind	unstructured	Inhaltsstrukturtyp für Quellen.
displayName	string minLength: 1 maxLength: 200		Anzeigename der Quelle.
refresh	boolean		Boolesches Flag, das zum Aktualisieren von Daten aus der Quelle verwendet wird.
source	string		Eindeutige Quellenkennung. Name der Datei, wenn es sich um eine "Datei"-Quelle handelt; Andernfalls die vollständige URL, wenn es sich um eine 'URL'-Quelle handelt.
sourceKind	sourceKind		Unterstützte Quelltypen.
sourceUri	string (uri)		URI-Speicherort für die Datei oder URL.

UpdateSourceRecord

Objekt

Quelle wird noch aktualisiert.

Name	Typ	Beschreibung
op	updateOperationKind	Aktualisieren des Vorgangstyps für Anlagen.
value	UpdateQnaSourceRecord	Aktualisieren des Quelldatensatzes.