Associate Agent Knowledge Base

bedrockagent_associate_agent_knowledge_base

R Documentation

Associates a knowledge base with an agent¶

Description¶

Associates a knowledge base with an agent. If a knowledge base is associated and its indexState is set to Enabled, the agent queries the knowledge base for information to augment its response to the user.

Usage¶

bedrockagent_associate_agent_knowledge_base(agentId, agentVersion,
  description, knowledgeBaseId, knowledgeBaseState)

Arguments¶

agentId: [required] The unique identifier of the agent with which you want to associate the knowledge base.
agentVersion: [required] The version of the agent with which you want to associate the knowledge base.
description: [required] A description of what the agent should use the knowledge base for.
knowledgeBaseId: [required] The unique identifier of the knowledge base to associate with the agent.
knowledgeBaseState: Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

Value¶

A list with the following syntax:

list(
  agentKnowledgeBase = list(
    agentId = "string",
    agentVersion = "string",
    createdAt = as.POSIXct(
      "2015-01-01"
    ),
    description = "string",
    knowledgeBaseId = "string",
    knowledgeBaseState = "ENABLED"|"DISABLED",
    updatedAt = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax¶

svc$associate_agent_knowledge_base(
  agentId = "string",
  agentVersion = "string",
  description = "string",
  knowledgeBaseId = "string",
  knowledgeBaseState = "ENABLED"|"DISABLED"
)