Question Answering Projects - Update Sources

Tjänst:

Azure AI Services

API-version:

2023-04-01

Uppdaterar källorna för ett projekt.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string (uri)	Cognitive Services-slutpunkt som stöds (t.ex. 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]$	Namnet på projektet som ska användas.
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.

Begärandetext

Name	Typ	Description
body	UpdateSourceRecord[]	Uppdatera källparametrar för ett projekt.

Svar

Name	Typ	Description
202 Accepted		Begäran har godkänts för behandling, men bearbetningen har ännu inte slutförts. Sidhuvuden Operation-Location: string
Other Status Codes	ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Exempel

Successful query

Exempelbegäran

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

Exempelsvar

Statuskod:

202

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

Definitioner

Name	Description
Error	Felobjektet.
ErrorCode	Felkod som kan läsas av människor.
ErrorResponse	Felsvar.
InnerErrorCode	Felkod som kan läsas av människor.
InnerErrorModel	Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
sourceContentStructureKind	Innehållsstrukturtyp för källor.
sourceKind	Källtyper som stöds.
updateOperationKind	Uppdateringsåtgärdstyp för tillgångar.
UpdateQnaSourceRecord	Uppdatera källposten.
UpdateSourceRecord	Källa som ska uppdateras.

Error

Objekt

Felobjektet.

Name	Typ	Description
code	ErrorCode	En av en serverdefinierad uppsättning felkoder.
details	Error[]	En matris med information om specifika fel som ledde till det rapporterade felet.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	En mänsklig läsbar representation av felet.
target	string	Målet för felet.

ErrorCode

Uppräkning

Felkod som kan läsas av människor.

Värde	Description
InvalidRequest	Ogiltigt begärandefel
InvalidArgument	Ogiltigt argumentfel
Unauthorized	Fel vid obehörig åtkomst
Forbidden	Fel om förbjuden åtkomst
NotFound	Det gick inte att hitta felet
ProjectNotFound	Det gick inte att hitta projektet
OperationNotFound	Det gick inte att hitta åtgärden
AzureCognitiveSearchNotFound	Azure Cognitive Search hittades inte
AzureCognitiveSearchIndexNotFound	Azure Cognitive Search-indexet hittades inte
TooManyRequests	Fel vid för många begäranden
AzureCognitiveSearchThrottling	Azure Cognitive Search-begränsningsfel
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search-indexgränsen nådde fel
InternalServerError	Internt serverfel.
ServiceUnavailable	Fel som inte är tillgänglig för tjänsten
Timeout	Timeout-fel
QuotaExceeded	Fel om överskriden kvot
Conflict	Konfliktfelmeddelande
Warning	Varningsfel

ErrorResponse

Objekt

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorCode

Uppräkning

Felkod som kan läsas av människor.

Värde	Description
InvalidRequest	Ogiltigt begärandefel
InvalidParameterValue	Ogiltigt parametervärdefel
KnowledgeBaseNotFound	Det gick inte att hitta kunskapsbasen
AzureCognitiveSearchNotFound	Azure Cognitive Search hittades inte
AzureCognitiveSearchThrottling	Azure Cognitive Search-begränsningsfel
ExtractionFailure	Fel vid extrahering
InvalidRequestBodyFormat	Ogiltigt fel i brödtextformat för begäran
EmptyRequest	Fel vid tom begäran
MissingInputDocuments	Fel i indatadokument saknas
InvalidDocument	Ogiltigt dokumentfel
ModelVersionIncorrect	Fel i modellversion
InvalidDocumentBatch	Ogiltigt dokumentbatchfel
UnsupportedLanguageCode	Fel med språkkod som inte stöds
InvalidCountryHint	Ogiltigt landtipsfel

InnerErrorModel

Objekt

Ett objekt som innehåller mer specifik information om felet. Enligt Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	En av en serverdefinierad uppsättning felkoder.
details	object	Felinformation.
innererror	InnerErrorModel	Ett objekt som innehåller mer specifik information än det aktuella objektet om felet.
message	string	Felmeddelande.
target	string	Felmål.

sourceContentStructureKind

Uppräkning

Innehållsstrukturtyp för källor.

Värde	Description
unstructured	Ostrukturerat.

sourceKind

Uppräkning

Källtyper som stöds.

Värde	Description
file	Fil källa.
url	URI-källa.

updateOperationKind

Uppräkning

Uppdateringsåtgärdstyp för tillgångar.

Värde	Description
add	Lägg till åtgärd.
delete	Ta bort åtgärden.
replace	Byt ut operationen.

UpdateQnaSourceRecord

Objekt

Uppdatera källposten.

Name	Typ	Standardvärde	Description
contentStructureKind	sourceContentStructureKind	unstructured	Innehållsstrukturtyp för källor.
displayName	string minLength: 1 maxLength: 200		Eget namn på källan.
refresh	boolean		Boolesk flagga som används för att uppdatera data från källan.
source	string		Unik källidentifierare. Namnet på filen om det är en "fil"-källa; Annars den fullständiga URL:en om det är en URL-källa.
sourceKind	sourceKind		Källtyper som stöds.
sourceUri	string (uri)		URI-plats för filen eller URL:en.

UpdateSourceRecord

Objekt

Källa som ska uppdateras.

Name	Typ	Description
op	updateOperationKind	Uppdateringsåtgärdstyp för tillgångar.
value	UpdateQnaSourceRecord	Uppdatera källposten.