Package software.amazon.awscdk.services.bedrock

Interface CfnAgent.AgentKnowledgeBaseProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAgent.AgentKnowledgeBaseProperty.Jsii$Proxy

Enclosing class:

CfnAgent

@Stability(Stable)
public static interface CfnAgent.AgentKnowledgeBaseProperty
extends software.amazon.jsii.JsiiSerializable

Contains details about a knowledge base that is associated with an agent.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 AgentKnowledgeBaseProperty agentKnowledgeBaseProperty = AgentKnowledgeBaseProperty.builder()
         .description("description")
         .knowledgeBaseId("knowledgeBaseId")
         // the properties below are optional
         .knowledgeBaseState("knowledgeBaseState")
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentknowledgebase.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAgent.AgentKnowledgeBaseProperty.Builder	A builder for CfnAgent.AgentKnowledgeBaseProperty
static final class	CfnAgent.AgentKnowledgeBaseProperty.Jsii$Proxy	An implementation for CfnAgent.AgentKnowledgeBaseProperty

Method Summary

Modifier and Type	Method	Description
static CfnAgent.AgentKnowledgeBaseProperty.Builder	builder()
String	getDescription()	The description of the association between the agent and the knowledge base.
String	getKnowledgeBaseId()	The unique identifier of the association between the agent and the knowledge base.
default String	getKnowledgeBaseState()	Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDescription

@Stability(Stable)
@NotNull
String getDescription()

The description of the association between the agent and the knowledge base.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentknowledgebase.html#cfn-bedrock-agent-agentknowledgebase-description

getKnowledgeBaseId

@Stability(Stable)
@NotNull
String getKnowledgeBaseId()

The unique identifier of the association between the agent and the knowledge base.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentknowledgebase.html#cfn-bedrock-agent-agentknowledgebase-knowledgebaseid

getKnowledgeBaseState

@Stability(Stable)
@Nullable
default String getKnowledgeBaseState()

Specifies whether to use the knowledge base or not when sending an InvokeAgent request.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrock-agent-agentknowledgebase.html#cfn-bedrock-agent-agentknowledgebase-knowledgebasestate

builder

@Stability(Stable)
static CfnAgent.AgentKnowledgeBaseProperty.Builder builder()

Returns:

a CfnAgent.AgentKnowledgeBaseProperty.Builder of CfnAgent.AgentKnowledgeBaseProperty