Question Answering Projects - List Projects

Servizio:

Azure AI Services

Versione API:

2021-10-01

Ottiene tutti i progetti per un utente.

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

Con parametri facoltativi:

GET {Endpoint}/language/query-knowledgebases/projects?api-version=2021-10-01&top={top}&skip={skip}&maxpagesize={maxpagesize}

Parametri dell'URI

Nome	In	Necessario	Tipo	Descrizione
Endpoint	path	True	string	Endpoint di Servizi cognitivi supportato (ad esempio, https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Versione dell'API client.
maxpagesize	query		integer (int32)	Numero massimo di risorse da includere in una singola risposta.
skip	query		integer (int32)	Offset nella raccolta della prima risorsa da restituire.
top	query		integer (int32)	Numero massimo di risorse da restituire dalla raccolta.

Intestazione della richiesta

Nome	Necessario	Tipo	Descrizione
Ocp-Apim-Subscription-Key	True	string

Risposte

Nome	Tipo	Descrizione
200 OK	ProjectsMetadata	Metadati di tutti i progetti.
Other Status Codes	ErrorResponse	Risposta di errore.

Sicurezza

Ocp-Apim-Subscription-Key

Tipo: apiKey
In: header

Esempio

Successful query

Esempio di richiesta

HTTP

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

Risposta di esempio

Codice di stato:

200

{
  "value": [
    {
      "projectName": "proj1",
      "description": "proj1 is a test project.",
      "language": "en",
      "multilingualResource": true,
      "createdDateTime": "2021-05-01T15:13:22Z",
      "lastModifiedDateTime": "2021-05-01T15:13:22Z",
      "lastDeployedDateTime": "2021-05-01T15:13:22Z"
    },
    {
      "projectName": "proj2",
      "description": "proj2 is a test project.",
      "language": "fr",
      "multilingualResource": true,
      "createdDateTime": "2021-05-01T15:13:22Z",
      "lastModifiedDateTime": "2021-05-01T15:13:22Z",
      "lastDeployedDateTime": "2021-05-01T15:13:22Z"
    }
  ]
}

Definizioni

Nome	Descrizione
Error	Oggetto error.
ErrorCode	Codice di errore leggibile.
ErrorResponse	Risposta di errore.
InnerErrorCode	Codice di errore leggibile.
InnerErrorModel	Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectMetadata	Rappresenta il progetto.
ProjectSettings	Impostazioni configurabili del progetto.
ProjectsMetadata	Raccolta di metadati e impostazioni globali dei progetti.

Error

Object

Oggetto error.

Nome	Tipo	Descrizione
code	ErrorCode	Uno di un set definito dal server di codici di errore.
details	Error[]	Matrice di dettagli sugli errori specifici che hanno causato l'errore segnalato.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Rappresentazione leggibile dell'errore.
target	string	Destinazione dell'errore.

ErrorCode

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

Risposta di errore.

Nome	Tipo	Descrizione
error	Error	Oggetto error.

InnerErrorCode

Enumerazione

Codice di errore leggibile.

Valore	Descrizione
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

Oggetto contenente informazioni più specifiche sull'errore. In base alle linee guida dell'API Microsoft One , https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nome	Tipo	Descrizione
code	InnerErrorCode	Uno di un set definito dal server di codici di errore.
details	object	Dettagli errore.
innererror	InnerErrorModel	Oggetto contenente informazioni più specifiche dell'oggetto corrente sull'errore.
message	string	Messaggio di errore.
target	string	Destinazione errore.

ProjectMetadata

Object

Rappresenta il progetto.

Nome	Tipo	Descrizione
createdDateTime	string (date-time)	Data/ora di creazione del progetto.
description	string	Descrizione del progetto.
language	string	Lingua dei record di testo. Si tratta della rappresentazione BCP-47 di una lingua. Ad esempio, usare "en" per l'inglese; "es" per spagnolo ecc. Se non è impostato, usare "en" per l'inglese come impostazione predefinita.
lastDeployedDateTime	string (date-time)	Rappresenta l'ultima data di distribuzione del progetto.
lastModifiedDateTime	string (date-time)	Rappresenta l'ultima data/ora dell'ultima modifica del progetto.
multilingualResource	boolean	Risorsa abilitata per più lingue tra progetti o meno.
projectName	string	Nome del progetto.
settings	ProjectSettings	Impostazioni configurabili del progetto.

ProjectSettings

Object

Impostazioni configurabili del progetto.

Nome	Tipo	Descrizione
defaultAnswer	string	Risposta predefinita quando non viene trovata alcuna corrispondenza valida nella Knowledge Base.

ProjectsMetadata

Object

Raccolta di metadati e impostazioni globali dei progetti.

Nome	Tipo	Descrizione
nextLink	string
value	ProjectMetadata[]	Rappresenta il progetto.