CreateFaq - 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.

CreateFaq

Crea un nuevo conjunto de preguntas y respuestas de preguntas frecuentes (FAQ).

La adición de preguntas frecuentes a un índice es asincrónica.

Para ver un ejemplo de cómo agregar preguntas frecuentes a un índice mediante SDK de Python y Java, consulteUso del archivo de preguntas frecuentes.

Sintaxis de la solicitud

{ "ClientToken": "string", "Description": "string", "FileFormat": "string", "IndexId": "string", "LanguageCode": "string", "Name": "string", "RoleArn": "string", "S3Path": { "Bucket": "string", "Key": "string" }, "Tags": [ { "Key": "string", "Value": "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.

ClientToken

Un token que proporciona para identificar la solicitud de creación de preguntas frecuentes. Múltiples llamadas alCreateFaqRequestLa API con el mismo token de cliente creará solo una pregunta frecuente.

Type: Cadena

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

Obligatorio: No

Description

Una descripción para las preguntas frecuentes.

Type: Cadena

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

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

Obligatorio: No

FileFormat

El formato del archivo de entrada de preguntas frecuentes. Puede elegir entre un formato CSV básico, un formato CSV que incluya atributos personalizados en un encabezado y un formato JSON que incluya atributos personalizados.

El formato debe coincidir con el formato del archivo almacenado en el bucket de S3 identificado enS3Pathparámetro.

Para obtener más información, consulteAdición de preguntas y respuestas.

Type: Cadena

Valores válidos: CSV | CSV_WITH_HEADER | JSON

Obligatorio: No

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: Sí

LanguageCode

El código de un idioma. Esto le permite admitir un idioma 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, consulteAdición de 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-]*

Obligatorio: No

Name

Un nombre para las preguntas frecuentes.

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: Sí

RoleArn

El nombre de recurso de Amazon (ARN) de un rol con permiso para acceder al bucket de S3 que contiene las preguntas frecuentes. Para obtener más información, consulteIAM Roles for Amazon Kendra.

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}

Obligatorio: Sí

S3Path

La ruta al archivo de preguntas frecuentes en S3.

Tipo: objeto S3Path

Obligatorio: Sí

Tags

Lista de pares clave-valor que identifican las preguntas frecuentes. Puede utilizar las etiquetas para identificar y organizar los recursos de, así como para controlar el acceso a los recursos.

Type: Matrices deTagobjects

Miembros de matrices: El número mínimo es 0 elementos. Número máximo de 200 elementos.

Obligatorio: No

Sintaxis de la respuesta

{ "Id": "string" }

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.

Id

El identificador único 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_-]*

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

ConflictException

Código de estado HTTP: 400

InternalServerException

Código de estado HTTP: 500

ResourceNotFoundException

Código de estado HTTP: 400

ServiceQuotaExceededException

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: