Condividi tramite


Question Answering Projects - List Projects

Ottiene tutti i progetti per un utente.

GET {Endpoint}/language/authoring/query-knowledgebases/projects?api-version=2023-04-01
GET {Endpoint}/language/authoring/query-knowledgebases/projects?api-version=2023-04-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 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.

Risposte

Nome Tipo Descrizione
200 OK

ProjectsMetadata

Metadati di tutti i progetti.

Other Status Codes

ErrorResponse

Risposta di errore.

Sicurezza

AADToken

Si tratta dei flussi OAuth2 di Azure Active Directory . Se abbinato al controllo degli accessi in base al ruolo di Azure, può essere usato per controllare l'accesso alle API REST Mappe di Azure. I controlli di accesso in base al ruolo di Azure vengono usati per designare l'accesso a uno o più Mappe di Azure account di risorse o sottorisorse. A qualsiasi utente, gruppo o entità servizio può essere concesso l'accesso tramite un ruolo predefinito o un ruolo personalizzato composto da una o più autorizzazioni per Mappe di Azure API REST.

Per implementare scenari, è consigliabile visualizzare i concetti di autenticazione. In sintesi, questa definizione di sicurezza offre una soluzione per la modellazione di applicazioni tramite oggetti in grado di controllare l'accesso su API e ambiti specifici.

Note

  • Questa definizione di sicurezza richiede l'uso dell'intestazione x-ms-client-id per indicare a quale Mappe di Azure risorsa a cui l'applicazione richiede l'accesso. Questa operazione può essere acquisita dall'API di gestione mappe.

è Authorization URL specifico dell'istanza del cloud pubblico di Azure. I cloud sovrani hanno URL di autorizzazione univoci e configurazioni di Azure Active Directory. * Il controllo degli accessi in base al ruolo di Azure viene configurato dal piano di gestione di Azure tramite portale di Azure, PowerShell, interfaccia della riga di comando, SDK di Azure o API REST. * L'utilizzo di Mappe di Azure Web SDK consente la configurazione basata sulla configurazione di un'applicazione per più casi d'uso.

  • Attualmente Azure Active Directory v1.0 o v2.0 supporta account aziendali, dell'istituto di istruzione e guest, ma non supporta account personali.

Tipo: oauth2
Flow: implicit
URL di autorizzazione: https://login.microsoftonline.com/common/oauth2/authorize

Ambiti

Nome Descrizione
https://cognitiveservices.azure.com/.default https://cognitiveservices.azure.com/.default

Ocp-Apim-Subscription-Key

Una chiave di sottoscrizione per una risorsa del servizio linguistico.

Tipo: apiKey
In: header

Esempio

Successful query

Esempio di richiesta

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

Risposta di esempio

{
  "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

Oggetto error.

Nome Tipo Descrizione
code

ErrorCode

Uno dei set definiti dal server di codici di errore.

details

Error[]

Matrice di dettagli sugli errori specifici che hanno causato questo 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

Codice di errore leggibile.

Nome Tipo Descrizione
AzureCognitiveSearchIndexLimitReached

string

AzureCognitiveSearchIndexNotFound

string

AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

Conflict

string

Forbidden

string

InternalServerError

string

InvalidArgument

string

InvalidRequest

string

NotFound

string

OperationNotFound

string

ProjectNotFound

string

QuotaExceeded

string

ServiceUnavailable

string

Timeout

string

TooManyRequests

string

Unauthorized

string

Warning

string

ErrorResponse

Risposta di errore.

Nome Tipo Descrizione
error

Error

Oggetto error.

InnerErrorCode

Codice di errore leggibile.

Nome Tipo Descrizione
AzureCognitiveSearchNotFound

string

AzureCognitiveSearchThrottling

string

EmptyRequest

string

ExtractionFailure

string

InvalidCountryHint

string

InvalidDocument

string

InvalidDocumentBatch

string

InvalidParameterValue

string

InvalidRequest

string

InvalidRequestBodyFormat

string

KnowledgeBaseNotFound

string

MissingInputDocuments

string

ModelVersionIncorrect

string

UnsupportedLanguageCode

string

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.

Nome Tipo Descrizione
code

InnerErrorCode

Uno dei set definiti 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 degli errori.

ProjectMetadata

Rappresenta il progetto.

Nome Tipo Descrizione
createdDateTime

string

Data e ora di creazione del progetto.

description

string

Descrizione del progetto.

language

string

Lingua dei record di testo. Questa è la 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

Rappresenta l'ultima data di distribuzione del progetto.

lastModifiedDateTime

string

Rappresenta la data e l'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

Impostazioni configurabili del progetto.

Nome Tipo Descrizione
defaultAnswer

string

Risposta predefinita quando non viene trovata alcuna corrispondenza valida nel knowledge base.

ProjectsMetadata

Raccolta di metadati e impostazioni globali dei progetti.

Nome Tipo Descrizione
nextLink

string

value

ProjectMetadata[]

Rappresenta il progetto.