Question Answering Projects - Update Sources

Service:: Azure AI Services

API-versie:: 2023-04-01

Hiermee worden de bronnen van een project bijgewerkt.

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

URI-parameters

Name	In	Vereist	Type	Description
Endpoint	path	True	string (uri)	Ondersteund Cognitive Services-eindpunt (bijvoorbeeld 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]$	De naam van het te gebruiken project.
api-version	query	True	string minLength: 1	De API-versie die voor deze bewerking moet worden gebruikt.

Aanvraagbody

Name	Type	Description
body	UpdateSourceRecord[]	Werk de bronparameters van een project bij.

Antwoorden

Name	Type	Description
202 Accepted		De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid. Kopteksten Operation-Location: string
Other Status Codes	ErrorResponse	Een onverwachte foutreactie. Kopteksten x-ms-error-code: string

Name

Type

Description

202 Accepted

De aanvraag is geaccepteerd voor verwerking, maar de verwerking is nog niet voltooid.

Kopteksten

Operation-Location: string

Other Status Codes

ErrorResponse

Een onverwachte foutreactie.

Kopteksten

x-ms-error-code: string

Beveiliging

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

OAuth2Auth

Type: oauth2
Stroom: implicit
Autorisatie-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiken

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

Voorbeelden

Successful query

Voorbeeldaanvraag

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

Voorbeeldrespons

Statuscode:: 202

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

Definities

Name	Description
Error	Het foutobject.
ErrorCode	Leesbare foutcode.
ErrorResponse	Foutreactie.
InnerErrorCode	Leesbare foutcode.
InnerErrorModel	Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
sourceContentStructureKind	Type inhoudsstructuur voor bronnen.
sourceKind	Ondersteunde brontypen.
updateOperationKind	Werk het bewerkingstype voor activa bij.
UpdateQnaSourceRecord	Bronrecord bijwerken.
UpdateSourceRecord	Bron moet worden bijgewerkt.

Error

Object

Het foutobject.

Name	Type	Description
code	ErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	Error[]	Een matrix met details over specifieke fouten die hebben geleid tot deze gemelde fout.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Een leesbare weergave van de fout.
target	string	Het doel van de fout.

ErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
InvalidRequest	Ongeldige aanvraagfout
InvalidArgument	Ongeldig argumentfout
Unauthorized	Fout bij onbevoegde toegang
Forbidden	Fout bij verboden toegang
NotFound	Fout niet gevonden
ProjectNotFound	De fout Project is niet gevonden
OperationNotFound	Fout bij bewerking niet gevonden
AzureCognitiveSearchNotFound	Fout met Azure Cognitive Search is niet gevonden
AzureCognitiveSearchIndexNotFound	Fout bij azure Cognitive Search-index is niet gevonden
TooManyRequests	Fout bij te veel aanvragen
AzureCognitiveSearchThrottling	Beperkingsfout in Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search-indexlimiet bereikt fout
InternalServerError	Interne serverfout
ServiceUnavailable	Fout over niet-beschikbaar service
Timeout	Time-outfout
QuotaExceeded	Fout over overschreden quotum
Conflict	Conflict fout
Warning	Waarschuwingsfout

ErrorResponse

Object

Foutreactie.

Name	Type	Description
error	Error	Het foutobject.

InnerErrorCode

Inventarisatie

Leesbare foutcode.

Waarde	Description
InvalidRequest	Ongeldige aanvraagfout
InvalidParameterValue	Fout met ongeldige parameterwaarde
KnowledgeBaseNotFound	Fout in Knowledge Base is niet gevonden
AzureCognitiveSearchNotFound	Fout met Azure Cognitive Search is niet gevonden
AzureCognitiveSearchThrottling	Beperkingsfout in Azure Cognitive Search
ExtractionFailure	Fout bij extractiefout
InvalidRequestBodyFormat	Fout bij ongeldige indeling van aanvraagtekst
EmptyRequest	Fout bij lege aanvraag
MissingInputDocuments	Fout bij ontbrekende invoerdocumenten
InvalidDocument	Ongeldige documentfout
ModelVersionIncorrect	Fout bij onjuiste modelversie
InvalidDocumentBatch	Ongeldige documentbatchfout
UnsupportedLanguageCode	Fout met niet-ondersteunde taalcode
InvalidCountryHint	Fout met ongeldige landhint

InnerErrorModel

Object

Een object met meer specifieke informatie over de fout. Volgens de richtlijnen voor Microsoft One-API- https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Type	Description
code	InnerErrorCode	Een van een door de server gedefinieerde set foutcodes.
details	object	Foutdetails.
innererror	InnerErrorModel	Een object met meer specifieke informatie dan het huidige object over de fout.
message	string	Foutmelding.
target	string	Foutdoel.

sourceContentStructureKind

Inventarisatie

Type inhoudsstructuur voor bronnen.

Waarde	Description
unstructured	Ongestructureerde.

sourceKind

Inventarisatie

Ondersteunde brontypen.

Waarde	Description
file	Bron van het bestand.
url	URI-bron.

updateOperationKind

Inventarisatie

Werk het bewerkingstype voor activa bij.

Waarde	Description
add	Bewerking toevoegen.
delete	Bewerking verwijderen.
replace	Vervang de bediening.

UpdateQnaSourceRecord

Object

Bronrecord bijwerken.

Name	Type	Default value	Description
contentStructureKind	sourceContentStructureKind	unstructured	Type inhoudsstructuur voor bronnen.
displayName	string minLength: 1 maxLength: 200		Beschrijvende naam van de bron.
refresh	boolean		Booleaanse vlag die wordt gebruikt om gegevens van de bron te vernieuwen.
source	string		Unieke bron-ID. Naam van het bestand als het een 'bestand'-bron is; anders de volledige URL als het een 'url'-bron is.
sourceKind	sourceKind		Ondersteunde brontypen.
sourceUri	string (uri)		URI-locatie voor het bestand of de url.

UpdateSourceRecord

Object

Bron moet worden bijgewerkt.

Name	Type	Description
op	updateOperationKind	Werk het bewerkingstype voor activa bij.
value	UpdateQnaSourceRecord	Bronrecord bijwerken.

Delen via

Question Answering Projects - Update Sources

URI-parameters

Aanvraagbody

Antwoorden

Beveiliging

Ocp-Apim-Subscription-Key

OAuth2Auth

Bereiken

Voorbeelden

Successful query

Voorbeeldaanvraag

Voorbeeldrespons

Definities

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

sourceContentStructureKind

sourceKind

updateOperationKind

UpdateQnaSourceRecord

UpdateSourceRecord