Skip to content

KnowledgeBase

Structure Class

KnowledgeBase dataclass

Bases: _SerdeShape

Contains information about a knowledge base.

Attributes

created_at instance-attribute
created_at: datetime

The time the knowledge base was created.

description class-attribute instance-attribute
description: str | None = ...

The description of the knowledge base.

failure_reasons class-attribute instance-attribute
failure_reasons: list[str] | None = ...

A list of reasons that the API operation on the knowledge base failed.

knowledge_base_arn instance-attribute
knowledge_base_arn: str

The Amazon Resource Name (ARN) of the knowledge base.

knowledge_base_configuration instance-attribute
knowledge_base_configuration: KnowledgeBaseConfiguration

Contains details about the embeddings configuration of the knowledge base.

knowledge_base_id instance-attribute
knowledge_base_id: str

The unique identifier of the knowledge base.

metadata_configurations class-attribute instance-attribute
metadata_configurations: list[MetadataConfiguration] | None = ...

The custom metadata field configurations of the knowledge base. Each configuration specifies whether its field is searchable (ENABLED or DISABLED).

If the update fails, the knowledge base status becomes UPDATE_UNSUCCESSFUL, the field configurations revert to their previous values, and failureReasons describes the cause. You can retry the update from UPDATE_UNSUCCESSFUL.

name instance-attribute
name: str

The name of the knowledge base.

role_arn instance-attribute
role_arn: str

The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.

status instance-attribute
status: str

The status of the knowledge base. The following statuses are possible:

  • CREATING -- The knowledge base is being created.

  • ACTIVE -- The knowledge base is ready to be queried.

  • DELETING -- The knowledge base is being deleted.

  • UPDATING -- The knowledge base is being updated.

  • FAILED -- The knowledge base API operation failed.

storage_configuration class-attribute instance-attribute
storage_configuration: StorageConfiguration | None = ...

Contains details about the storage configuration of the knowledge base.

updated_at instance-attribute
updated_at: datetime

The time the knowledge base was last updated.