Question Answering Projects - Create Project

Servicio:: Azure AI Services

Versión de la API:: 2023-04-01

Crea o actualiza un proyecto.

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

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
Endpoint	path	True	string (uri)	Punto de conexión de Cognitive Services admitido (por ejemplo, https://< resource-name.api.cognitiveservices.azure.com>).
projectName	path	True	string maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Nombre del proyecto.
api-version	query	True	string minLength: 1	La versión de API que se va a utilizar para esta operación.

Cuerpo de la solicitud

Nombre	Tipo	Description
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.
multilingualResource	boolean	Recurso habilitado para varios lenguajes entre proyectos o no.
settings	ProjectSettings	Opciones configurables del proyecto.

Respuestas

Nombre	Tipo	Description
200 OK	QuestionAnsweringProjectMetadata	La solicitud se ha realizado correctamente.
201 Created	QuestionAnsweringProjectMetadata	La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.
Other Status Codes	ErrorResponse	Una respuesta de error inesperada. Encabezados x-ms-error-code: string

Nombre

Tipo

Description

200 OK

QuestionAnsweringProjectMetadata

La solicitud se ha realizado correctamente.

201 Created

QuestionAnsweringProjectMetadata

La solicitud se ha realizado correctamente y se ha creado un nuevo recurso como resultado.

Other Status Codes

ErrorResponse

Una respuesta de error inesperada.

Encabezados

x-ms-error-code: string

Seguridad

Ocp-Apim-Subscription-Key

Tipo: apiKey
En: header

OAuth2Auth

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

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

Ejemplos

Successful query

Solicitud de ejemplo

HTTP

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

{
  "description": "proj1 is a test project.",
  "multilingualResource": true,
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

Respuesta de muestra

status code:: 200

{
  "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",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

status code:: 201

{
  "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",
  "settings": {
    "defaultAnswer": "No good match found for your question in the Knowledgebase."
  },
  "language": "en"
}

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.
ProjectSettings	Opciones configurables del proyecto.
QuestionAnsweringProjectMetadata	Representa el proyecto.
QuestionAnsweringProjectMetadataCreateOrUpdate	Representa el proyecto.

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
InvalidRequest	Error de solicitud no válido
InvalidArgument	Error de argumento no válido
Unauthorized	Error de acceso no autorizado
Forbidden	Error de acceso prohibido
NotFound	Error no encontrado
ProjectNotFound	Error de proyecto no encontrado
OperationNotFound	Error de operación no encontrado
AzureCognitiveSearchNotFound	Error no encontrado de Azure Cognitive Search
AzureCognitiveSearchIndexNotFound	Error no encontrado en el índice de Azure Cognitive Search
TooManyRequests	Error de demasiadas solicitudes
AzureCognitiveSearchThrottling	Error de limitación de Azure Cognitive Search
AzureCognitiveSearchIndexLimitReached	Error alcanzado el límite de índices de Azure Cognitive Search
InternalServerError	Error interno del servidor
ServiceUnavailable	Error de servicio no disponible
Timeout	Error de tiempo de espera
QuotaExceeded	Error de cuota superada
Conflict	Error de conflicto
Warning	Error de advertencia

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
InvalidRequest	Error de solicitud no válido
InvalidParameterValue	Error de valor de parámetro no válido
KnowledgeBaseNotFound	Error de base de conocimiento no encontrado
AzureCognitiveSearchNotFound	Error no encontrado de Azure Cognitive Search
AzureCognitiveSearchThrottling	Error de limitación de Azure Cognitive Search
ExtractionFailure	Error de extracción
InvalidRequestBodyFormat	Error de formato de cuerpo de solicitud no válido
EmptyRequest	Error de solicitud vacía
MissingInputDocuments	Error de documentos de entrada que faltan
InvalidDocument	Error de documento no válido
ModelVersionIncorrect	Error incorrecto de la versión del modelo
InvalidDocumentBatch	Error de lote de documento no válido
UnsupportedLanguageCode	Error de código de idioma no admitido
InvalidCountryHint	Error de sugerencia de país no válido

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.

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.

QuestionAnsweringProjectMetadata

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 maxLength: 100 pattern: ^(?=[a-zA-Z0-9])[a-zA-Z0-9-]{0,98}[a-zA-Z0-9]$	Nombre del proyecto.
settings	ProjectSettings	Opciones configurables del proyecto.

QuestionAnsweringProjectMetadataCreateOrUpdate

Object

Representa el proyecto.

Nombre	Tipo	Description
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.
multilingualResource	boolean	Recurso habilitado para varios lenguajes entre proyectos o no.
settings	ProjectSettings	Opciones configurables del proyecto.

Compartir a través de

Question Answering Projects - Create Project

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

Ocp-Apim-Subscription-Key

OAuth2Auth

Ámbitos

Ejemplos

Successful query

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Error

ErrorCode

ErrorResponse

InnerErrorCode

InnerErrorModel

ProjectSettings

QuestionAnsweringProjectMetadata

QuestionAnsweringProjectMetadataCreateOrUpdate