IndexProps

Properties for defining a Index.

See https://www.alibabacloud.com/help/ros/developer-reference/aliyun-bailian-index

Initializer

import { IndexProps } from '@alicloud/ros-cdk-bailian'
const indexProps: IndexProps = { ... }

Properties

name^Required

public readonly name: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property name: Knowledge base name.

1-20 characters. Supports Chinese, English, numbers, underscores (_), hyphens (-), periods (.) and colons (:).

sourceType^Required

public readonly sourceType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property sourceType: Data source type.

DATA_CENTER_CATEGORY: import files from specified categories. DATA_CENTER_FILE: import specified files.

structureType^Required

public readonly structureType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property structureType: Knowledge base type.

unstructured: document search or audio\/video knowledge base. structured: data query or image Q&A knowledge base.

workspaceId^Required

public readonly workspaceId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property workspaceId: Workspace ID.

The knowledge base will be created in this workspace.

categoryIds^Optional

public readonly categoryIds: IResolvable | string | IResolvable[];

• Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property categoryIds: Category IDs to import when creating the knowledge base.

Required when SourceType is DATA_CENTER_CATEGORY.

chunkMode^Optional

public readonly chunkMode: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property chunkMode: Chunk strategy.

If not specified, smart chunking is used. When set to regex, Separator must also be provided.

chunkSize^Optional

public readonly chunkSize: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property chunkSize: Chunk size, the maximum number of characters per text slice.

Range [1-6000]. Defaults to 500. If ChunkSize is less than 100, OverlapSize must also be set.

connectId^Optional

public readonly connectId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property connectId: Connection ID.

Replaces the deprecated datasourceCode parameter.

database^Optional

public readonly database: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property database: Database name for structured knowledge base.

denseSimilarityTopK^Optional

public readonly denseSimilarityTopK: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property denseSimilarityTopK: Vector retrieval Top K.

Retrieves the K most similar text slices by vector similarity. Range [0-100]. Defaults to 100. DenseSimilarityTopK + SparseSimilarityTopK must be <= 200. Only supported in UpdateIndex, not in CreateIndex.

description^Optional

public readonly description: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property description: Knowledge base description.

0-1000 characters.

documentIds^Optional

public readonly documentIds: IResolvable | string | IResolvable[];

• Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property documentIds: Document IDs to import when creating the knowledge base.

Required when SourceType is DATA_CENTER_FILE.

embeddingModelName^Optional

public readonly embeddingModelName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property embeddingModelName: Embedding model used by the knowledge base.

Defaults to text-embedding-v3.

enableHeaders^Optional

public readonly enableHeaders: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableHeaders: Whether to enable headers for document parsing.

Defaults to false.

enableRewrite^Optional

public readonly enableRewrite: boolean | IResolvable;

• Type: boolean | @alicloud/ros-cdk-core.IResolvable

Property enableRewrite: Whether to enable multi-turn dialogue rewriting.

Defaults to true.

knowledgeScene^Optional

public readonly knowledgeScene: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property knowledgeScene: Knowledge base scene.

Must be provided together with KnowledgeType. The valid values depend on KnowledgeType.

knowledgeType^Optional

public readonly knowledgeType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property knowledgeType: Knowledge base type classification.

Must be provided together with KnowledgeScene. If both are omitted, the system uses default based on StructureType.

metaExtractColumns^Optional

public readonly metaExtractColumns: IResolvable | IResolvable | MetaExtractColumnsProperty[];

• Type: @alicloud/ros-cdk-core.IResolvable | @alicloud/ros-cdk-core.IResolvable | MetaExtractColumnsProperty[]

Property metaExtractColumns: Metadata extraction configuration.

overlapSize^Optional

public readonly overlapSize: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property overlapSize: Overlap size, the number of overlapping characters between adjacent text slices.

Range [0-1024]. Defaults to 100. Must be less than ChunkSize.

pipelineCommercialCu^Optional

public readonly pipelineCommercialCu: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property pipelineCommercialCu: RCU count for enterprise edition.

Only required when PipelineCommercialType is enterprise. Range [1-200].

pipelineCommercialType^Optional

public readonly pipelineCommercialType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property pipelineCommercialType: Knowledge base specification type.

standard: Standard edition. enterprise: Enterprise edition. Defaults to standard.

pipelineRetrieveRateLimitStrategy^Optional

public readonly pipelineRetrieveRateLimitStrategy: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property pipelineRetrieveRateLimitStrategy: Retrieval rate limit strategy for enterprise edition.

Defaults to downgrade.

rerankInstruct^Optional

public readonly rerankInstruct: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property rerankInstruct: Custom rerank instruction.

Required when RerankMode is custom.

rerankMinScore^Optional

public readonly rerankMinScore: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property rerankMinScore: Similarity threshold.

Only text slices with similarity score exceeding this value will be recalled. Range [0.01-1.00]. Defaults to 0.01.

rerankMode^Optional

public readonly rerankMode: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property rerankMode: Rerank mode.

qa: Q&A scenario (default). similar: similarity scenario. custom: custom rerank instruction, requires RerankInstruct.

rerankModelName^Optional

public readonly rerankModelName: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property rerankModelName: Rerank model used by the knowledge base.

Defaults to qwen3-rerank when not specified.

separator^Optional

public readonly separator: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property separator: Separator for chunking.

Only effective when ChunkMode is regex.

sinkInstanceId^Optional

public readonly sinkInstanceId: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property sinkInstanceId: Vector storage instance ID.

Required when SinkType is ADB.

sinkRegion^Optional

public readonly sinkRegion: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property sinkRegion: Region of the vector storage instance.

Required when SinkType is ADB.

sinkType^Optional

public readonly sinkType: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property sinkType: Vector storage type.

BUILT_IN: managed by Bailian platform. ADB: AnalyticDB for PostgreSQL. Defaults to BUILT_IN. When set to ADB, SinkInstanceId and SinkRegion are required.

sparseSimilarityTopK^Optional

public readonly sparseSimilarityTopK: number | IResolvable;

• Type: number | @alicloud/ros-cdk-core.IResolvable

Property sparseSimilarityTopK: Keyword retrieval Top K.

Retrieves text slices by exact keyword matching. Range [0-100]. Defaults to 100. DenseSimilarityTopK + SparseSimilarityTopK must be <= 200. Only supported in UpdateIndex, not in CreateIndex.

table^Optional

public readonly table: string | IResolvable;

• Type: string | @alicloud/ros-cdk-core.IResolvable

Property table: Table name for structured knowledge base.

tableIds^Optional

public readonly tableIds: IResolvable | string | IResolvable[];

• Type: @alicloud/ros-cdk-core.IResolvable | string | @alicloud/ros-cdk-core.IResolvable[]

Property tableIds: Table IDs to import when creating the knowledge base.