Question Answering Projects - List Projects

Servicio:

Azure AI Services

Versión de la API:

2021-10-01

Obtiene todos los proyectos de un usuario.

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

Con parámetros opcionales:

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string	Punto de conexión de Cognitive Services compatible (por ejemplo, https://.api.cognitiveservices.azure.com).
api-version	query	True	string	Versión de la API de cliente.
maxpagesize	query		integer (int32)	Número máximo de recursos que se van a incluir en una única respuesta.
skip	query		integer (int32)	Desplazamiento en la colección del primer recurso que se va a devolver.
top	query		integer (int32)	Número máximo de recursos que se van a devolver de la colección.

Encabezado de la solicitud

Nombre	Requerido	Tipo	Description
Ocp-Apim-Subscription-Key	True	string

Respuestas

Nombre	Tipo	Description
200 OK	ProjectsMetadata	Metadatos de todos los proyectos.
Other Status Codes	ErrorResponse	Respuesta de error.

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

Ejemplos

Successful query

Solicitud de ejemplo

HTTP

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

Respuesta de muestra

status code:

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"
    }
  ]
}

Definiciones

Nombre	Description
Error	Objeto de error.
ErrorCode	Código de error legible para personas.
ErrorResponse	Respuesta de error.
InnerErrorCode	Código de error legible para personas.
InnerErrorModel	Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
ProjectMetadata	Representa el proyecto.
ProjectSettings	Opciones configurables del proyecto.
ProjectsMetadata	Colección de metadatos de proyectos y configuración global.

Error

Object

Objeto de error.

Nombre	Tipo	Description
code	ErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	Error[]	Matriz de detalles sobre errores específicos que llevaron a este error notificado.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Representación legible del error.
target	string	Destino del error.

ErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
AzureCognitiveSearchIndexLimitReached
AzureCognitiveSearchIndexNotFound
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
Forbidden
InternalServerError
InvalidArgument
InvalidRequest
NotFound
OperationNotFound
ProjectNotFound
ServiceUnavailable
TooManyRequests
Unauthorized

ErrorResponse

Object

Respuesta de error.

Nombre	Tipo	Description
error	Error	Objeto de error.

InnerErrorCode

Enumeración

Código de error legible para personas.

Valor	Description
AzureCognitiveSearchNotFound
AzureCognitiveSearchThrottling
ExtractionFailure
InvalidParameterValue
InvalidRequest
KnowledgeBaseNotFound

InnerErrorModel

Object

Objeto que contiene información más específica sobre el error. Según las directrices de la API de Microsoft One: https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Nombre	Tipo	Description
code	InnerErrorCode	Uno de un conjunto definido por el servidor de códigos de error.
details	object	Detalles del error.
innererror	InnerErrorModel	Objeto que contiene información más específica que el objeto actual sobre el error.
message	string	Mensaje de error.
target	string	Destino de error.

ProjectMetadata

Object

Representa el proyecto.

Nombre	Tipo	Description
createdDateTime	string (date-time)	Fecha y hora de creación del proyecto.
description	string	Descripción del proyecto.
language	string	Idioma de los registros de texto. Esta es la representación BCP-47 de un idioma. Por ejemplo, use "en" para inglés; "es" para español, etc. Si no se establece, use "en" para inglés como valor predeterminado.
lastDeployedDateTime	string (date-time)	Representa la última fecha y hora de implementación del proyecto.
lastModifiedDateTime	string (date-time)	Representa la fecha y hora de última modificación del proyecto.
multilingualResource	boolean	Recurso habilitado para varios lenguajes entre proyectos o no.
projectName	string	Nombre del proyecto.
settings	ProjectSettings	Opciones configurables del proyecto.

ProjectSettings

Object

Opciones configurables del proyecto.

Nombre	Tipo	Description
defaultAnswer	string	Respuesta de respuesta predeterminada cuando no se encuentra ninguna coincidencia correcta en la base de conocimiento.

ProjectsMetadata

Object

Colección de metadatos de proyectos y configuración global.

Nombre	Tipo	Description
nextLink	string
value	ProjectMetadata[]	Representa el proyecto.