All Products
Search

This Product

    OpenSearch:Use cases

    Document Center

    OpenSearch:Use cases

    Last Updated:Jun 23, 2026

    Configure a vector index in an OpenSearch retrieval engine edition instance and use the SDK to retrieve data through vector queries.

    Purchase an OpenSearch retrieval engine edition instance

    For more information, see Purchase an OpenSearch retrieval engine edition instance.

    Configure the table

    After you purchase a new instance, the instance status is "Pending configuration" on the product page. An empty cluster that matches the purchased query and data nodes in number and specifications is automatically deployed. Before you run searches, configure the cluster by completing Table basic information> Data synchronization> Index schema> Index rebuilding.

    1. To set up table basic information, customize the Table name, determine the Number of shards, and specify the Number of data update resources.

    Note

    • The maximum shard count for a table is 256. We recommend that you do not set this value to more than three times the number of data nodes in the instance.

    • Two data update resources are provided free of charge by default. Additional resources are billed based on n-2, where n is the total number of data update resources for a single table.

    1. Configure the full data source. Supported data source types include MaxCompute data source, API push data source, Object Storage Service (OSS), and Data Lake Formation (DLF) data source. For example, to use MaxCompute, select "Add data source," choose "MaxCompute" as the type, and enter the project, accesskeyID, accesskeySecret, Table, and partition key. You can also enable automatic reindexing.

    2. After the data source is configured, set up the Index schema.

    Define at least two fields: a Primary key field and a Vector field. Configure the vector field as a multi-value float type.

    To associate a vector with a category, add a category field and set it to a single-value or multi-value integer type.

    Property and field content compression:

    • Attribute fields support compression. In form mode, choose between uncompressed and compressed. In developer mode, select no_compressor or file_compressor.

    • Field content is uncompressed by default. Multi-value and STRING types default to uniq compression, and single-value numeric types default to equal compression.