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

DescribeThesaurus

Obtiene información sobre un diccionario de sinónimos de Amazon Kendra existente.

Sintaxis de la solicitud

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

Parámetros de solicitud

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

La solicitud acepta los siguientes datos en formato JSON.

Id

Identificador del diccionario de sinónimos del que desea obtener información.

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í

IndexId

Identificador del índice del diccionario de sinónimos.

Type: Cadena

Restricciones de longitud Longitud fija de 36.

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

Obligatorio: Sí

Sintaxis de la respuesta

{ "CreatedAt": number, "Description": "string", "ErrorMessage": "string", "FileSizeBytes": number, "Id": "string", "IndexId": "string", "Name": "string", "RoleArn": "string", "SourceS3Path": { "Bucket": "string", "Key": "string" }, "Status": "string", "SynonymRuleCount": number, "TermCount": number, "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 de Unix en la que se creó el tesauro.

Type: Marca temporal

Description

La descripción del diccionario de sinónimos.

Type: Cadena

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

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

ErrorMessage

CuandoStatusEl campo esFAILED, elErrorMessageproporciona más información.

Type: Cadena

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

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

FileSizeBytes

El tamaño del archivo de sinónimos en bytes.

Type: Largo

Id

Identificador del diccionario de sinónimos.

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

Identificador del índice del diccionario de sinónimos.

Type: Cadena

Restricciones de longitud Longitud fija de 36.

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

Name

El nombre del diccionario de sinónimos.

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

Rol de IAM que otorga a Amazon Kendra permisos para acceder al tesauro especificado enSourceS3Path.

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}

SourceS3Path

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

Tipo: objeto S3Path

Status

El estado actual del tesauro. Cuando el valor esACTIVE, las consultas pueden usar el diccionario de sinónimos. Si el archivo deStatusEl campo esFAILED, elErrorMessageproporciona más información.

Si el estado esACTIVE_BUT_UPDATE_FAILED, significa que Amazon Kendra no pudo ingerir el nuevo archivo de sinónimos. El archivo de sinónimos antiguo sigue activo.

Type: Cadena

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

SynonymRuleCount

El número de reglas de sinónimos del archivo de sinónimos.

Type: Largo

TermCount

El número de términos únicos del archivo de sinónimos. Por ejemplo, los sinónimosa,b,cya=>d, el recuento de términos sería 4.

Type: Largo

UpdatedAt

La fecha y hora de Unix en la que se actualizó el tesauro por última vez.

Type: Marca temporal

Errores

Para obtener información sobre 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: