Question Answering Projects - Update Sources

Service:

Cognitive Services

API Version:

2021-10-01

Uppdateringar källorna till ett projekt.

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

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string	Cognitive Services-slutpunkt som stöds (t.ex. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Namnet på det projekt som ska användas.
api-version	query	True	string	Klient-API-version.

Begärandehuvud

Name	Obligatorisk	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Begärandetext

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

Svar

Name	Typ	Description
202 Accepted		Ett lyckat anrop resulterar i ett Operation-Location-huvud som används för att kontrollera jobbets status. Headers Operation-Location: string
Other Status Codes	ErrorResponse	Felsvar.

Säkerhet

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Exempel

Successful query

Sample Request

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

Sample Response

Status code:

202

Operation-Location: job1

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 Microsoft One API-riktlinjer – 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

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

Felkod som kan läsas av människor.

Name	Typ	Description
AzureCognitiveSearchIndexLimitReached	string
AzureCognitiveSearchIndexNotFound	string
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
Forbidden	string
InternalServerError	string
InvalidArgument	string
InvalidRequest	string
NotFound	string
OperationNotFound	string
ProjectNotFound	string
ServiceUnavailable	string
TooManyRequests	string
Unauthorized	string

ErrorResponse

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorCode

Felkod som kan läsas av människor.

Name	Typ	Description
AzureCognitiveSearchNotFound	string
AzureCognitiveSearchThrottling	string
ExtractionFailure	string
InvalidParameterValue	string
InvalidRequest	string
KnowledgeBaseNotFound	string

InnerErrorModel

Ett objekt som innehåller mer specifik information om felet. Enligt Microsoft One API-riktlinjer – 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

Innehållsstrukturtyp för källor.

Name	Typ	Description
unstructured	string

sourceKind

Källtyper som stöds.

Name	Typ	Description
file	string
url	string

updateOperationKind

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

Name	Typ	Description
add	string
delete	string
replace	string

UpdateQnaSourceRecord

Uppdatera källposten.

Name	Typ	Standardvärde	Description
contentStructureKind	sourceContentStructureKind	Unstructured	Innehållsstrukturtyp för källor.
displayName	string		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 filkälla. Annars är den fullständiga URL:en om det är en url-källa.
sourceKind	sourceKind	url	Källtyper som stöds.
sourceUri	string		URI-plats för filen eller URL:en.

UpdateSourceRecord

Källa som ska uppdateras.

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