Question Answering Projects - Create Project

Služba:: Azure AI Services

Verze rozhraní API:: 2023-04-01

Vytvořte nebo aktualizujte projekt.

PATCH {Endpoint}/language/authoring/query-knowledgebases/projects/{projectName}?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.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.

Text požadavku

Name	Typ	Description
description	string	Popis projektu
language	string	Jazyk textových záznamů Toto je reprezentace jazyka BCP-47. Například použijte "en" pro angličtinu; "es" pro španělštinu atd. Pokud není nastavená, jako výchozí použijte "en" pro angličtinu.
multilingualResource	boolean	Zdroj povolený pro více jazyků napříč projekty nebo ne.
settings	ProjectSettings	Konfigurovatelná nastavení projektu.

Odpovědi

Name	Typ	Description
200 OK	QuestionAnsweringProjectMetadata	Žádost byla úspěšná.
201 Created	QuestionAnsweringProjectMetadata	Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď Hlavičky x-ms-error-code: string

Name

Typ

Description

200 OK

QuestionAnsweringProjectMetadata

Žádost byla úspěšná.

201 Created

QuestionAnsweringProjectMetadata

Požadavek byl úspěšný a v důsledku toho byl vytvořen nový prostředek.

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?api-version=2023-04-01

{
  "description": "proj1 is a test project.",
  "multilingualResource": true,
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

Ukázková odpověď

Stavový kód:: 200

{
  "description": "proj1 is a test project.",
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "multilingualResource": true,
  "projectName": "proj1",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

Stavový kód:: 201

{
  "description": "proj1 is a test project.",
  "createdDateTime": "2021-05-01T15:13:22Z",
  "lastDeployedDateTime": "2021-05-01T15:13:22Z",
  "lastModifiedDateTime": "2021-05-01T15:13:22Z",
  "multilingualResource": true,
  "projectName": "proj1",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

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.
ProjectSettings	Konfigurovatelná nastavení projektu.
QuestionAnsweringProjectMetadata	Představuje projekt.
QuestionAnsweringProjectMetadataCreateOrUpdate	Představuje projekt.

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

ProjectSettings

Objekt

Konfigurovatelná nastavení projektu.

Name	Typ	Description
defaultAnswer	string	Výchozí odpověď odpovědi, pokud se ve znalostní bázi nenajde žádná dobrá shoda.

QuestionAnsweringProjectMetadata

Objekt

Představuje projekt.

Name	Typ	Description
createdDateTime	string (date-time)	Datum a čas vytvoření projektu
description	string	Popis projektu
language	string	Jazyk textových záznamů Toto je reprezentace jazyka BCP-47. Například použijte "en" pro angličtinu; "es" pro španělštinu atd. Pokud není nastavená, jako výchozí použijte "en" pro angličtinu.
lastDeployedDateTime	string (date-time)	Představuje datum a čas posledního nasazení projektu.
lastModifiedDateTime	string (date-time)	Představuje projekt datum a čas poslední změny.
multilingualResource	boolean	Zdroj povolený pro více jazyků napříč projekty nebo ne.
projectName	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Název projektu.
settings	ProjectSettings	Konfigurovatelná nastavení projektu.

QuestionAnsweringProjectMetadataCreateOrUpdate

Objekt

Představuje projekt.

Name	Typ	Description
description	string	Popis projektu
language	string	Jazyk textových záznamů Toto je reprezentace jazyka BCP-47. Například použijte "en" pro angličtinu; "es" pro španělštinu atd. Pokud není nastavená, jako výchozí použijte "en" pro angličtinu.
multilingualResource	boolean	Zdroj povolený pro více jazyků napříč projekty nebo ne.
settings	ProjectSettings	Konfigurovatelná nastavení projektu.

Sdílet prostřednictvím

Question Answering Projects - Create Project

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

ProjectSettings

QuestionAnsweringProjectMetadata

QuestionAnsweringProjectMetadataCreateOrUpdate