Skip to content

KnowledgeBase

Source code in docs_src/capo_bedrock_agent/types/knowledge_base.py 
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
class KnowledgeBase(TypedDict, closed=True):
    knowledge_base_id: "capo_bedrock_agent.types.id.Id"
    """<p>The unique identifier of the knowledge base.</p>"""
    name: "capo_bedrock_agent.types.name.Name"
    """<p>The name of the knowledge base.</p>"""
    knowledge_base_arn: "capo_bedrock_agent.types.knowledge_base_arn.KnowledgeBaseArn"
    """<p>The Amazon Resource Name (ARN) of the knowledge base.</p>"""
    description: NotRequired["capo_bedrock_agent.types.description.Description"]
    """<p>The description of the knowledge base.</p>"""
    role_arn: "capo_bedrock_agent.types.knowledge_base_role_arn.KnowledgeBaseRoleArn"
    """<p>The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.</p>"""
    knowledge_base_configuration: "capo_bedrock_agent.types.knowledge_base_configuration.KnowledgeBaseConfiguration"
    """<p>Contains details about the embeddings configuration of the knowledge base.</p>"""
    storage_configuration: NotRequired[
        "capo_bedrock_agent.types.storage_configuration.StorageConfiguration"
    ]
    """<p>Contains details about the storage configuration of the knowledge base.</p>"""
    status: "capo_bedrock_agent.types.knowledge_base_status.KnowledgeBaseStatus"
    """<p>The status of the knowledge base. The following statuses are possible:</p> <ul> <li> <p>CREATING – The knowledge base is being created.</p> </li> <li> <p>ACTIVE – The knowledge base is ready to be queried.</p> </li> <li> <p>DELETING – The knowledge base is being deleted.</p> </li> <li> <p>UPDATING – The knowledge base is being updated.</p> </li> <li> <p>FAILED – The knowledge base API operation failed.</p> </li> </ul>"""
    created_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>The time the knowledge base was created.</p>"""
    updated_at: "capo_bedrock_agent.types.date_timestamp.DateTimestamp"
    """<p>The time the knowledge base was last updated.</p>"""
    failure_reasons: NotRequired[
        "capo_bedrock_agent.types.failure_reasons.FailureReasons"
    ]
    """<p>A list of reasons that the API operation on the knowledge base failed.</p>"""

created_at instance-attribute 

created_at: DateTimestamp

The time the knowledge base was created.

description instance-attribute 

description: NotRequired[Description]

The description of the knowledge base.

failure_reasons instance-attribute 

failure_reasons: NotRequired[FailureReasons]

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

knowledge_base_arn instance-attribute 

knowledge_base_arn: KnowledgeBaseArn

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: Id

The unique identifier of the knowledge base.

name instance-attribute 

name: Name

The name of the knowledge base.

role_arn instance-attribute 

role_arn: KnowledgeBaseRoleArn

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

status instance-attribute 

status: KnowledgeBaseStatus

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 instance-attribute 

storage_configuration: NotRequired[StorageConfiguration]

Contains details about the storage configuration of the knowledge base.

updated_at instance-attribute 

updated_at: DateTimestamp

The time the knowledge base was last updated.