How to Configure Search Attributes

Step-by-step guide to configure search attributes for your AI Search service to optimize search functionality and results.

Before You Start

  • Your data source must be connected and data fields detected
  • Understanding of your data structure and field types
  • Knowledge of what fields are most important for your users

Understanding Field Types

Text Fields

Fields containing text content (titles, descriptions, names)

Best for: Best for searchable and embedding attributes

Numeric Fields

Fields containing numbers (prices, ratings, quantities)

Best for: Ideal for filtering, sorting, and ranking rules

Categorical Fields

Fields with predefined categories (tags, types, status)

Best for: Good for searchable, embedding, and filterable attributes

Boolean Fields

Fields with true/false values (availability, featured status)

Best for: Useful for filtering results

Configuration Steps

Step 1: Configure Searchable Attributes

Select fields that will be used for keyword search functionality.

  • Navigate to the Search Configuration page in your project dashboard
  • Locate the 'Searchable Attributes' section
  • Click 'Configure Searchable Attributes' button
  • Select text and categorical fields that users should be able to search through
  • These fields will be used for traditional keyword-based search
  • At least one searchable attribute is required

Step 2: Configure Embedding Attributes

Select fields that will be used for semantic AI search capabilities.

  • Find the 'Embedding Attributes' section
  • Click 'Configure Embedding Attributes' button
  • Select text and categorical fields for semantic search
  • These fields will be processed by AI to understand context and meaning
  • Embedding attributes enable more intelligent search results
  • At least one embedding attribute is required

Step 3: Configure Filterable Attributes (Optional)

Select fields that users can filter search results by.

  • Go to the 'Filterable Attributes' section
  • Click 'Configure Filterable Attributes' button
  • Select numeric, categorical, or boolean fields
  • Users will be able to filter results based on these fields
  • Examples: price ranges, categories, availability status
  • This step is optional but recommended for better user experience

Step 4: Configure Sortable Attributes (Optional)

Select fields that users can sort search results by.

  • Locate the 'Sortable Attributes' section
  • Click 'Configure Sortable Attributes' button
  • Select numeric fields that make sense for sorting
  • Common examples: price, rating, date, popularity score
  • Users will be able to sort results in ascending or descending order
  • This step is optional

Step 5: Set Up Custom Ranking Rules (Optional)

Define custom rules for how results should be ranked.

  • Find the 'Custom Ranking Rules' section
  • Click 'Add Rule' to create a new ranking rule
  • Select a numeric field from the dropdown
  • Choose ascending or descending order
  • Add multiple rules to create complex ranking logic
  • Rules are applied in the order they appear
  • Remove rules using the X button if needed

Step 6: Configure Result Attributes

Select which fields should be included in search results.

  • Go to the 'Attributes in Search Result' section
  • Click 'Configure Result Attributes' button
  • Select all fields that should appear in search results
  • Include fields that users need to see to make decisions
  • You can select fields from any data type (text, numeric, categorical, boolean)
  • At least one result attribute is required

Step 7: Save Configuration and Index

Save your configuration and start the indexing process.

  • Review all your attribute selections
  • Ensure all mandatory sections have at least one field selected
  • Click 'Save Configuration & Index Items' button
  • Wait for the indexing process to complete
  • You'll see a progress indicator during indexing
  • Once complete, your search service will be ready to use

Important Notes

  • Searchable, Embedding, and Result attributes are mandatory - at least one field must be selected for each
  • Changes to core attributes (searchable, embedding, filterable, sortable, ranking) require re-indexing
  • Changes to only result attributes can be saved without re-indexing
  • Indexing time depends on the size of your dataset
  • You can modify your configuration at any time
  • More attributes provide more flexibility but may impact performance

Common Issues

Save button is disabled

  • Ensure at least one field is selected for Searchable Attributes
  • Verify at least one field is selected for Embedding Attributes
  • Check that at least one field is selected for Result Attributes
  • Wait for any ongoing indexing process to complete

Indexing takes too long

  • Large datasets may take several minutes to process
  • Check your internet connection stability
  • Avoid making changes during indexing
  • Contact support if indexing exceeds 30 minutes

Search results are not relevant

  • Review your searchable and embedding attribute selections
  • Ensure the most important text fields are included
  • Consider adjusting custom ranking rules
  • Test with different search queries to identify issues

Missing filter or sort options

  • Verify filterable attributes are properly configured
  • Check that sortable attributes include the desired fields
  • Ensure fields are the correct data type for filtering/sorting
  • Re-index if you've made changes to filterable or sortable attributes