IndexProps

Properties for defining a Index.

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

Initializer

import "github.com/alibabacloud-go/ros-cdk/alicloudroscdkbailian"
&alicloudroscdkbailian.IndexProps {
    Name: interface{},
    SourceType: interface{},
    StructureType: interface{},
    WorkspaceId: interface{},
    CategoryIds: interface{},
    ChunkMode: interface{},
    ChunkSize: interface{},
    ConnectId: interface{},
    Database: interface{},
    DenseSimilarityTopK: interface{},
    Description: interface{},
    DocumentIds: interface{},
    EmbeddingModelName: interface{},
    EnableHeaders: interface{},
    EnableRewrite: interface{},
    KnowledgeScene: interface{},
    KnowledgeType: interface{},
    MetaExtractColumns: interface{},
    OverlapSize: interface{},
    PipelineCommercialCu: interface{},
    PipelineCommercialType: interface{},
    PipelineRetrieveRateLimitStrategy: interface{},
    RerankInstruct: interface{},
    RerankMinScore: interface{},
    RerankMode: interface{},
    RerankModelName: interface{},
    Separator: interface{},
    SinkInstanceId: interface{},
    SinkRegion: interface{},
    SinkType: interface{},
    SparseSimilarityTopK: interface{},
    Table: interface{},
    TableIds: interface{},
}

Properties

Name^Required

Name interface{}

• Type: interface{}

Property name: Knowledge base name.

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

SourceType^Required

SourceType interface{}

• Type: interface{}

Property sourceType: Data source type.

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

StructureType^Required

StructureType interface{}

• Type: interface{}

Property structureType: Knowledge base type.

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

WorkspaceId^Required

WorkspaceId interface{}

• Type: interface{}

Property workspaceId: Workspace ID.

The knowledge base will be created in this workspace.

CategoryIds^Optional

CategoryIds interface{}

• Type: interface{}

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

Required when SourceType is DATA_CENTER_CATEGORY.

ChunkMode^Optional

ChunkMode interface{}

• Type: interface{}

Property chunkMode: Chunk strategy.

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

ChunkSize^Optional

ChunkSize interface{}

• Type: interface{}

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

ConnectId interface{}

• Type: interface{}

Property connectId: Connection ID.

Replaces the deprecated datasourceCode parameter.

Database^Optional

Database interface{}

• Type: interface{}

Property database: Database name for structured knowledge base.

DenseSimilarityTopK^Optional

DenseSimilarityTopK interface{}

• Type: interface{}

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

Description interface{}

• Type: interface{}

Property description: Knowledge base description.

0-1000 characters.

DocumentIds^Optional

DocumentIds interface{}

• Type: interface{}

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

Required when SourceType is DATA_CENTER_FILE.

EmbeddingModelName^Optional

EmbeddingModelName interface{}

• Type: interface{}

Property embeddingModelName: Embedding model used by the knowledge base.

Defaults to text-embedding-v3.

EnableHeaders^Optional

EnableHeaders interface{}

• Type: interface{}

Property enableHeaders: Whether to enable headers for document parsing.

Defaults to false.

EnableRewrite^Optional

EnableRewrite interface{}

• Type: interface{}

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

Defaults to true.

KnowledgeScene^Optional

KnowledgeScene interface{}

• Type: interface{}

Property knowledgeScene: Knowledge base scene.

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

KnowledgeType^Optional

KnowledgeType interface{}

• Type: interface{}

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

MetaExtractColumns interface{}

• Type: interface{}

Property metaExtractColumns: Metadata extraction configuration.

OverlapSize^Optional

OverlapSize interface{}

• Type: interface{}

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

PipelineCommercialCu interface{}

• Type: interface{}

Property pipelineCommercialCu: RCU count for enterprise edition.

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

PipelineCommercialType^Optional

PipelineCommercialType interface{}

• Type: interface{}

Property pipelineCommercialType: Knowledge base specification type.

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

PipelineRetrieveRateLimitStrategy^Optional

PipelineRetrieveRateLimitStrategy interface{}

• Type: interface{}

Property pipelineRetrieveRateLimitStrategy: Retrieval rate limit strategy for enterprise edition.

Defaults to downgrade.

RerankInstruct^Optional

RerankInstruct interface{}

• Type: interface{}

Property rerankInstruct: Custom rerank instruction.

Required when RerankMode is custom.

RerankMinScore^Optional

RerankMinScore interface{}

• Type: interface{}

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

RerankMode interface{}

• Type: interface{}

Property rerankMode: Rerank mode.

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

RerankModelName^Optional

RerankModelName interface{}

• Type: interface{}

Property rerankModelName: Rerank model used by the knowledge base.

Defaults to qwen3-rerank when not specified.

Separator^Optional

Separator interface{}

• Type: interface{}

Property separator: Separator for chunking.

Only effective when ChunkMode is regex.

SinkInstanceId^Optional

SinkInstanceId interface{}

• Type: interface{}

Property sinkInstanceId: Vector storage instance ID.

Required when SinkType is ADB.

SinkRegion^Optional

SinkRegion interface{}

• Type: interface{}

Property sinkRegion: Region of the vector storage instance.

Required when SinkType is ADB.

SinkType^Optional

SinkType interface{}

• Type: interface{}

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

SparseSimilarityTopK interface{}

• Type: interface{}

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

Table interface{}

• Type: interface{}

Property table: Table name for structured knowledge base.

TableIds^Optional

TableIds interface{}

• Type: interface{}

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