generative-ai-cdk-constructs

@cdklabs/generative-ai-cdk-constructsDocs


@cdklabs/generative-ai-cdk-constructs / LlamaIndexDataLoader

Class: LlamaIndexDataLoader

Extends

Constructors

new LlamaIndexDataLoader()

new LlamaIndexDataLoader(scope, id, props): LlamaIndexDataLoader

Parameters

scope: Construct

id: string

props: LlamaIndexDataLoaderProps

Returns

LlamaIndexDataLoader

Overrides

BaseClass.constructor

Properties

constructUsageMetric

readonly constructUsageMetric: "uksb-1tupboc45" = 'uksb-1tupboc45'

construct usage metric , added in template description

Inherited from

BaseClass.constructUsageMetric


enablexray

enablexray: boolean = true

enable disable xray tracing

Default

- True

Inherited from

BaseClass.enablexray


fieldLogLevel

fieldLogLevel: FieldLogLevel = appsync.FieldLogLevel.ALL

Default log config for all constructs

Inherited from

BaseClass.fieldLogLevel


lambdaTracing

lambdaTracing: Tracing = lambda.Tracing.ACTIVE

enable disable lambda tracing

Default

- Active

Inherited from

BaseClass.lambdaTracing


node

readonly node: Node

The tree node.

Inherited from

BaseClass.node


outputBucket

readonly outputBucket: Bucket


queueProcessingFargateService

readonly queueProcessingFargateService: QueueProcessingFargateService


retention

retention: RetentionDays = logs.RetentionDays.TEN_YEARS

Default log retention config for all constructs

Inherited from

BaseClass.retention


stage

stage: string

Value will be appended to resources name.

Default

- _dev

Inherited from

BaseClass.stage


usageMetricMap

protected static usageMetricMap: Record<string, number>

Record<string, number> , maps construct name with number of deployments

Inherited from

BaseClass.usageMetricMap

Methods

addObservabilityToConstruct()

protected addObservabilityToConstruct(props): void

Parameters

props: BaseClassProps

Returns

void

Inherited from

BaseClass.addObservabilityToConstruct


toString()

toString(): string

Returns a string representation of this construct.

Returns

string

Inherited from

BaseClass.toString


updateConstructUsageMetricCode()

protected updateConstructUsageMetricCode(props, scope, lambdaFunctions): void

Parameters

props: BaseClassProps

scope: Construct

lambdaFunctions: DockerImageFunction[]

Returns

void

Inherited from

BaseClass.updateConstructUsageMetricCode


updateEnvSuffix()

protected updateEnvSuffix(props): void

Parameters

props: BaseClassProps

Returns

void

Inherited from

BaseClass.updateEnvSuffix


isConstruct()

static isConstruct(x): x is Construct

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters

x: any

Any object

Returns

x is Construct

true if x is an object created from a class which extends Construct.

Inherited from

BaseClass.isConstruct