update_knowledge_base¶
Operation¶
async
¶
update_knowledge_base(input: UpdateKnowledgeBaseInput, plugins: list[Plugin] | None = None) -> UpdateKnowledgeBaseOutput
Updates the configuration of a knowledge base with the fields that you specify. Because all fields will be overwritten, you must include the same values for fields that you want to keep the same.
You can change the following fields:
-
name -
description -
roleArn
You can't change the knowledgeBaseConfiguration or
storageConfiguration fields, so you must specify the same
configurations as when you created the knowledge base. You can send a
GetKnowledgeBase
request and copy the same configurations.
Parameters:
| Name | Type | Description | Default |
|---|---|---|---|
input
|
UpdateKnowledgeBaseInput
|
An instance of |
required |
plugins
|
list[Plugin] | None
|
A list of callables that modify the configuration dynamically. Changes made by these plugins only apply for the duration of the operation execution and will not affect any other operation invocations. |
None
|
Returns:
| Type | Description |
|---|---|
UpdateKnowledgeBaseOutput
|
An instance of |
Input¶
dataclass
¶
Dataclass for UpdateKnowledgeBaseInput structure.
Attributes¶
class-attribute
instance-attribute
¶
description: str | None = None
Specifies a new description for the knowledge base.
class-attribute
instance-attribute
¶
knowledge_base_configuration: KnowledgeBaseConfiguration | None = None
Specifies the configuration for the embeddings model used for the knowledge base. You must use the same configuration as when the knowledge base was created.
class-attribute
instance-attribute
¶
knowledge_base_id: str | None = None
The unique identifier of the knowledge base to update.
class-attribute
instance-attribute
¶
name: str | None = None
Specifies a new name for the knowledge base.
class-attribute
instance-attribute
¶
role_arn: str | None = None
Specifies a different Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the knowledge base.
class-attribute
instance-attribute
¶
storage_configuration: StorageConfiguration | None = None
Specifies the configuration for the vector store used for the knowledge base. You must use the same configuration as when the knowledge base was created.
Output¶
dataclass
¶
Dataclass for UpdateKnowledgeBaseOutput structure.
Attributes¶
instance-attribute
¶
knowledge_base: KnowledgeBase
Contains details about the knowledge base.