Question Answering Projects - Update Sources

Služba:: Azure AI Services

Verze rozhraní API:: 2023-04-01

Aktualizuje zdroje projektu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string (uri)	Podporovaný koncový bod služeb Cognitive Services (např. 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]$	Název projektu, který se má použít.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
body	UpdateSourceRecord[]	Aktualizujte parametry zdrojů projektu.

Odpovědi

Name	Typ	Description
202 Accepted		Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno. Hlavičky Operation-Location: string
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Name

Typ

Description

202 Accepted

Žádost byla přijata ke zpracování, ale zpracování ještě nebylo dokončeno.

Hlavičky

Operation-Location: string

Other Status Codes

ErrorResponse

Neočekávaná chybová odpověď

Hlavičky

x-ms-error-code: string

Zabezpečení

Ocp-Apim-Subscription-Key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/authorize

Rozsahy

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

Příklady

Successful query

Ukázkový požadavek

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

Ukázková odpověď

Stavový kód:: 202

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

Definice

Name	Description
Error	Objekt chyby.
ErrorCode	Kód chyby čitelné člověkem
ErrorResponse	Chybová odpověď.
InnerErrorCode	Kód chyby čitelné člověkem
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
sourceContentStructureKind	Typ struktury obsahu pro zdroje.
sourceKind	Podporované typy zdrojů.
updateOperationKind	Aktualizujte typ operace pro datové zdroje.
UpdateQnaSourceRecord	Aktualizovat zdrojový záznam.
UpdateSourceRecord	Zdroj, který bude aktualizován.

Error

Objekt

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jedna ze serverově definovaných kódů chyb.
details	Error[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Čitelné znázornění chyby člověkem.
target	string	Cíl chyby.

ErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
InvalidRequest	Chyba neplatné žádosti
InvalidArgument	Chyba neplatného argumentu
Unauthorized	Chyba neoprávněného přístupu
Forbidden	Chyba zakázaného přístupu
NotFound	Chyba nenalezena
ProjectNotFound	Chyba projektu nebyla nalezena.
OperationNotFound	Chyba operace nebyla nalezena.
AzureCognitiveSearchNotFound	Chyba nenalezena službou Azure Cognitive Search
AzureCognitiveSearchIndexNotFound	Chyba indexu služby Azure Cognitive Search nebyla nalezena.
TooManyRequests	Chyba příliš mnoho požadavků
AzureCognitiveSearchThrottling	Chyba omezování služby Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Došlo k chybě dosažení limitu indexu služby Azure Cognitive Search
InternalServerError	Vnitřní chyba serveru
ServiceUnavailable	Chyba nedostupnosti služby
Timeout	Chyba časového limitu
QuotaExceeded	Chyba překročení kvóty
Conflict	Chyba konfliktu
Warning	Chyba upozornění

ErrorResponse

Objekt

Chybová odpověď.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode

Výčet

Kód chyby čitelné člověkem

Hodnota	Description
InvalidRequest	Chyba neplatné žádosti
InvalidParameterValue	Chyba neplatné hodnoty parametru
KnowledgeBaseNotFound	Chyba nenalezena znalostní báze
AzureCognitiveSearchNotFound	Chyba nenalezena službou Azure Cognitive Search
AzureCognitiveSearchThrottling	Chyba omezování služby Azure Cognitive Search
ExtractionFailure	Chyba selhání extrakce
InvalidRequestBodyFormat	Chyba neplatného formátu textu požadavku
EmptyRequest	Chyba prázdného požadavku
MissingInputDocuments	Chyba chybějících vstupních dokumentů
InvalidDocument	Chyba neplatného dokumentu
ModelVersionIncorrect	Nesprávná chyba verze modelu
InvalidDocumentBatch	Chyba dávky neplatného dokumentu
UnsupportedLanguageCode	Chyba nepodporovaného kódu jazyka
InvalidCountryHint	Neplatná chyba nápovědy pro zemi

InnerErrorModel

Objekt

Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní API Microsoft One – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name	Typ	Description
code	InnerErrorCode	Jedna ze serverově definovaných kódů chyb.
details	object	Podrobnosti o chybě
innererror	InnerErrorModel	Objekt obsahující konkrétnější informace, než je aktuální objekt o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby

sourceContentStructureKind

Výčet

Typ struktury obsahu pro zdroje.

Hodnota	Description
unstructured	Nestrukturovaný.

sourceKind

Výčet

Podporované typy zdrojů.

Hodnota	Description
file	Zdroj souboru.
url	Zdroj identifikátoru URI.

updateOperationKind

Výčet

Aktualizujte typ operace pro datové zdroje.

Hodnota	Description
add	Přidat operaci.
delete	Operace odstranění.
replace	Nahradit provoz.

UpdateQnaSourceRecord

Objekt

Aktualizovat zdrojový záznam.

Name	Typ	Default value	Description
contentStructureKind	sourceContentStructureKind	unstructured	Typ struktury obsahu pro zdroje.
displayName	string minLength: 1 maxLength: 200		Popisný název zdroje
refresh	boolean		Booleovský příznak používaný k aktualizaci dat ze zdroje.
source	string		Jedinečný identifikátor zdroje. Název souboru, pokud se jedná o zdroj 'file'; v opačném případě úplnou adresu URL, pokud se jedná o zdroj 'url'.
sourceKind	sourceKind		Podporované typy zdrojů.
sourceUri	string (uri)		Umístění identifikátoru URI pro soubor nebo adresu URL.

UpdateSourceRecord

Objekt

Zdroj, který bude aktualizován.

Name	Typ	Description
op	updateOperationKind	Aktualizujte typ operace pro datové zdroje.
value	UpdateQnaSourceRecord	Aktualizovat zdrojový záznam.

Sdílet prostřednictvím

Question Answering Projects - Update Sources

Parametry identifikátoru URI

Text požadavku

Odpovědi

Zabezpečení

Ocp-Apim-Subscription-Key

OAuth2Auth

Rozsahy

Příklady

Successful query

Ukázkový požadavek

Ukázková odpověď

Definice

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

sourceContentStructureKind

sourceKind

updateOperationKind

UpdateQnaSourceRecord

UpdateSourceRecord