Question Answering Projects - List Projects

Tjänst:

Azure AI Services

API-version:

2023-04-01

Hämtar alla projekt för en användare.

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

Med valfria parametrar:

GET {Endpoint}/language/authoring/query-knowledgebases/projects?api-version=2023-04-01&top={top}&skip={skip}&maxpagesize={maxpagesize}

URI-parametrar

Name	I	Obligatorisk	Typ	Description
Endpoint	path	True	string (uri)	Cognitive Services-slutpunkt som stöds (t.ex. https://< resource-name.api.cognitiveservices.azure.com>).
api-version	query	True	string minLength: 1	Den API-version som ska användas för den här åtgärden.
maxpagesize	query		integer (int32)	Det maximala antalet resurser som ska ingå i ett enda svar.
skip	query		integer (int32)	En förskjutning i samlingen av den första resursen som ska returneras.
top	query		integer (int32)	Det maximala antalet resurser som ska returneras från samlingen.

Svar

Name	Typ	Description
200 OK	PagedQuestionAnsweringProjectMetadata	Begäran har slutförts.
Other Status Codes	ErrorResponse	Ett oväntat felsvar. Sidhuvuden x-ms-error-code: string

Säkerhet

Ocp-Apim-Subscription-Key

Typ: apiKey
I: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Auktoriseringswebbadress: https://login.microsoftonline.com/common/oauth2/authorize

Omfattningar

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

Exempel

Successful query

Exempelbegäran

HTTP

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

Exempelsvar

Statuskod:

200

{
  "value": [
    {
      "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",
      "language": "en"
    },
    {
      "description": "proj2 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": "proj2",
      "language": "fr"
    }
  ]
}

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 Riktlinjerna för Microsoft One API – https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
PagedQuestionAnsweringProjectMetadata	Sidad samling av QuestionAnsweringProjectMetadata-objekt
ProjectSettings	Konfigurerbara inställningar för projektet.
QuestionAnsweringProjectMetadata	Representerar projektet.

Error

Objekt

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

Uppräkning

Felkod som kan läsas av människor.

Värde	Description
InvalidRequest	Ogiltigt begärandefel
InvalidArgument	Ogiltigt argumentfel
Unauthorized	Fel vid obehörig åtkomst
Forbidden	Fel om förbjuden åtkomst
NotFound	Det gick inte att hitta felet
ProjectNotFound	Det gick inte att hitta projektet
OperationNotFound	Det gick inte att hitta åtgärden
AzureCognitiveSearchNotFound	Azure Cognitive Search hittades inte
AzureCognitiveSearchIndexNotFound	Azure Cognitive Search-indexet hittades inte
TooManyRequests	Fel vid för många begäranden
AzureCognitiveSearchThrottling	Azure Cognitive Search-begränsningsfel
AzureCognitiveSearchIndexLimitReached	Azure Cognitive Search-indexgränsen nådde fel
InternalServerError	Internt serverfel.
ServiceUnavailable	Fel som inte är tillgänglig för tjänsten
Timeout	Timeout-fel
QuotaExceeded	Fel om överskriden kvot
Conflict	Konfliktfelmeddelande
Warning	Varningsfel

ErrorResponse

Objekt

Felsvar.

Name	Typ	Description
error	Error	Felobjektet.

InnerErrorCode

Uppräkning

Felkod som kan läsas av människor.

Värde	Description
InvalidRequest	Ogiltigt begärandefel
InvalidParameterValue	Ogiltigt parametervärdefel
KnowledgeBaseNotFound	Det gick inte att hitta kunskapsbasen
AzureCognitiveSearchNotFound	Azure Cognitive Search hittades inte
AzureCognitiveSearchThrottling	Azure Cognitive Search-begränsningsfel
ExtractionFailure	Fel vid extrahering
InvalidRequestBodyFormat	Ogiltigt fel i brödtextformat för begäran
EmptyRequest	Fel vid tom begäran
MissingInputDocuments	Fel i indatadokument saknas
InvalidDocument	Ogiltigt dokumentfel
ModelVersionIncorrect	Fel i modellversion
InvalidDocumentBatch	Ogiltigt dokumentbatchfel
UnsupportedLanguageCode	Fel med språkkod som inte stöds
InvalidCountryHint	Ogiltigt landtipsfel

InnerErrorModel

Objekt

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

PagedQuestionAnsweringProjectMetadata

Objekt

Sidad samling av QuestionAnsweringProjectMetadata-objekt

Name	Typ	Description
nextLink	string (uri)	Länken till nästa sida med objekt
value	QuestionAnsweringProjectMetadata[]	QuestionAnsweringProjectMetadata-objekten på den här sidan

ProjectSettings

Objekt

Konfigurerbara inställningar för projektet.

Name	Typ	Description
defaultAnswer	string	Svarssvar som standard när ingen bra matchning hittas i kunskapsbasen.

QuestionAnsweringProjectMetadata

Objekt

Representerar projektet.

Name	Typ	Description
createdDateTime	string (date-time)	Datum-tid för projektskapande.
description	string	Beskrivning av projektet.
language	string	Språk för textposterna. Det här är BCP-47-representation av ett språk. Använd till exempel "en" för engelska; "es" för spanska etc. Om du inte anger använder du "en" för engelska som standard.
lastDeployedDateTime	string (date-time)	Representerar projektets senaste distributionsdatum.
lastModifiedDateTime	string (date-time)	Representerar projektets senast ändrade datum-tid.
multilingualResource	boolean	Resurs aktiverad för flera språk mellan projekt eller inte.
projectName	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Namnet på projektet.
settings	ProjectSettings	Konfigurerbara inställningar för projektet.