DescribeFaq - Amazon Kendra

Las traducciones son generadas a través de traducción automática. En caso de conflicto entre la traducción y la version original de inglés, prevalecerá la version en inglés.

DescribeFaq

Obtiene información acerca de una lista de preguntas frecuentes.

Sintaxis de la solicitud

{ "Id": "string", "IndexId": "string" }

Parámetros de solicitud

Para obtener información acerca de los parámetros que son comunes a todas las acciones, consulteParámetros comunes.

La solicitud acepta los siguientes datos en formato JSON.

Id

El identificador de la pregunta frecuente.

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 100. caracteres.

Patrón: [a-zA-Z0-9][a-zA-Z0-9_-]*

obligatorio: obligatorio Sí

IndexId

El identificador del índice para las preguntas frecuentes.

Type: Cadena

Restricciones de longitud: Longitud fija de 36.

Patrón: [a-zA-Z0-9][a-zA-Z0-9-]*

obligatorio: obligatorio Sí

Sintaxis de la respuesta

{ "CreatedAt": number, "Description": "string", "ErrorMessage": "string", "FileFormat": "string", "Id": "string", "IndexId": "string", "LanguageCode": "string", "Name": "string", "RoleArn": "string", "S3Path": { "Bucket": "string", "Key": "string" }, "Status": "string", "UpdatedAt": number }

Elementos de respuesta

Si la acción se realiza correctamente, el servicio devuelve una respuesta HTTP 200.

El servicio devuelve los datos siguientes en formato JSON.

CreatedAt

La fecha y hora en que se creó la pregunta frecuente.

Type: Marca temporal

Description

La descripción de las preguntas frecuentes que proporcionó cuando se creó.

Type: Cadena

Restricciones de longitud: Longitud mínima de 0. La longitud máxima es de 1000 caracteres.

Patrón: ^\P{C}*$

ErrorMessage

Si el archivo deStatusfield esFAILED, elErrorMessagecontiene el motivo por el que fallaron las preguntas frecuentes.

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 2048 caracteres.

Patrón: ^\P{C}*$

FileFormat

Formato de archivo utilizado por los archivos de entrada para las preguntas frecuentes.

Type: Cadena

Valores válidos: CSV | CSV_WITH_HEADER | JSON

Id

El identificador de la pregunta frecuente.

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 100. caracteres.

Patrón: [a-zA-Z0-9][a-zA-Z0-9_-]*

IndexId

El identificador del índice para las preguntas frecuentes.

Type: Cadena

Restricciones de longitud: Longitud fija de 36.

Patrón: [a-zA-Z0-9][a-zA-Z0-9-]*

LanguageCode

El código de un idioma. Muestra un idioma compatible para el documento de preguntas frecuentes. El inglés se admite de forma predeterminada. Para obtener más información sobre los lenguajes admitidos por, incluidos sus códigos, consulteAñadir documentos en idiomas distintos del inglés.

Type: Cadena

Restricciones de longitud: Longitud mínima de 2. La longitud máxima es de 10 caracteres.

Patrón: [a-zA-Z-]*

Name

El nombre con el nombre del pregunta frecuente cuando se creó.

Type: Cadena

Restricciones de longitud: Longitud mínima de 1. La longitud máxima es de 100. caracteres.

Patrón: [a-zA-Z0-9][a-zA-Z0-9_-]*

RoleArn

El nombre de recurso de Amazon (ARN) del rol de que concede acceso al bucket de S3 que contiene los archivos de entrada para las preguntas frecuentes.

Type: Cadena

Restricciones de longitud: Longitud mínima de 0. La longitud máxima es de 1284 caracteres.

Patrón: arn:[a-z0-9-\.]{1,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[a-z0-9-\.]{0,63}:[^/].{0,1023}

S3Path

Información necesaria para encontrar un archivo específico en un bucket de Amazon S3.

Tipo: objeto S3Path

Status

El estado de la pregunta frecuente. Está listo para utilizar cuando el estado esACTIVE.

Type: Cadena

Valores válidos: CREATING | UPDATING | ACTIVE | DELETING | FAILED

UpdatedAt

La fecha y hora en que se actualizó por última vez la pregunta frecuente.

Type: Marca temporal

Errores

Para obtener información acerca de los errores que son comunes a todas las acciones, consulteErrores comunes.

AccessDeniedException

Código de estado HTTP: 400

InternalServerException

Código de estado HTTP: 500

ResourceNotFoundException

Código de estado HTTP: 400

ThrottlingException

Código de estado HTTP: 400

ValidationException

Código de estado HTTP: 400

Véase también

Para obtener más información sobre el uso de esta API en un SDK de AWS de un lenguaje específico, consulte: