IndexProps

Properties for defining a Index.

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

Initializer

using AlibabaCloud.SDK.ROS.CDK.Bailian;
new IndexProps {
    object Name,
    object SourceType,
    object StructureType,
    object WorkspaceId,
    object CategoryIds = null,
    object ChunkMode = null,
    object ChunkSize = null,
    object ConnectId = null,
    object Database = null,
    object DenseSimilarityTopK = null,
    object Description = null,
    object DocumentIds = null,
    object EmbeddingModelName = null,
    object EnableHeaders = null,
    object EnableRewrite = null,
    object KnowledgeScene = null,
    object KnowledgeType = null,
    object MetaExtractColumns = null,
    object OverlapSize = null,
    object PipelineCommercialCu = null,
    object PipelineCommercialType = null,
    object PipelineRetrieveRateLimitStrategy = null,
    object RerankInstruct = null,
    object RerankMinScore = null,
    object RerankMode = null,
    object RerankModelName = null,
    object Separator = null,
    object SinkInstanceId = null,
    object SinkRegion = null,
    object SinkType = null,
    object SparseSimilarityTopK = null,
    object Table = null,
    object TableIds = null
};

Properties

Name^Required

public object Name { get; set; }

• Type: object

Property name: Knowledge base name.

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

SourceType^Required

public object SourceType { get; set; }

• Type: object

Property sourceType: Data source type.

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

StructureType^Required

public object StructureType { get; set; }

• Type: object

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 object WorkspaceId { get; set; }

• Type: object

Property workspaceId: Workspace ID.

The knowledge base will be created in this workspace.

CategoryIds^Optional

public object CategoryIds { get; set; }

• Type: object

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

Required when SourceType is DATA_CENTER_CATEGORY.

ChunkMode^Optional

public object ChunkMode { get; set; }

• Type: object

Property chunkMode: Chunk strategy.

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

ChunkSize^Optional

public object ChunkSize { get; set; }

• Type: object

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 object ConnectId { get; set; }

• Type: object

Property connectId: Connection ID.

Replaces the deprecated datasourceCode parameter.

Database^Optional

public object Database { get; set; }

• Type: object

Property database: Database name for structured knowledge base.

DenseSimilarityTopK^Optional

public object DenseSimilarityTopK { get; set; }

• Type: object

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 object Description { get; set; }

• Type: object

Property description: Knowledge base description.

0-1000 characters.

DocumentIds^Optional

public object DocumentIds { get; set; }

• Type: object

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

Required when SourceType is DATA_CENTER_FILE.

EmbeddingModelName^Optional

public object EmbeddingModelName { get; set; }

• Type: object

Property embeddingModelName: Embedding model used by the knowledge base.

Defaults to text-embedding-v3.

EnableHeaders^Optional

public object EnableHeaders { get; set; }

• Type: object

Property enableHeaders: Whether to enable headers for document parsing.

Defaults to false.

EnableRewrite^Optional

public object EnableRewrite { get; set; }

• Type: object

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

Defaults to true.

KnowledgeScene^Optional

public object KnowledgeScene { get; set; }

• Type: object

Property knowledgeScene: Knowledge base scene.

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

KnowledgeType^Optional

public object KnowledgeType { get; set; }

• Type: object

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 object MetaExtractColumns { get; set; }

• Type: object

Property metaExtractColumns: Metadata extraction configuration.

OverlapSize^Optional

public object OverlapSize { get; set; }

• Type: object

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 object PipelineCommercialCu { get; set; }

• Type: object

Property pipelineCommercialCu: RCU count for enterprise edition.

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

PipelineCommercialType^Optional

public object PipelineCommercialType { get; set; }

• Type: object

Property pipelineCommercialType: Knowledge base specification type.

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

PipelineRetrieveRateLimitStrategy^Optional

public object PipelineRetrieveRateLimitStrategy { get; set; }

• Type: object

Property pipelineRetrieveRateLimitStrategy: Retrieval rate limit strategy for enterprise edition.

Defaults to downgrade.

RerankInstruct^Optional

public object RerankInstruct { get; set; }

• Type: object

Property rerankInstruct: Custom rerank instruction.

Required when RerankMode is custom.

RerankMinScore^Optional

public object RerankMinScore { get; set; }

• Type: object

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 object RerankMode { get; set; }

• Type: object

Property rerankMode: Rerank mode.

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

RerankModelName^Optional

public object RerankModelName { get; set; }

• Type: object

Property rerankModelName: Rerank model used by the knowledge base.

Defaults to qwen3-rerank when not specified.

Separator^Optional

public object Separator { get; set; }

• Type: object

Property separator: Separator for chunking.

Only effective when ChunkMode is regex.

SinkInstanceId^Optional

public object SinkInstanceId { get; set; }

• Type: object

Property sinkInstanceId: Vector storage instance ID.

Required when SinkType is ADB.

SinkRegion^Optional

public object SinkRegion { get; set; }

• Type: object

Property sinkRegion: Region of the vector storage instance.

Required when SinkType is ADB.

SinkType^Optional

public object SinkType { get; set; }

• Type: object

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 object SparseSimilarityTopK { get; set; }

• Type: object

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 object Table { get; set; }

• Type: object

Property table: Table name for structured knowledge base.

TableIds^Optional

public object TableIds { get; set; }

• Type: object

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