Question Answering Projects - Get Project Details

Service:

Cognitive Services

API Version:

2021-10-01

Získejte požadovaná metadata projektu.

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
Endpoint	path	True	string	Podporovaný koncový bod služeb Cognitive Services (např. https://.api.cognitiveservices.azure.com).
projectName	path	True	string	Název projektu, který se má použít.
api-version	query	True	string	Verze klientského rozhraní API

Hlavička požadavku

Name	Vyžadováno	Typ	Description
Ocp-Apim-Subscription-Key	True	string

Odpovědi

Name	Typ	Description
200 OK	ProjectMetadata	Metadata pro zadaný projekt.
Other Status Codes	ErrorResponse	Odpověď na chybu.

Zabezpečení

Ocp-Apim-Subscription-Key

Type: apiKey
In: header

Příklady

Successful query

Sample Request

HTTP

GET {Endpoint}/language/query-knowledgebases/projects/proj1?api-version=2021-10-01

Sample Response

Status code:

200

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

Definice

Name	Description
Error	Objekt chyby.
ErrorCode	Kód chyby čitelný pro člověka.
ErrorResponse	Odpověď na chybu.
InnerErrorCode	Kód chyby čitelný pro člověka.
InnerErrorModel	Objekt obsahující konkrétnější informace o chybě. Podle pokynů k rozhraní Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectMetadata	Představuje projekt.
ProjectSettings	Konfigurovatelná nastavení projektu.

Error

Objekt chyby.

Name	Typ	Description
code	ErrorCode	Jeden ze serverem definované sady 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 o chybě než aktuální objekt.
message	string	Lidsky čitelná reprezentace chyby.
target	string	Cíl chyby.

ErrorCode

Kód chyby čitelný pro člověka.

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

Odpověď na chybu.

Name	Typ	Description
error	Error	Objekt chyby.

InnerErrorCode

Kód chyby čitelný pro člověka.

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

InnerErrorModel

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

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

ProjectMetadata

Představuje projekt.

Name	Typ	Description
createdDateTime	string	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 pro angličtinu použijte "en". "es" pro španělštinu atd. Pokud není nastavená, jako výchozí použijte "en" pro angličtinu.
lastDeployedDateTime	string	Představuje datum a čas posledního nasazení projektu.
lastModifiedDateTime	string	Představuje datum a čas poslední změny projektu.
multilingualResource	boolean	Zdroj je povolený pro více jazyků v projektech nebo ne.
projectName	string	Název projektu.
settings	ProjectSettings	Konfigurovatelná nastavení projektu.

ProjectSettings

Konfigurovatelná nastavení projektu.

Name	Typ	Description
defaultAnswer	string	Výchozí odpověď odpovědi, pokud se v znalostní báze nenajde žádná správná shoda.