Header menu logo FsCDK

BedrockKnowledgeBaseBuilder Type

Constructors

Constructor Description

BedrockKnowledgeBaseBuilder(name)

Full Usage: BedrockKnowledgeBaseBuilder(name)

Parameters:
    name : string

Returns: BedrockKnowledgeBaseBuilder
name : string
Returns: BedrockKnowledgeBaseBuilder

Instance members

Instance member Description

this.Combine

Full Usage: this.Combine

Parameters:
Returns: BedrockKnowledgeBaseConfig
state1 : BedrockKnowledgeBaseConfig
state2 : BedrockKnowledgeBaseConfig
Returns: BedrockKnowledgeBaseConfig

constructId id

Full Usage: constructId id

Parameters:
    id : string - The construct ID.

Returns: BedrockKnowledgeBaseConfig

Sets the construct ID for the knowledge base.

id : string

The construct ID.

Returns: BedrockKnowledgeBaseConfig

this.Delay

Full Usage: this.Delay

Parameters:
Returns: BedrockKnowledgeBaseConfig
Modifiers: inline
f : unit -> BedrockKnowledgeBaseConfig
Returns: BedrockKnowledgeBaseConfig

description description

Full Usage: description description

Parameters:
    description : string - The description.

Returns: BedrockKnowledgeBaseConfig

Sets the description for the knowledge base.

description : string

The description.

Returns: BedrockKnowledgeBaseConfig

this.For

Full Usage: this.For

Parameters:
Returns: BedrockKnowledgeBaseConfig
Modifiers: inline
config : BedrockKnowledgeBaseConfig
f : unit -> BedrockKnowledgeBaseConfig
Returns: BedrockKnowledgeBaseConfig

knowledgeBaseConfiguration kbConfig

Full Usage: knowledgeBaseConfiguration kbConfig

Parameters:
Returns: BedrockKnowledgeBaseConfig

Sets the knowledge base configuration (embedding model, type, etc.).

kbConfig : IKnowledgeBaseConfigurationProperty

The CfnKnowledgeBase.IKnowledgeBaseConfigurationProperty.

Returns: BedrockKnowledgeBaseConfig

roleArn roleArn

Full Usage: roleArn roleArn

Parameters:
    roleArn : string - The IAM role ARN.

Returns: BedrockKnowledgeBaseConfig

Sets the IAM role ARN for the knowledge base.

roleArn : string

The IAM role ARN.

Returns: BedrockKnowledgeBaseConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: BedrockKnowledgeBaseSpec
config : BedrockKnowledgeBaseConfig
Returns: BedrockKnowledgeBaseSpec

storageConfiguration storageConfig

Full Usage: storageConfiguration storageConfig

Parameters:
Returns: BedrockKnowledgeBaseConfig

Sets the storage configuration (vector store backend).

storageConfig : IStorageConfigurationProperty

The CfnKnowledgeBase.IStorageConfigurationProperty.

Returns: BedrockKnowledgeBaseConfig

tags tags

Full Usage: tags tags

Parameters:
    tags : (string * string) list - List of key-value tag pairs.

Returns: BedrockKnowledgeBaseConfig

Adds tags to the knowledge base.

tags : (string * string) list

List of key-value tag pairs.

Returns: BedrockKnowledgeBaseConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: BedrockKnowledgeBaseConfig
() : unit
Returns: BedrockKnowledgeBaseConfig

this.Zero

Full Usage: this.Zero

Returns: BedrockKnowledgeBaseConfig
Returns: BedrockKnowledgeBaseConfig

Type something to start searching.