Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Algolia Provider
  3. API Docs
  4. VirtualIndex
algolia 0.6.0 published on Monday, Apr 14, 2025 by k-yomo
k-yomo/terraform-provider-algolia

algolia.VirtualIndex

Explore with Pulumi AI

algolia logo
algolia 0.6.0 published on Monday, Apr 14, 2025 by k-yomo
k-yomo/terraform-provider-algolia

    A configuration for a virtual index.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
import * as algolia from "@pulumi/algolia";

const example = new algolia.Index("example", {attributesConfig: {
    searchableAttributes: [
        "title",
        "description",
    ],
    attributesToRetrieves: ["*"],
}});
const exampleVirtualReplica = new algolia.VirtualIndex("exampleVirtualReplica", {
    primaryIndexName: example.name,
    attributesConfig: {
        unretrievableAttributes: ["author_email"],
        attributesToRetrieves: ["*"],
    },
    rankingConfig: {
        customRankings: ["desc(likes)"],
    },
    facetingConfig: {
        maxValuesPerFacet: 50,
        sortFacetValuesBy: "alpha",
    },
    languagesConfig: {
        removeStopWordsFors: ["en"],
    },
});

    import pulumi
import pulumi_algolia as algolia

example = algolia.Index("example", attributes_config={
    "searchable_attributes": [
        "title",
        "description",
    ],
    "attributes_to_retrieves": ["*"],
})
example_virtual_replica = algolia.VirtualIndex("exampleVirtualReplica",
    primary_index_name=example.name,
    attributes_config={
        "unretrievable_attributes": ["author_email"],
        "attributes_to_retrieves": ["*"],
    },
    ranking_config={
        "custom_rankings": ["desc(likes)"],
    },
    faceting_config={
        "max_values_per_facet": 50,
        "sort_facet_values_by": "alpha",
    },
    languages_config={
        "remove_stop_words_fors": ["en"],
    })

    package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/algolia/algolia"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		example, err := algolia.NewIndex(ctx, "example", &algolia.IndexArgs{
			AttributesConfig: &algolia.IndexAttributesConfigArgs{
				SearchableAttributes: pulumi.StringArray{
					pulumi.String("title"),
					pulumi.String("description"),
				},
				AttributesToRetrieves: pulumi.StringArray{
					pulumi.String("*"),
				},
			},
		})
		if err != nil {
			return err
		}
		_, err = algolia.NewVirtualIndex(ctx, "exampleVirtualReplica", &algolia.VirtualIndexArgs{
			PrimaryIndexName: example.Name,
			AttributesConfig: &algolia.VirtualIndexAttributesConfigArgs{
				UnretrievableAttributes: pulumi.StringArray{
					pulumi.String("author_email"),
				},
				AttributesToRetrieves: pulumi.StringArray{
					pulumi.String("*"),
				},
			},
			RankingConfig: &algolia.VirtualIndexRankingConfigArgs{
				CustomRankings: pulumi.StringArray{
					pulumi.String("desc(likes)"),
				},
			},
			FacetingConfig: &algolia.VirtualIndexFacetingConfigArgs{
				MaxValuesPerFacet: pulumi.Float64(50),
				SortFacetValuesBy: pulumi.String("alpha"),
			},
			LanguagesConfig: &algolia.VirtualIndexLanguagesConfigArgs{
				RemoveStopWordsFors: pulumi.StringArray{
					pulumi.String("en"),
				},
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Algolia = Pulumi.Algolia;

return await Deployment.RunAsync(() => 
{
    var example = new Algolia.Index("example", new()
    {
        AttributesConfig = new Algolia.Inputs.IndexAttributesConfigArgs
        {
            SearchableAttributes = new[]
            {
                "title",
                "description",
            },
            AttributesToRetrieves = new[]
            {
                "*",
            },
        },
    });

    var exampleVirtualReplica = new Algolia.VirtualIndex("exampleVirtualReplica", new()
    {
        PrimaryIndexName = example.Name,
        AttributesConfig = new Algolia.Inputs.VirtualIndexAttributesConfigArgs
        {
            UnretrievableAttributes = new[]
            {
                "author_email",
            },
            AttributesToRetrieves = new[]
            {
                "*",
            },
        },
        RankingConfig = new Algolia.Inputs.VirtualIndexRankingConfigArgs
        {
            CustomRankings = new[]
            {
                "desc(likes)",
            },
        },
        FacetingConfig = new Algolia.Inputs.VirtualIndexFacetingConfigArgs
        {
            MaxValuesPerFacet = 50,
            SortFacetValuesBy = "alpha",
        },
        LanguagesConfig = new Algolia.Inputs.VirtualIndexLanguagesConfigArgs
        {
            RemoveStopWordsFors = new[]
            {
                "en",
            },
        },
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.algolia.Index;
import com.pulumi.algolia.IndexArgs;
import com.pulumi.algolia.inputs.IndexAttributesConfigArgs;
import com.pulumi.algolia.VirtualIndex;
import com.pulumi.algolia.VirtualIndexArgs;
import com.pulumi.algolia.inputs.VirtualIndexAttributesConfigArgs;
import com.pulumi.algolia.inputs.VirtualIndexRankingConfigArgs;
import com.pulumi.algolia.inputs.VirtualIndexFacetingConfigArgs;
import com.pulumi.algolia.inputs.VirtualIndexLanguagesConfigArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var example = new Index("example", IndexArgs.builder()
            .attributesConfig(IndexAttributesConfigArgs.builder()
                .searchableAttributes(                
                    "title",
                    "description")
                .attributesToRetrieves("*")
                .build())
            .build());

        var exampleVirtualReplica = new VirtualIndex("exampleVirtualReplica", VirtualIndexArgs.builder()
            .primaryIndexName(example.name())
            .attributesConfig(VirtualIndexAttributesConfigArgs.builder()
                .unretrievableAttributes("author_email")
                .attributesToRetrieves("*")
                .build())
            .rankingConfig(VirtualIndexRankingConfigArgs.builder()
                .customRankings("desc(likes)")
                .build())
            .facetingConfig(VirtualIndexFacetingConfigArgs.builder()
                .maxValuesPerFacet(50)
                .sortFacetValuesBy("alpha")
                .build())
            .languagesConfig(VirtualIndexLanguagesConfigArgs.builder()
                .removeStopWordsFors("en")
                .build())
            .build());

    }
}

    resources:
  example:
    type: algolia:Index
    properties:
      attributesConfig:
        searchableAttributes:
          - title
          - description
        attributesToRetrieves:
          - '*'
  exampleVirtualReplica:
    type: algolia:VirtualIndex
    properties:
      primaryIndexName: ${example.name}
      attributesConfig:
        unretrievableAttributes:
          - author_email
        attributesToRetrieves:
          - '*'
      rankingConfig:
        customRankings:
          - desc(likes)
      facetingConfig:
        maxValuesPerFacet: 50
        sortFacetValuesBy: alpha
      languagesConfig:
        removeStopWordsFors:
          - en

    Create VirtualIndex Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VirtualIndex(name: string, args: VirtualIndexArgs, opts?: CustomResourceOptions);
    @overload
def VirtualIndex(resource_name: str,
                 args: VirtualIndexArgs,
                 opts: Optional[ResourceOptions] = None)

@overload
def VirtualIndex(resource_name: str,
                 opts: Optional[ResourceOptions] = None,
                 primary_index_name: Optional[str] = None,
                 name: Optional[str] = None,
                 query_strategy_config: Optional[VirtualIndexQueryStrategyConfigArgs] = None,
                 enable_personalization: Optional[bool] = None,
                 enable_rules: Optional[bool] = None,
                 faceting_config: Optional[VirtualIndexFacetingConfigArgs] = None,
                 highlight_and_snippet_config: Optional[VirtualIndexHighlightAndSnippetConfigArgs] = None,
                 deletion_protection: Optional[bool] = None,
                 pagination_config: Optional[VirtualIndexPaginationConfigArgs] = None,
                 languages_config: Optional[VirtualIndexLanguagesConfigArgs] = None,
                 attributes_config: Optional[VirtualIndexAttributesConfigArgs] = None,
                 advanced_config: Optional[VirtualIndexAdvancedConfigArgs] = None,
                 ranking_config: Optional[VirtualIndexRankingConfigArgs] = None,
                 timeouts: Optional[VirtualIndexTimeoutsArgs] = None,
                 typos_config: Optional[VirtualIndexTyposConfigArgs] = None,
                 virtual_index_id: Optional[str] = None)
    func NewVirtualIndex(ctx *Context, name string, args VirtualIndexArgs, opts ...ResourceOption) (*VirtualIndex, error)
    public VirtualIndex(string name, VirtualIndexArgs args, CustomResourceOptions? opts = null)
    public VirtualIndex(String name, VirtualIndexArgs args)
public VirtualIndex(String name, VirtualIndexArgs args, CustomResourceOptions options)

    type: algolia:VirtualIndex
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VirtualIndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VirtualIndexArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VirtualIndexArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VirtualIndexArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VirtualIndexArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var virtualIndexResource = new Algolia.VirtualIndex("virtualIndexResource", new()
{
    PrimaryIndexName = "string",
    Name = "string",
    QueryStrategyConfig = new Algolia.Inputs.VirtualIndexQueryStrategyConfigArgs
    {
        AdvancedSyntax = false,
        AdvancedSyntaxFeatures = new[]
        {
            "string",
        },
        AlternativesAsExacts = new[]
        {
            "string",
        },
        DisableExactOnAttributes = new[]
        {
            "string",
        },
        DisablePrefixOnAttributes = new[]
        {
            "string",
        },
        ExactOnSingleWordQuery = "string",
        OptionalWords = new[]
        {
            "string",
        },
        QueryType = "string",
        RemoveWordsIfNoResults = "string",
    },
    EnablePersonalization = false,
    EnableRules = false,
    FacetingConfig = new Algolia.Inputs.VirtualIndexFacetingConfigArgs
    {
        MaxValuesPerFacet = 0,
        SortFacetValuesBy = "string",
    },
    HighlightAndSnippetConfig = new Algolia.Inputs.VirtualIndexHighlightAndSnippetConfigArgs
    {
        AttributesToHighlights = new[]
        {
            "string",
        },
        AttributesToSnippets = new[]
        {
            "string",
        },
        HighlightPostTag = "string",
        HighlightPreTag = "string",
        RestrictHighlightAndSnippetArrays = false,
        SnippetEllipsisText = "string",
    },
    DeletionProtection = false,
    PaginationConfig = new Algolia.Inputs.VirtualIndexPaginationConfigArgs
    {
        HitsPerPage = 0,
        PaginationLimitedTo = 0,
    },
    LanguagesConfig = new Algolia.Inputs.VirtualIndexLanguagesConfigArgs
    {
        AttributesToTransliterates = new[]
        {
            "string",
        },
        CamelCaseAttributes = new[]
        {
            "string",
        },
        CustomNormalization = 
        {
            { "string", "string" },
        },
        DecompoundQuery = false,
        DecompoundedAttributes = new[]
        {
            new Algolia.Inputs.VirtualIndexLanguagesConfigDecompoundedAttributeArgs
            {
                Attributes = new[]
                {
                    "string",
                },
                Language = "string",
            },
        },
        IgnorePlurals = false,
        IgnorePluralsFors = new[]
        {
            "string",
        },
        IndexLanguages = new[]
        {
            "string",
        },
        KeepDiacriticsOnCharacters = "string",
        QueryLanguages = new[]
        {
            "string",
        },
        RemoveStopWords = false,
        RemoveStopWordsFors = new[]
        {
            "string",
        },
    },
    AttributesConfig = new Algolia.Inputs.VirtualIndexAttributesConfigArgs
    {
        AttributesForFacetings = new[]
        {
            "string",
        },
        AttributesToRetrieves = new[]
        {
            "string",
        },
        SearchableAttributes = new[]
        {
            "string",
        },
        UnretrievableAttributes = new[]
        {
            "string",
        },
    },
    AdvancedConfig = new Algolia.Inputs.VirtualIndexAdvancedConfigArgs
    {
        AttributeCriteriaComputedByMinProximity = false,
        AttributeForDistinct = "string",
        Distinct = 0,
        MaxFacetHits = 0,
        MinProximity = 0,
        ReplaceSynonymsInHighlight = false,
        ResponseFields = new[]
        {
            "string",
        },
    },
    RankingConfig = new Algolia.Inputs.VirtualIndexRankingConfigArgs
    {
        CustomRankings = new[]
        {
            "string",
        },
        Rankings = new[]
        {
            "string",
        },
        RelevancyStrictness = 0,
    },
    Timeouts = new Algolia.Inputs.VirtualIndexTimeoutsArgs
    {
        Default = "string",
    },
    TyposConfig = new Algolia.Inputs.VirtualIndexTyposConfigArgs
    {
        AllowTyposOnNumericTokens = false,
        DisableTypoToleranceOnAttributes = new[]
        {
            "string",
        },
        DisableTypoToleranceOnWords = new[]
        {
            "string",
        },
        MinWordSizeFor1Typo = 0,
        MinWordSizeFor2Typos = 0,
        SeparatorsToIndex = "string",
        TypoTolerance = "string",
    },
    VirtualIndexId = "string",
});

    example, err := algolia.NewVirtualIndex(ctx, "virtualIndexResource", &algolia.VirtualIndexArgs{
	PrimaryIndexName: pulumi.String("string"),
	Name:             pulumi.String("string"),
	QueryStrategyConfig: &algolia.VirtualIndexQueryStrategyConfigArgs{
		AdvancedSyntax: pulumi.Bool(false),
		AdvancedSyntaxFeatures: pulumi.StringArray{
			pulumi.String("string"),
		},
		AlternativesAsExacts: pulumi.StringArray{
			pulumi.String("string"),
		},
		DisableExactOnAttributes: pulumi.StringArray{
			pulumi.String("string"),
		},
		DisablePrefixOnAttributes: pulumi.StringArray{
			pulumi.String("string"),
		},
		ExactOnSingleWordQuery: pulumi.String("string"),
		OptionalWords: pulumi.StringArray{
			pulumi.String("string"),
		},
		QueryType:              pulumi.String("string"),
		RemoveWordsIfNoResults: pulumi.String("string"),
	},
	EnablePersonalization: pulumi.Bool(false),
	EnableRules:           pulumi.Bool(false),
	FacetingConfig: &algolia.VirtualIndexFacetingConfigArgs{
		MaxValuesPerFacet: pulumi.Float64(0),
		SortFacetValuesBy: pulumi.String("string"),
	},
	HighlightAndSnippetConfig: &algolia.VirtualIndexHighlightAndSnippetConfigArgs{
		AttributesToHighlights: pulumi.StringArray{
			pulumi.String("string"),
		},
		AttributesToSnippets: pulumi.StringArray{
			pulumi.String("string"),
		},
		HighlightPostTag:                  pulumi.String("string"),
		HighlightPreTag:                   pulumi.String("string"),
		RestrictHighlightAndSnippetArrays: pulumi.Bool(false),
		SnippetEllipsisText:               pulumi.String("string"),
	},
	DeletionProtection: pulumi.Bool(false),
	PaginationConfig: &algolia.VirtualIndexPaginationConfigArgs{
		HitsPerPage:         pulumi.Float64(0),
		PaginationLimitedTo: pulumi.Float64(0),
	},
	LanguagesConfig: &algolia.VirtualIndexLanguagesConfigArgs{
		AttributesToTransliterates: pulumi.StringArray{
			pulumi.String("string"),
		},
		CamelCaseAttributes: pulumi.StringArray{
			pulumi.String("string"),
		},
		CustomNormalization: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
		DecompoundQuery: pulumi.Bool(false),
		DecompoundedAttributes: algolia.VirtualIndexLanguagesConfigDecompoundedAttributeArray{
			&algolia.VirtualIndexLanguagesConfigDecompoundedAttributeArgs{
				Attributes: pulumi.StringArray{
					pulumi.String("string"),
				},
				Language: pulumi.String("string"),
			},
		},
		IgnorePlurals: pulumi.Bool(false),
		IgnorePluralsFors: pulumi.StringArray{
			pulumi.String("string"),
		},
		IndexLanguages: pulumi.StringArray{
			pulumi.String("string"),
		},
		KeepDiacriticsOnCharacters: pulumi.String("string"),
		QueryLanguages: pulumi.StringArray{
			pulumi.String("string"),
		},
		RemoveStopWords: pulumi.Bool(false),
		RemoveStopWordsFors: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	AttributesConfig: &algolia.VirtualIndexAttributesConfigArgs{
		AttributesForFacetings: pulumi.StringArray{
			pulumi.String("string"),
		},
		AttributesToRetrieves: pulumi.StringArray{
			pulumi.String("string"),
		},
		SearchableAttributes: pulumi.StringArray{
			pulumi.String("string"),
		},
		UnretrievableAttributes: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	AdvancedConfig: &algolia.VirtualIndexAdvancedConfigArgs{
		AttributeCriteriaComputedByMinProximity: pulumi.Bool(false),
		AttributeForDistinct:                    pulumi.String("string"),
		Distinct:                                pulumi.Float64(0),
		MaxFacetHits:                            pulumi.Float64(0),
		MinProximity:                            pulumi.Float64(0),
		ReplaceSynonymsInHighlight:              pulumi.Bool(false),
		ResponseFields: pulumi.StringArray{
			pulumi.String("string"),
		},
	},
	RankingConfig: &algolia.VirtualIndexRankingConfigArgs{
		CustomRankings: pulumi.StringArray{
			pulumi.String("string"),
		},
		Rankings: pulumi.StringArray{
			pulumi.String("string"),
		},
		RelevancyStrictness: pulumi.Float64(0),
	},
	Timeouts: &algolia.VirtualIndexTimeoutsArgs{
		Default: pulumi.String("string"),
	},
	TyposConfig: &algolia.VirtualIndexTyposConfigArgs{
		AllowTyposOnNumericTokens: pulumi.Bool(false),
		DisableTypoToleranceOnAttributes: pulumi.StringArray{
			pulumi.String("string"),
		},
		DisableTypoToleranceOnWords: pulumi.StringArray{
			pulumi.String("string"),
		},
		MinWordSizeFor1Typo:  pulumi.Float64(0),
		MinWordSizeFor2Typos: pulumi.Float64(0),
		SeparatorsToIndex:    pulumi.String("string"),
		TypoTolerance:        pulumi.String("string"),
	},
	VirtualIndexId: pulumi.String("string"),
})

    var virtualIndexResource = new VirtualIndex("virtualIndexResource", VirtualIndexArgs.builder()
    .primaryIndexName("string")
    .name("string")
    .queryStrategyConfig(VirtualIndexQueryStrategyConfigArgs.builder()
        .advancedSyntax(false)
        .advancedSyntaxFeatures("string")
        .alternativesAsExacts("string")
        .disableExactOnAttributes("string")
        .disablePrefixOnAttributes("string")
        .exactOnSingleWordQuery("string")
        .optionalWords("string")
        .queryType("string")
        .removeWordsIfNoResults("string")
        .build())
    .enablePersonalization(false)
    .enableRules(false)
    .facetingConfig(VirtualIndexFacetingConfigArgs.builder()
        .maxValuesPerFacet(0)
        .sortFacetValuesBy("string")
        .build())
    .highlightAndSnippetConfig(VirtualIndexHighlightAndSnippetConfigArgs.builder()
        .attributesToHighlights("string")
        .attributesToSnippets("string")
        .highlightPostTag("string")
        .highlightPreTag("string")
        .restrictHighlightAndSnippetArrays(false)
        .snippetEllipsisText("string")
        .build())
    .deletionProtection(false)
    .paginationConfig(VirtualIndexPaginationConfigArgs.builder()
        .hitsPerPage(0)
        .paginationLimitedTo(0)
        .build())
    .languagesConfig(VirtualIndexLanguagesConfigArgs.builder()
        .attributesToTransliterates("string")
        .camelCaseAttributes("string")
        .customNormalization(Map.of("string", "string"))
        .decompoundQuery(false)
        .decompoundedAttributes(VirtualIndexLanguagesConfigDecompoundedAttributeArgs.builder()
            .attributes("string")
            .language("string")
            .build())
        .ignorePlurals(false)
        .ignorePluralsFors("string")
        .indexLanguages("string")
        .keepDiacriticsOnCharacters("string")
        .queryLanguages("string")
        .removeStopWords(false)
        .removeStopWordsFors("string")
        .build())
    .attributesConfig(VirtualIndexAttributesConfigArgs.builder()
        .attributesForFacetings("string")
        .attributesToRetrieves("string")
        .searchableAttributes("string")
        .unretrievableAttributes("string")
        .build())
    .advancedConfig(VirtualIndexAdvancedConfigArgs.builder()
        .attributeCriteriaComputedByMinProximity(false)
        .attributeForDistinct("string")
        .distinct(0)
        .maxFacetHits(0)
        .minProximity(0)
        .replaceSynonymsInHighlight(false)
        .responseFields("string")
        .build())
    .rankingConfig(VirtualIndexRankingConfigArgs.builder()
        .customRankings("string")
        .rankings("string")
        .relevancyStrictness(0)
        .build())
    .timeouts(VirtualIndexTimeoutsArgs.builder()
        .default_("string")
        .build())
    .typosConfig(VirtualIndexTyposConfigArgs.builder()
        .allowTyposOnNumericTokens(false)
        .disableTypoToleranceOnAttributes("string")
        .disableTypoToleranceOnWords("string")
        .minWordSizeFor1Typo(0)
        .minWordSizeFor2Typos(0)
        .separatorsToIndex("string")
        .typoTolerance("string")
        .build())
    .virtualIndexId("string")
    .build());

    virtual_index_resource = algolia.VirtualIndex("virtualIndexResource",
    primary_index_name="string",
    name="string",
    query_strategy_config={
        "advanced_syntax": False,
        "advanced_syntax_features": ["string"],
        "alternatives_as_exacts": ["string"],
        "disable_exact_on_attributes": ["string"],
        "disable_prefix_on_attributes": ["string"],
        "exact_on_single_word_query": "string",
        "optional_words": ["string"],
        "query_type": "string",
        "remove_words_if_no_results": "string",
    },
    enable_personalization=False,
    enable_rules=False,
    faceting_config={
        "max_values_per_facet": 0,
        "sort_facet_values_by": "string",
    },
    highlight_and_snippet_config={
        "attributes_to_highlights": ["string"],
        "attributes_to_snippets": ["string"],
        "highlight_post_tag": "string",
        "highlight_pre_tag": "string",
        "restrict_highlight_and_snippet_arrays": False,
        "snippet_ellipsis_text": "string",
    },
    deletion_protection=False,
    pagination_config={
        "hits_per_page": 0,
        "pagination_limited_to": 0,
    },
    languages_config={
        "attributes_to_transliterates": ["string"],
        "camel_case_attributes": ["string"],
        "custom_normalization": {
            "string": "string",
        },
        "decompound_query": False,
        "decompounded_attributes": [{
            "attributes": ["string"],
            "language": "string",
        }],
        "ignore_plurals": False,
        "ignore_plurals_fors": ["string"],
        "index_languages": ["string"],
        "keep_diacritics_on_characters": "string",
        "query_languages": ["string"],
        "remove_stop_words": False,
        "remove_stop_words_fors": ["string"],
    },
    attributes_config={
        "attributes_for_facetings": ["string"],
        "attributes_to_retrieves": ["string"],
        "searchable_attributes": ["string"],
        "unretrievable_attributes": ["string"],
    },
    advanced_config={
        "attribute_criteria_computed_by_min_proximity": False,
        "attribute_for_distinct": "string",
        "distinct": 0,
        "max_facet_hits": 0,
        "min_proximity": 0,
        "replace_synonyms_in_highlight": False,
        "response_fields": ["string"],
    },
    ranking_config={
        "custom_rankings": ["string"],
        "rankings": ["string"],
        "relevancy_strictness": 0,
    },
    timeouts={
        "default": "string",
    },
    typos_config={
        "allow_typos_on_numeric_tokens": False,
        "disable_typo_tolerance_on_attributes": ["string"],
        "disable_typo_tolerance_on_words": ["string"],
        "min_word_size_for1_typo": 0,
        "min_word_size_for2_typos": 0,
        "separators_to_index": "string",
        "typo_tolerance": "string",
    },
    virtual_index_id="string")

    const virtualIndexResource = new algolia.VirtualIndex("virtualIndexResource", {
    primaryIndexName: "string",
    name: "string",
    queryStrategyConfig: {
        advancedSyntax: false,
        advancedSyntaxFeatures: ["string"],
        alternativesAsExacts: ["string"],
        disableExactOnAttributes: ["string"],
        disablePrefixOnAttributes: ["string"],
        exactOnSingleWordQuery: "string",
        optionalWords: ["string"],
        queryType: "string",
        removeWordsIfNoResults: "string",
    },
    enablePersonalization: false,
    enableRules: false,
    facetingConfig: {
        maxValuesPerFacet: 0,
        sortFacetValuesBy: "string",
    },
    highlightAndSnippetConfig: {
        attributesToHighlights: ["string"],
        attributesToSnippets: ["string"],
        highlightPostTag: "string",
        highlightPreTag: "string",
        restrictHighlightAndSnippetArrays: false,
        snippetEllipsisText: "string",
    },
    deletionProtection: false,
    paginationConfig: {
        hitsPerPage: 0,
        paginationLimitedTo: 0,
    },
    languagesConfig: {
        attributesToTransliterates: ["string"],
        camelCaseAttributes: ["string"],
        customNormalization: {
            string: "string",
        },
        decompoundQuery: false,
        decompoundedAttributes: [{
            attributes: ["string"],
            language: "string",
        }],
        ignorePlurals: false,
        ignorePluralsFors: ["string"],
        indexLanguages: ["string"],
        keepDiacriticsOnCharacters: "string",
        queryLanguages: ["string"],
        removeStopWords: false,
        removeStopWordsFors: ["string"],
    },
    attributesConfig: {
        attributesForFacetings: ["string"],
        attributesToRetrieves: ["string"],
        searchableAttributes: ["string"],
        unretrievableAttributes: ["string"],
    },
    advancedConfig: {
        attributeCriteriaComputedByMinProximity: false,
        attributeForDistinct: "string",
        distinct: 0,
        maxFacetHits: 0,
        minProximity: 0,
        replaceSynonymsInHighlight: false,
        responseFields: ["string"],
    },
    rankingConfig: {
        customRankings: ["string"],
        rankings: ["string"],
        relevancyStrictness: 0,
    },
    timeouts: {
        "default": "string",
    },
    typosConfig: {
        allowTyposOnNumericTokens: false,
        disableTypoToleranceOnAttributes: ["string"],
        disableTypoToleranceOnWords: ["string"],
        minWordSizeFor1Typo: 0,
        minWordSizeFor2Typos: 0,
        separatorsToIndex: "string",
        typoTolerance: "string",
    },
    virtualIndexId: "string",
});

    type: algolia:VirtualIndex
properties:
    advancedConfig:
        attributeCriteriaComputedByMinProximity: false
        attributeForDistinct: string
        distinct: 0
        maxFacetHits: 0
        minProximity: 0
        replaceSynonymsInHighlight: false
        responseFields:
            - string
    attributesConfig:
        attributesForFacetings:
            - string
        attributesToRetrieves:
            - string
        searchableAttributes:
            - string
        unretrievableAttributes:
            - string
    deletionProtection: false
    enablePersonalization: false
    enableRules: false
    facetingConfig:
        maxValuesPerFacet: 0
        sortFacetValuesBy: string
    highlightAndSnippetConfig:
        attributesToHighlights:
            - string
        attributesToSnippets:
            - string
        highlightPostTag: string
        highlightPreTag: string
        restrictHighlightAndSnippetArrays: false
        snippetEllipsisText: string
    languagesConfig:
        attributesToTransliterates:
            - string
        camelCaseAttributes:
            - string
        customNormalization:
            string: string
        decompoundQuery: false
        decompoundedAttributes:
            - attributes:
                - string
              language: string
        ignorePlurals: false
        ignorePluralsFors:
            - string
        indexLanguages:
            - string
        keepDiacriticsOnCharacters: string
        queryLanguages:
            - string
        removeStopWords: false
        removeStopWordsFors:
            - string
    name: string
    paginationConfig:
        hitsPerPage: 0
        paginationLimitedTo: 0
    primaryIndexName: string
    queryStrategyConfig:
        advancedSyntax: false
        advancedSyntaxFeatures:
            - string
        alternativesAsExacts:
            - string
        disableExactOnAttributes:
            - string
        disablePrefixOnAttributes:
            - string
        exactOnSingleWordQuery: string
        optionalWords:
            - string
        queryType: string
        removeWordsIfNoResults: string
    rankingConfig:
        customRankings:
            - string
        rankings:
            - string
        relevancyStrictness: 0
    timeouts:
        default: string
    typosConfig:
        allowTyposOnNumericTokens: false
        disableTypoToleranceOnAttributes:
            - string
        disableTypoToleranceOnWords:
            - string
        minWordSizeFor1Typo: 0
        minWordSizeFor2Typos: 0
        separatorsToIndex: string
        typoTolerance: string
    virtualIndexId: string

    VirtualIndex Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VirtualIndex resource accepts the following input properties:

    PrimaryIndexName string
    The name of the existing primary index name.
    AdvancedConfig VirtualIndexAdvancedConfig
    The configuration for advanced features in index setting.
    AttributesConfig VirtualIndexAttributesConfig
    The configuration for attributes.
    DeletionProtection bool
    EnablePersonalization bool
    Whether to enable the Personalization feature.
    EnableRules bool
    Whether Rules should be globally enabled.
    FacetingConfig VirtualIndexFacetingConfig
    The configuration for faceting.
    HighlightAndSnippetConfig VirtualIndexHighlightAndSnippetConfig
    The configuration for highlight / snippet in index setting.
    LanguagesConfig VirtualIndexLanguagesConfig
    The configuration for languages in index setting.
    Name string
    Name of the virtual index. Its name should NOT be surrounded with virtual().
    PaginationConfig VirtualIndexPaginationConfig
    The configuration for pagination in index setting.
    QueryStrategyConfig VirtualIndexQueryStrategyConfig
    The configuration for query strategy in index setting.
    RankingConfig VirtualIndexRankingConfig
    The configuration for ranking.
    Timeouts VirtualIndexTimeouts
    TyposConfig VirtualIndexTyposConfig
    The configuration for typos in index setting.
    VirtualIndexId string
    PrimaryIndexName string
    The name of the existing primary index name.
    AdvancedConfig VirtualIndexAdvancedConfigArgs
    The configuration for advanced features in index setting.
    AttributesConfig VirtualIndexAttributesConfigArgs
    The configuration for attributes.
    DeletionProtection bool
    EnablePersonalization bool
    Whether to enable the Personalization feature.
    EnableRules bool
    Whether Rules should be globally enabled.
    FacetingConfig VirtualIndexFacetingConfigArgs
    The configuration for faceting.
    HighlightAndSnippetConfig VirtualIndexHighlightAndSnippetConfigArgs
    The configuration for highlight / snippet in index setting.
    LanguagesConfig VirtualIndexLanguagesConfigArgs
    The configuration for languages in index setting.
    Name string
    Name of the virtual index. Its name should NOT be surrounded with virtual().
    PaginationConfig VirtualIndexPaginationConfigArgs
    The configuration for pagination in index setting.
    QueryStrategyConfig VirtualIndexQueryStrategyConfigArgs
    The configuration for query strategy in index setting.
    RankingConfig VirtualIndexRankingConfigArgs
    The configuration for ranking.
    Timeouts VirtualIndexTimeoutsArgs
    TyposConfig VirtualIndexTyposConfigArgs
    The configuration for typos in index setting.
    VirtualIndexId string
    primaryIndexName String
    The name of the existing primary index name.
    advancedConfig VirtualIndexAdvancedConfig
    The configuration for advanced features in index setting.
    attributesConfig VirtualIndexAttributesConfig
    The configuration for attributes.
    deletionProtection Boolean
    enablePersonalization Boolean
    Whether to enable the Personalization feature.
    enableRules Boolean
    Whether Rules should be globally enabled.
    facetingConfig VirtualIndexFacetingConfig
    The configuration for faceting.
    highlightAndSnippetConfig VirtualIndexHighlightAndSnippetConfig
    The configuration for highlight / snippet in index setting.
    languagesConfig VirtualIndexLanguagesConfig
    The configuration for languages in index setting.
    name String
    Name of the virtual index. Its name should NOT be surrounded with virtual().
    paginationConfig VirtualIndexPaginationConfig
    The configuration for pagination in index setting.
    queryStrategyConfig VirtualIndexQueryStrategyConfig
    The configuration for query strategy in index setting.
    rankingConfig VirtualIndexRankingConfig
    The configuration for ranking.
    timeouts VirtualIndexTimeouts
    typosConfig VirtualIndexTyposConfig
    The configuration for typos in index setting.
    virtualIndexId String
    primaryIndexName string
    The name of the existing primary index name.
    advancedConfig VirtualIndexAdvancedConfig
    The configuration for advanced features in index setting.
    attributesConfig VirtualIndexAttributesConfig
    The configuration for attributes.
    deletionProtection boolean
    enablePersonalization boolean
    Whether to enable the Personalization feature.
    enableRules boolean
    Whether Rules should be globally enabled.
    facetingConfig VirtualIndexFacetingConfig
    The configuration for faceting.
    highlightAndSnippetConfig VirtualIndexHighlightAndSnippetConfig
    The configuration for highlight / snippet in index setting.
    languagesConfig VirtualIndexLanguagesConfig
    The configuration for languages in index setting.
    name string
    Name of the virtual index. Its name should NOT be surrounded with virtual().
    paginationConfig VirtualIndexPaginationConfig
    The configuration for pagination in index setting.
    queryStrategyConfig VirtualIndexQueryStrategyConfig
    The configuration for query strategy in index setting.
    rankingConfig VirtualIndexRankingConfig
    The configuration for ranking.
    timeouts VirtualIndexTimeouts
    typosConfig VirtualIndexTyposConfig
    The configuration for typos in index setting.
    virtualIndexId string
    primary_index_name str
    The name of the existing primary index name.
    advanced_config VirtualIndexAdvancedConfigArgs
    The configuration for advanced features in index setting.
    attributes_config VirtualIndexAttributesConfigArgs
    The configuration for attributes.
    deletion_protection bool
    enable_personalization bool
    Whether to enable the Personalization feature.
    enable_rules bool
    Whether Rules should be globally enabled.
    faceting_config VirtualIndexFacetingConfigArgs
    The configuration for faceting.
    highlight_and_snippet_config VirtualIndexHighlightAndSnippetConfigArgs
    The configuration for highlight / snippet in index setting.
    languages_config VirtualIndexLanguagesConfigArgs
    The configuration for languages in index setting.
    name str
    Name of the virtual index. Its name should NOT be surrounded with virtual().
    pagination_config VirtualIndexPaginationConfigArgs
    The configuration for pagination in index setting.
    query_strategy_config VirtualIndexQueryStrategyConfigArgs
    The configuration for query strategy in index setting.
    ranking_config VirtualIndexRankingConfigArgs
    The configuration for ranking.
    timeouts VirtualIndexTimeoutsArgs
    typos_config VirtualIndexTyposConfigArgs
    The configuration for typos in index setting.
    virtual_index_id str
    primaryIndexName String
    The name of the existing primary index name.
    advancedConfig Property Map
    The configuration for advanced features in index setting.
    attributesConfig Property Map
    The configuration for attributes.
    deletionProtection Boolean
    enablePersonalization Boolean
    Whether to enable the Personalization feature.
    enableRules Boolean
    Whether Rules should be globally enabled.
    facetingConfig Property Map
    The configuration for faceting.
    highlightAndSnippetConfig Property Map
    The configuration for highlight / snippet in index setting.
    languagesConfig Property Map
    The configuration for languages in index setting.
    name String
    Name of the virtual index. Its name should NOT be surrounded with virtual().
    paginationConfig Property Map
    The configuration for pagination in index setting.
    queryStrategyConfig Property Map
    The configuration for query strategy in index setting.
    rankingConfig Property Map
    The configuration for ranking.
    timeouts Property Map
    typosConfig Property Map
    The configuration for typos in index setting.
    virtualIndexId String

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VirtualIndex resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    PerformanceConfigs List<VirtualIndexPerformanceConfig>
    The configuration for performance in index setting.
    Id string
    The provider-assigned unique ID for this managed resource.
    PerformanceConfigs []VirtualIndexPerformanceConfig
    The configuration for performance in index setting.
    id String
    The provider-assigned unique ID for this managed resource.
    performanceConfigs List<VirtualIndexPerformanceConfig>
    The configuration for performance in index setting.
    id string
    The provider-assigned unique ID for this managed resource.
    performanceConfigs VirtualIndexPerformanceConfig[]
    The configuration for performance in index setting.
    id str
    The provider-assigned unique ID for this managed resource.
    performance_configs Sequence[VirtualIndexPerformanceConfig]
    The configuration for performance in index setting.
    id String
    The provider-assigned unique ID for this managed resource.
    performanceConfigs List<Property Map>
    The configuration for performance in index setting.

    Look up Existing VirtualIndex Resource

    Get an existing VirtualIndex resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VirtualIndexState, opts?: CustomResourceOptions): VirtualIndex
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        advanced_config: Optional[VirtualIndexAdvancedConfigArgs] = None,
        attributes_config: Optional[VirtualIndexAttributesConfigArgs] = None,
        deletion_protection: Optional[bool] = None,
        enable_personalization: Optional[bool] = None,
        enable_rules: Optional[bool] = None,
        faceting_config: Optional[VirtualIndexFacetingConfigArgs] = None,
        highlight_and_snippet_config: Optional[VirtualIndexHighlightAndSnippetConfigArgs] = None,
        languages_config: Optional[VirtualIndexLanguagesConfigArgs] = None,
        name: Optional[str] = None,
        pagination_config: Optional[VirtualIndexPaginationConfigArgs] = None,
        performance_configs: Optional[Sequence[VirtualIndexPerformanceConfigArgs]] = None,
        primary_index_name: Optional[str] = None,
        query_strategy_config: Optional[VirtualIndexQueryStrategyConfigArgs] = None,
        ranking_config: Optional[VirtualIndexRankingConfigArgs] = None,
        timeouts: Optional[VirtualIndexTimeoutsArgs] = None,
        typos_config: Optional[VirtualIndexTyposConfigArgs] = None,
        virtual_index_id: Optional[str] = None) -> VirtualIndex
    func GetVirtualIndex(ctx *Context, name string, id IDInput, state *VirtualIndexState, opts ...ResourceOption) (*VirtualIndex, error)
    public static VirtualIndex Get(string name, Input<string> id, VirtualIndexState? state, CustomResourceOptions? opts = null)
    public static VirtualIndex get(String name, Output<String> id, VirtualIndexState state, CustomResourceOptions options)
    resources:  _:    type: algolia:VirtualIndex    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AdvancedConfig VirtualIndexAdvancedConfig
    The configuration for advanced features in index setting.
    AttributesConfig VirtualIndexAttributesConfig
    The configuration for attributes.
    DeletionProtection bool
    EnablePersonalization bool
    Whether to enable the Personalization feature.
    EnableRules bool
    Whether Rules should be globally enabled.
    FacetingConfig VirtualIndexFacetingConfig
    The configuration for faceting.
    HighlightAndSnippetConfig VirtualIndexHighlightAndSnippetConfig
    The configuration for highlight / snippet in index setting.
    LanguagesConfig VirtualIndexLanguagesConfig
    The configuration for languages in index setting.
    Name string
    Name of the virtual index. Its name should NOT be surrounded with virtual().
    PaginationConfig VirtualIndexPaginationConfig
    The configuration for pagination in index setting.
    PerformanceConfigs List<VirtualIndexPerformanceConfig>
    The configuration for performance in index setting.
    PrimaryIndexName string
    The name of the existing primary index name.
    QueryStrategyConfig VirtualIndexQueryStrategyConfig
    The configuration for query strategy in index setting.
    RankingConfig VirtualIndexRankingConfig
    The configuration for ranking.
    Timeouts VirtualIndexTimeouts
    TyposConfig VirtualIndexTyposConfig
    The configuration for typos in index setting.
    VirtualIndexId string
    AdvancedConfig VirtualIndexAdvancedConfigArgs
    The configuration for advanced features in index setting.
    AttributesConfig VirtualIndexAttributesConfigArgs
    The configuration for attributes.
    DeletionProtection bool
    EnablePersonalization bool
    Whether to enable the Personalization feature.
    EnableRules bool
    Whether Rules should be globally enabled.
    FacetingConfig VirtualIndexFacetingConfigArgs
    The configuration for faceting.
    HighlightAndSnippetConfig VirtualIndexHighlightAndSnippetConfigArgs
    The configuration for highlight / snippet in index setting.
    LanguagesConfig VirtualIndexLanguagesConfigArgs
    The configuration for languages in index setting.
    Name string
    Name of the virtual index. Its name should NOT be surrounded with virtual().
    PaginationConfig VirtualIndexPaginationConfigArgs
    The configuration for pagination in index setting.
    PerformanceConfigs []VirtualIndexPerformanceConfigArgs
    The configuration for performance in index setting.
    PrimaryIndexName string
    The name of the existing primary index name.
    QueryStrategyConfig VirtualIndexQueryStrategyConfigArgs
    The configuration for query strategy in index setting.
    RankingConfig VirtualIndexRankingConfigArgs
    The configuration for ranking.
    Timeouts VirtualIndexTimeoutsArgs
    TyposConfig VirtualIndexTyposConfigArgs
    The configuration for typos in index setting.
    VirtualIndexId string
    advancedConfig VirtualIndexAdvancedConfig
    The configuration for advanced features in index setting.
    attributesConfig VirtualIndexAttributesConfig
    The configuration for attributes.
    deletionProtection Boolean
    enablePersonalization Boolean
    Whether to enable the Personalization feature.
    enableRules Boolean
    Whether Rules should be globally enabled.
    facetingConfig VirtualIndexFacetingConfig
    The configuration for faceting.
    highlightAndSnippetConfig VirtualIndexHighlightAndSnippetConfig
    The configuration for highlight / snippet in index setting.
    languagesConfig VirtualIndexLanguagesConfig
    The configuration for languages in index setting.
    name String
    Name of the virtual index. Its name should NOT be surrounded with virtual().
    paginationConfig VirtualIndexPaginationConfig
    The configuration for pagination in index setting.
    performanceConfigs List<VirtualIndexPerformanceConfig>
    The configuration for performance in index setting.
    primaryIndexName String
    The name of the existing primary index name.
    queryStrategyConfig VirtualIndexQueryStrategyConfig
    The configuration for query strategy in index setting.
    rankingConfig VirtualIndexRankingConfig
    The configuration for ranking.
    timeouts VirtualIndexTimeouts
    typosConfig VirtualIndexTyposConfig
    The configuration for typos in index setting.
    virtualIndexId String
    advancedConfig VirtualIndexAdvancedConfig
    The configuration for advanced features in index setting.
    attributesConfig VirtualIndexAttributesConfig
    The configuration for attributes.
    deletionProtection boolean
    enablePersonalization boolean
    Whether to enable the Personalization feature.
    enableRules boolean
    Whether Rules should be globally enabled.
    facetingConfig VirtualIndexFacetingConfig
    The configuration for faceting.
    highlightAndSnippetConfig VirtualIndexHighlightAndSnippetConfig
    The configuration for highlight / snippet in index setting.
    languagesConfig VirtualIndexLanguagesConfig
    The configuration for languages in index setting.
    name string
    Name of the virtual index. Its name should NOT be surrounded with virtual().
    paginationConfig VirtualIndexPaginationConfig
    The configuration for pagination in index setting.
    performanceConfigs VirtualIndexPerformanceConfig[]
    The configuration for performance in index setting.
    primaryIndexName string
    The name of the existing primary index name.
    queryStrategyConfig VirtualIndexQueryStrategyConfig
    The configuration for query strategy in index setting.
    rankingConfig VirtualIndexRankingConfig
    The configuration for ranking.
    timeouts VirtualIndexTimeouts
    typosConfig VirtualIndexTyposConfig
    The configuration for typos in index setting.
    virtualIndexId string
    advanced_config VirtualIndexAdvancedConfigArgs
    The configuration for advanced features in index setting.
    attributes_config VirtualIndexAttributesConfigArgs
    The configuration for attributes.
    deletion_protection bool
    enable_personalization bool
    Whether to enable the Personalization feature.
    enable_rules bool
    Whether Rules should be globally enabled.
    faceting_config VirtualIndexFacetingConfigArgs
    The configuration for faceting.
    highlight_and_snippet_config VirtualIndexHighlightAndSnippetConfigArgs
    The configuration for highlight / snippet in index setting.
    languages_config VirtualIndexLanguagesConfigArgs
    The configuration for languages in index setting.
    name str
    Name of the virtual index. Its name should NOT be surrounded with virtual().
    pagination_config VirtualIndexPaginationConfigArgs
    The configuration for pagination in index setting.
    performance_configs Sequence[VirtualIndexPerformanceConfigArgs]
    The configuration for performance in index setting.
    primary_index_name str
    The name of the existing primary index name.
    query_strategy_config VirtualIndexQueryStrategyConfigArgs
    The configuration for query strategy in index setting.
    ranking_config VirtualIndexRankingConfigArgs
    The configuration for ranking.
    timeouts VirtualIndexTimeoutsArgs
    typos_config VirtualIndexTyposConfigArgs
    The configuration for typos in index setting.
    virtual_index_id str
    advancedConfig Property Map
    The configuration for advanced features in index setting.
    attributesConfig Property Map
    The configuration for attributes.
    deletionProtection Boolean
    enablePersonalization Boolean
    Whether to enable the Personalization feature.
    enableRules Boolean
    Whether Rules should be globally enabled.
    facetingConfig Property Map
    The configuration for faceting.
    highlightAndSnippetConfig Property Map
    The configuration for highlight / snippet in index setting.
    languagesConfig Property Map
    The configuration for languages in index setting.
    name String
    Name of the virtual index. Its name should NOT be surrounded with virtual().
    paginationConfig Property Map
    The configuration for pagination in index setting.
    performanceConfigs List<Property Map>
    The configuration for performance in index setting.
    primaryIndexName String
    The name of the existing primary index name.
    queryStrategyConfig Property Map
    The configuration for query strategy in index setting.
    rankingConfig Property Map
    The configuration for ranking.
    timeouts Property Map
    typosConfig Property Map
    The configuration for typos in index setting.
    virtualIndexId String

    Supporting Types

    VirtualIndexAdvancedConfig, VirtualIndexAdvancedConfigArgs

    AttributeCriteriaComputedByMinProximity bool
    When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.
    AttributeForDistinct string
    Name of the de-duplication attribute to be used with the distinct feature.
    Distinct double
    Whether to enable de-duplication or grouping of results.

    • When set to 0, you disable de-duplication and grouping.
    • When set to 1, you enable de-duplication, in which only the most relevant result is returned for all records that have the same value in the distinct attribute. This is similar to the SQL distinct keyword. if distinct is set to 1 (de-duplication):
    • When set to N (where N > 1), you enable grouping, in which most N hits will be returned with the same value for the distinct attribute. then the N most relevant episodes for every show are kept, with similar consequences.
    MaxFacetHits double
    Maximum number of facet hits to return during a search for facet values.
    MinProximity double
    Precision of the proximity ranking criterion.
    ReplaceSynonymsInHighlight bool
    Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
    ResponseFields List<string>
    The fields the response will contain. Applies to search and browse queries. This parameter is mainly intended to limit the response size. For example, in complex queries, echoing of request parameters in the response’s params field can be undesirable.
    AttributeCriteriaComputedByMinProximity bool
    When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.
    AttributeForDistinct string
    Name of the de-duplication attribute to be used with the distinct feature.
    Distinct float64
    Whether to enable de-duplication or grouping of results.

    • When set to 0, you disable de-duplication and grouping.
    • When set to 1, you enable de-duplication, in which only the most relevant result is returned for all records that have the same value in the distinct attribute. This is similar to the SQL distinct keyword. if distinct is set to 1 (de-duplication):
    • When set to N (where N > 1), you enable grouping, in which most N hits will be returned with the same value for the distinct attribute. then the N most relevant episodes for every show are kept, with similar consequences.
    MaxFacetHits float64
    Maximum number of facet hits to return during a search for facet values.
    MinProximity float64
    Precision of the proximity ranking criterion.
    ReplaceSynonymsInHighlight bool
    Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
    ResponseFields []string
    The fields the response will contain. Applies to search and browse queries. This parameter is mainly intended to limit the response size. For example, in complex queries, echoing of request parameters in the response’s params field can be undesirable.
    attributeCriteriaComputedByMinProximity Boolean
    When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.
    attributeForDistinct String
    Name of the de-duplication attribute to be used with the distinct feature.
    distinct Double
    Whether to enable de-duplication or grouping of results.

    • When set to 0, you disable de-duplication and grouping.
    • When set to 1, you enable de-duplication, in which only the most relevant result is returned for all records that have the same value in the distinct attribute. This is similar to the SQL distinct keyword. if distinct is set to 1 (de-duplication):
    • When set to N (where N > 1), you enable grouping, in which most N hits will be returned with the same value for the distinct attribute. then the N most relevant episodes for every show are kept, with similar consequences.
    maxFacetHits Double
    Maximum number of facet hits to return during a search for facet values.
    minProximity Double
    Precision of the proximity ranking criterion.
    replaceSynonymsInHighlight Boolean
    Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
    responseFields List<String>
    The fields the response will contain. Applies to search and browse queries. This parameter is mainly intended to limit the response size. For example, in complex queries, echoing of request parameters in the response’s params field can be undesirable.
    attributeCriteriaComputedByMinProximity boolean
    When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.
    attributeForDistinct string
    Name of the de-duplication attribute to be used with the distinct feature.
    distinct number
    Whether to enable de-duplication or grouping of results.

    • When set to 0, you disable de-duplication and grouping.
    • When set to 1, you enable de-duplication, in which only the most relevant result is returned for all records that have the same value in the distinct attribute. This is similar to the SQL distinct keyword. if distinct is set to 1 (de-duplication):
    • When set to N (where N > 1), you enable grouping, in which most N hits will be returned with the same value for the distinct attribute. then the N most relevant episodes for every show are kept, with similar consequences.
    maxFacetHits number
    Maximum number of facet hits to return during a search for facet values.
    minProximity number
    Precision of the proximity ranking criterion.
    replaceSynonymsInHighlight boolean
    Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
    responseFields string[]
    The fields the response will contain. Applies to search and browse queries. This parameter is mainly intended to limit the response size. For example, in complex queries, echoing of request parameters in the response’s params field can be undesirable.
    attribute_criteria_computed_by_min_proximity bool
    When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.
    attribute_for_distinct str
    Name of the de-duplication attribute to be used with the distinct feature.
    distinct float
    Whether to enable de-duplication or grouping of results.

    • When set to 0, you disable de-duplication and grouping.
    • When set to 1, you enable de-duplication, in which only the most relevant result is returned for all records that have the same value in the distinct attribute. This is similar to the SQL distinct keyword. if distinct is set to 1 (de-duplication):
    • When set to N (where N > 1), you enable grouping, in which most N hits will be returned with the same value for the distinct attribute. then the N most relevant episodes for every show are kept, with similar consequences.
    max_facet_hits float
    Maximum number of facet hits to return during a search for facet values.
    min_proximity float
    Precision of the proximity ranking criterion.
    replace_synonyms_in_highlight bool
    Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
    response_fields Sequence[str]
    The fields the response will contain. Applies to search and browse queries. This parameter is mainly intended to limit the response size. For example, in complex queries, echoing of request parameters in the response’s params field can be undesirable.
    attributeCriteriaComputedByMinProximity Boolean
    When attribute is ranked above proximity in your ranking formula, proximity is used to select which searchable attribute is matched in the attribute ranking stage.
    attributeForDistinct String
    Name of the de-duplication attribute to be used with the distinct feature.
    distinct Number
    Whether to enable de-duplication or grouping of results.

    • When set to 0, you disable de-duplication and grouping.
    • When set to 1, you enable de-duplication, in which only the most relevant result is returned for all records that have the same value in the distinct attribute. This is similar to the SQL distinct keyword. if distinct is set to 1 (de-duplication):
    • When set to N (where N > 1), you enable grouping, in which most N hits will be returned with the same value for the distinct attribute. then the N most relevant episodes for every show are kept, with similar consequences.
    maxFacetHits Number
    Maximum number of facet hits to return during a search for facet values.
    minProximity Number
    Precision of the proximity ranking criterion.
    replaceSynonymsInHighlight Boolean
    Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
    responseFields List<String>
    The fields the response will contain. Applies to search and browse queries. This parameter is mainly intended to limit the response size. For example, in complex queries, echoing of request parameters in the response’s params field can be undesirable.

    VirtualIndexAttributesConfig, VirtualIndexAttributesConfigArgs

    AttributesForFacetings List<string>
    The complete list of attributes that will be used for faceting.
    AttributesToRetrieves List<string>
    List of attributes to be retrieved at query time.
    SearchableAttributes List<string>
    The complete list of attributes used for searching.
    UnretrievableAttributes List<string>
    List of attributes that cannot be retrieved at query time.
    AttributesForFacetings []string
    The complete list of attributes that will be used for faceting.
    AttributesToRetrieves []string
    List of attributes to be retrieved at query time.
    SearchableAttributes []string
    The complete list of attributes used for searching.
    UnretrievableAttributes []string
    List of attributes that cannot be retrieved at query time.
    attributesForFacetings List<String>
    The complete list of attributes that will be used for faceting.
    attributesToRetrieves List<String>
    List of attributes to be retrieved at query time.
    searchableAttributes List<String>
    The complete list of attributes used for searching.
    unretrievableAttributes List<String>
    List of attributes that cannot be retrieved at query time.
    attributesForFacetings string[]
    The complete list of attributes that will be used for faceting.
    attributesToRetrieves string[]
    List of attributes to be retrieved at query time.
    searchableAttributes string[]
    The complete list of attributes used for searching.
    unretrievableAttributes string[]
    List of attributes that cannot be retrieved at query time.
    attributes_for_facetings Sequence[str]
    The complete list of attributes that will be used for faceting.
    attributes_to_retrieves Sequence[str]
    List of attributes to be retrieved at query time.
    searchable_attributes Sequence[str]
    The complete list of attributes used for searching.
    unretrievable_attributes Sequence[str]
    List of attributes that cannot be retrieved at query time.
    attributesForFacetings List<String>
    The complete list of attributes that will be used for faceting.
    attributesToRetrieves List<String>
    List of attributes to be retrieved at query time.
    searchableAttributes List<String>
    The complete list of attributes used for searching.
    unretrievableAttributes List<String>
    List of attributes that cannot be retrieved at query time.

    VirtualIndexFacetingConfig, VirtualIndexFacetingConfigArgs

    MaxValuesPerFacet double
    Maximum number of facet values to return for each facet during a regular search.
    SortFacetValuesBy string
    Parameter to controls how the facet values are sorted within each faceted attribute.
    MaxValuesPerFacet float64
    Maximum number of facet values to return for each facet during a regular search.
    SortFacetValuesBy string
    Parameter to controls how the facet values are sorted within each faceted attribute.
    maxValuesPerFacet Double
    Maximum number of facet values to return for each facet during a regular search.
    sortFacetValuesBy String
    Parameter to controls how the facet values are sorted within each faceted attribute.
    maxValuesPerFacet number
    Maximum number of facet values to return for each facet during a regular search.
    sortFacetValuesBy string
    Parameter to controls how the facet values are sorted within each faceted attribute.
    max_values_per_facet float
    Maximum number of facet values to return for each facet during a regular search.
    sort_facet_values_by str
    Parameter to controls how the facet values are sorted within each faceted attribute.
    maxValuesPerFacet Number
    Maximum number of facet values to return for each facet during a regular search.
    sortFacetValuesBy String
    Parameter to controls how the facet values are sorted within each faceted attribute.

    VirtualIndexHighlightAndSnippetConfig, VirtualIndexHighlightAndSnippetConfigArgs

    AttributesToHighlights List<string>
    List of attributes to highlight.
    AttributesToSnippets List<string>
    List of attributes to snippet, with an optional maximum number of words to snippet.
    HighlightPostTag string
    The HTML string to insert after the highlighted parts in all highlight and snippet results.
    HighlightPreTag string
    The HTML string to insert before the highlighted parts in all highlight and snippet results.
    RestrictHighlightAndSnippetArrays bool
    Restrict highlighting and snippeting to items that matched the query.
    SnippetEllipsisText string
    String used as an ellipsis indicator when a snippet is truncated.
    AttributesToHighlights []string
    List of attributes to highlight.
    AttributesToSnippets []string
    List of attributes to snippet, with an optional maximum number of words to snippet.
    HighlightPostTag string
    The HTML string to insert after the highlighted parts in all highlight and snippet results.
    HighlightPreTag string
    The HTML string to insert before the highlighted parts in all highlight and snippet results.
    RestrictHighlightAndSnippetArrays bool
    Restrict highlighting and snippeting to items that matched the query.
    SnippetEllipsisText string
    String used as an ellipsis indicator when a snippet is truncated.
    attributesToHighlights List<String>
    List of attributes to highlight.
    attributesToSnippets List<String>
    List of attributes to snippet, with an optional maximum number of words to snippet.
    highlightPostTag String
    The HTML string to insert after the highlighted parts in all highlight and snippet results.
    highlightPreTag String
    The HTML string to insert before the highlighted parts in all highlight and snippet results.
    restrictHighlightAndSnippetArrays Boolean
    Restrict highlighting and snippeting to items that matched the query.
    snippetEllipsisText String
    String used as an ellipsis indicator when a snippet is truncated.
    attributesToHighlights string[]
    List of attributes to highlight.
    attributesToSnippets string[]
    List of attributes to snippet, with an optional maximum number of words to snippet.
    highlightPostTag string
    The HTML string to insert after the highlighted parts in all highlight and snippet results.
    highlightPreTag string
    The HTML string to insert before the highlighted parts in all highlight and snippet results.
    restrictHighlightAndSnippetArrays boolean
    Restrict highlighting and snippeting to items that matched the query.
    snippetEllipsisText string
    String used as an ellipsis indicator when a snippet is truncated.
    attributes_to_highlights Sequence[str]
    List of attributes to highlight.
    attributes_to_snippets Sequence[str]
    List of attributes to snippet, with an optional maximum number of words to snippet.
    highlight_post_tag str
    The HTML string to insert after the highlighted parts in all highlight and snippet results.
    highlight_pre_tag str
    The HTML string to insert before the highlighted parts in all highlight and snippet results.
    restrict_highlight_and_snippet_arrays bool
    Restrict highlighting and snippeting to items that matched the query.
    snippet_ellipsis_text str
    String used as an ellipsis indicator when a snippet is truncated.
    attributesToHighlights List<String>
    List of attributes to highlight.
    attributesToSnippets List<String>
    List of attributes to snippet, with an optional maximum number of words to snippet.
    highlightPostTag String
    The HTML string to insert after the highlighted parts in all highlight and snippet results.
    highlightPreTag String
    The HTML string to insert before the highlighted parts in all highlight and snippet results.
    restrictHighlightAndSnippetArrays Boolean
    Restrict highlighting and snippeting to items that matched the query.
    snippetEllipsisText String
    String used as an ellipsis indicator when a snippet is truncated.

    VirtualIndexLanguagesConfig, VirtualIndexLanguagesConfigArgs

    AttributesToTransliterates List<string>
    List of attributes to apply transliteration
    CamelCaseAttributes List<string>
    List of attributes on which to do a decomposition of camel case words.
    CustomNormalization Dictionary<string, string>
    Custom normalization which overrides the engine’s default normalization
    DecompoundQuery bool
    Whether to split compound words into their composing atoms in the query.
    DecompoundedAttributes List<VirtualIndexLanguagesConfigDecompoundedAttribute>
    List of attributes to apply word segmentation, also known as decompounding.
    IgnorePlurals bool
    Whether to treat singular, plurals, and other forms of declensions as matching terms.
    IgnorePluralsFors List<string>
    Whether to treat singular, plurals, and other forms of declensions as matching terms in target languages. List of supported languages are listed on http://nhttps//www.algolia.com/doc/api-reference/api-parameters/ignorePlurals/#usage-notes
    IndexLanguages List<string>
    List of languages at the index level for language-specific processing such as tokenization and normalization.
    KeepDiacriticsOnCharacters string
    List of characters that the engine shouldn’t automatically normalize.
    QueryLanguages List<string>
    List of languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
    RemoveStopWords bool
    Whether to removes stop (common) words from the query before executing it.
    RemoveStopWordsFors List<string>
    List of languages to removes stop (common) words from the query before executing it.
    AttributesToTransliterates []string
    List of attributes to apply transliteration
    CamelCaseAttributes []string
    List of attributes on which to do a decomposition of camel case words.
    CustomNormalization map[string]string
    Custom normalization which overrides the engine’s default normalization
    DecompoundQuery bool
    Whether to split compound words into their composing atoms in the query.
    DecompoundedAttributes []VirtualIndexLanguagesConfigDecompoundedAttribute
    List of attributes to apply word segmentation, also known as decompounding.
    IgnorePlurals bool
    Whether to treat singular, plurals, and other forms of declensions as matching terms.
    IgnorePluralsFors []string
    Whether to treat singular, plurals, and other forms of declensions as matching terms in target languages. List of supported languages are listed on http://nhttps//www.algolia.com/doc/api-reference/api-parameters/ignorePlurals/#usage-notes
    IndexLanguages []string
    List of languages at the index level for language-specific processing such as tokenization and normalization.
    KeepDiacriticsOnCharacters string
    List of characters that the engine shouldn’t automatically normalize.
    QueryLanguages []string
    List of languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
    RemoveStopWords bool
    Whether to removes stop (common) words from the query before executing it.
    RemoveStopWordsFors []string
    List of languages to removes stop (common) words from the query before executing it.
    attributesToTransliterates List<String>
    List of attributes to apply transliteration
    camelCaseAttributes List<String>
    List of attributes on which to do a decomposition of camel case words.
    customNormalization Map<String,String>
    Custom normalization which overrides the engine’s default normalization
    decompoundQuery Boolean
    Whether to split compound words into their composing atoms in the query.
    decompoundedAttributes List<VirtualIndexLanguagesConfigDecompoundedAttribute>
    List of attributes to apply word segmentation, also known as decompounding.
    ignorePlurals Boolean
    Whether to treat singular, plurals, and other forms of declensions as matching terms.
    ignorePluralsFors List<String>
    Whether to treat singular, plurals, and other forms of declensions as matching terms in target languages. List of supported languages are listed on http://nhttps//www.algolia.com/doc/api-reference/api-parameters/ignorePlurals/#usage-notes
    indexLanguages List<String>
    List of languages at the index level for language-specific processing such as tokenization and normalization.
    keepDiacriticsOnCharacters String
    List of characters that the engine shouldn’t automatically normalize.
    queryLanguages List<String>
    List of languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
    removeStopWords Boolean
    Whether to removes stop (common) words from the query before executing it.
    removeStopWordsFors List<String>
    List of languages to removes stop (common) words from the query before executing it.
    attributesToTransliterates string[]
    List of attributes to apply transliteration
    camelCaseAttributes string[]
    List of attributes on which to do a decomposition of camel case words.
    customNormalization {[key: string]: string}
    Custom normalization which overrides the engine’s default normalization
    decompoundQuery boolean
    Whether to split compound words into their composing atoms in the query.
    decompoundedAttributes VirtualIndexLanguagesConfigDecompoundedAttribute[]
    List of attributes to apply word segmentation, also known as decompounding.
    ignorePlurals boolean
    Whether to treat singular, plurals, and other forms of declensions as matching terms.
    ignorePluralsFors string[]
    Whether to treat singular, plurals, and other forms of declensions as matching terms in target languages. List of supported languages are listed on http://nhttps//www.algolia.com/doc/api-reference/api-parameters/ignorePlurals/#usage-notes
    indexLanguages string[]
    List of languages at the index level for language-specific processing such as tokenization and normalization.
    keepDiacriticsOnCharacters string
    List of characters that the engine shouldn’t automatically normalize.
    queryLanguages string[]
    List of languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
    removeStopWords boolean
    Whether to removes stop (common) words from the query before executing it.
    removeStopWordsFors string[]
    List of languages to removes stop (common) words from the query before executing it.
    attributes_to_transliterates Sequence[str]
    List of attributes to apply transliteration
    camel_case_attributes Sequence[str]
    List of attributes on which to do a decomposition of camel case words.
    custom_normalization Mapping[str, str]
    Custom normalization which overrides the engine’s default normalization
    decompound_query bool
    Whether to split compound words into their composing atoms in the query.
    decompounded_attributes Sequence[VirtualIndexLanguagesConfigDecompoundedAttribute]
    List of attributes to apply word segmentation, also known as decompounding.
    ignore_plurals bool
    Whether to treat singular, plurals, and other forms of declensions as matching terms.
    ignore_plurals_fors Sequence[str]
    Whether to treat singular, plurals, and other forms of declensions as matching terms in target languages. List of supported languages are listed on http://nhttps//www.algolia.com/doc/api-reference/api-parameters/ignorePlurals/#usage-notes
    index_languages Sequence[str]
    List of languages at the index level for language-specific processing such as tokenization and normalization.
    keep_diacritics_on_characters str
    List of characters that the engine shouldn’t automatically normalize.
    query_languages Sequence[str]
    List of languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
    remove_stop_words bool
    Whether to removes stop (common) words from the query before executing it.
    remove_stop_words_fors Sequence[str]
    List of languages to removes stop (common) words from the query before executing it.
    attributesToTransliterates List<String>
    List of attributes to apply transliteration
    camelCaseAttributes List<String>
    List of attributes on which to do a decomposition of camel case words.
    customNormalization Map<String>
    Custom normalization which overrides the engine’s default normalization
    decompoundQuery Boolean
    Whether to split compound words into their composing atoms in the query.
    decompoundedAttributes List<Property Map>
    List of attributes to apply word segmentation, also known as decompounding.
    ignorePlurals Boolean
    Whether to treat singular, plurals, and other forms of declensions as matching terms.
    ignorePluralsFors List<String>
    Whether to treat singular, plurals, and other forms of declensions as matching terms in target languages. List of supported languages are listed on http://nhttps//www.algolia.com/doc/api-reference/api-parameters/ignorePlurals/#usage-notes
    indexLanguages List<String>
    List of languages at the index level for language-specific processing such as tokenization and normalization.
    keepDiacriticsOnCharacters String
    List of characters that the engine shouldn’t automatically normalize.
    queryLanguages List<String>
    List of languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
    removeStopWords Boolean
    Whether to removes stop (common) words from the query before executing it.
    removeStopWordsFors List<String>
    List of languages to removes stop (common) words from the query before executing it.

    VirtualIndexLanguagesConfigDecompoundedAttribute, VirtualIndexLanguagesConfigDecompoundedAttributeArgs

    Attributes List<string>
    Language string
    Attributes []string
    Language string
    attributes List<String>
    language String
    attributes string[]
    language string
    attributes Sequence[str]
    language str
    attributes List<String>
    language String

    VirtualIndexPaginationConfig, VirtualIndexPaginationConfigArgs

    HitsPerPage double
    The number of hits per page.
    PaginationLimitedTo double
    The maximum number of hits accessible via pagination
    HitsPerPage float64
    The number of hits per page.
    PaginationLimitedTo float64
    The maximum number of hits accessible via pagination
    hitsPerPage Double
    The number of hits per page.
    paginationLimitedTo Double
    The maximum number of hits accessible via pagination
    hitsPerPage number
    The number of hits per page.
    paginationLimitedTo number
    The maximum number of hits accessible via pagination
    hits_per_page float
    The number of hits per page.
    pagination_limited_to float
    The maximum number of hits accessible via pagination
    hitsPerPage Number
    The number of hits per page.
    paginationLimitedTo Number
    The maximum number of hits accessible via pagination

    VirtualIndexPerformanceConfig, VirtualIndexPerformanceConfigArgs

    VirtualIndexQueryStrategyConfig, VirtualIndexQueryStrategyConfigArgs

    AdvancedSyntax bool
    Whether to enable the advanced query syntax.
    AdvancedSyntaxFeatures List<string>
    Advanced syntax features to be activated when ‘advancedSyntax’ is enabled
    AlternativesAsExacts List<string>
    List of alternatives that should be considered an exact match by the exact ranking criterion.
    DisableExactOnAttributes List<string>
    List of attributes on which you want to disable the exact ranking criterion.
    DisablePrefixOnAttributes List<string>
    List of attributes on which you want to disable prefix matching.
    ExactOnSingleWordQuery string
    Controls how the exact ranking criterion is computed when the query contains only one word.
    OptionalWords List<string>
    A list of words that should be considered as optional when found in the query.
    QueryType string
    Query type to control if and how query words are interpreted as prefixes.
    RemoveWordsIfNoResults string
    Strategy to remove words from the query when it doesn’t match any hits.
    AdvancedSyntax bool
    Whether to enable the advanced query syntax.
    AdvancedSyntaxFeatures []string
    Advanced syntax features to be activated when ‘advancedSyntax’ is enabled
    AlternativesAsExacts []string
    List of alternatives that should be considered an exact match by the exact ranking criterion.
    DisableExactOnAttributes []string
    List of attributes on which you want to disable the exact ranking criterion.
    DisablePrefixOnAttributes []string
    List of attributes on which you want to disable prefix matching.
    ExactOnSingleWordQuery string
    Controls how the exact ranking criterion is computed when the query contains only one word.
    OptionalWords []string
    A list of words that should be considered as optional when found in the query.
    QueryType string
    Query type to control if and how query words are interpreted as prefixes.
    RemoveWordsIfNoResults string
    Strategy to remove words from the query when it doesn’t match any hits.
    advancedSyntax Boolean
    Whether to enable the advanced query syntax.
    advancedSyntaxFeatures List<String>
    Advanced syntax features to be activated when ‘advancedSyntax’ is enabled
    alternativesAsExacts List<String>
    List of alternatives that should be considered an exact match by the exact ranking criterion.
    disableExactOnAttributes List<String>
    List of attributes on which you want to disable the exact ranking criterion.
    disablePrefixOnAttributes List<String>
    List of attributes on which you want to disable prefix matching.
    exactOnSingleWordQuery String
    Controls how the exact ranking criterion is computed when the query contains only one word.
    optionalWords List<String>
    A list of words that should be considered as optional when found in the query.
    queryType String
    Query type to control if and how query words are interpreted as prefixes.
    removeWordsIfNoResults String
    Strategy to remove words from the query when it doesn’t match any hits.
    advancedSyntax boolean
    Whether to enable the advanced query syntax.
    advancedSyntaxFeatures string[]
    Advanced syntax features to be activated when ‘advancedSyntax’ is enabled
    alternativesAsExacts string[]
    List of alternatives that should be considered an exact match by the exact ranking criterion.
    disableExactOnAttributes string[]
    List of attributes on which you want to disable the exact ranking criterion.
    disablePrefixOnAttributes string[]
    List of attributes on which you want to disable prefix matching.
    exactOnSingleWordQuery string
    Controls how the exact ranking criterion is computed when the query contains only one word.
    optionalWords string[]
    A list of words that should be considered as optional when found in the query.
    queryType string
    Query type to control if and how query words are interpreted as prefixes.
    removeWordsIfNoResults string
    Strategy to remove words from the query when it doesn’t match any hits.
    advanced_syntax bool
    Whether to enable the advanced query syntax.
    advanced_syntax_features Sequence[str]
    Advanced syntax features to be activated when ‘advancedSyntax’ is enabled
    alternatives_as_exacts Sequence[str]
    List of alternatives that should be considered an exact match by the exact ranking criterion.
    disable_exact_on_attributes Sequence[str]
    List of attributes on which you want to disable the exact ranking criterion.
    disable_prefix_on_attributes Sequence[str]
    List of attributes on which you want to disable prefix matching.
    exact_on_single_word_query str
    Controls how the exact ranking criterion is computed when the query contains only one word.
    optional_words Sequence[str]
    A list of words that should be considered as optional when found in the query.
    query_type str
    Query type to control if and how query words are interpreted as prefixes.
    remove_words_if_no_results str
    Strategy to remove words from the query when it doesn’t match any hits.
    advancedSyntax Boolean
    Whether to enable the advanced query syntax.
    advancedSyntaxFeatures List<String>
    Advanced syntax features to be activated when ‘advancedSyntax’ is enabled
    alternativesAsExacts List<String>
    List of alternatives that should be considered an exact match by the exact ranking criterion.
    disableExactOnAttributes List<String>
    List of attributes on which you want to disable the exact ranking criterion.
    disablePrefixOnAttributes List<String>
    List of attributes on which you want to disable prefix matching.
    exactOnSingleWordQuery String
    Controls how the exact ranking criterion is computed when the query contains only one word.
    optionalWords List<String>
    A list of words that should be considered as optional when found in the query.
    queryType String
    Query type to control if and how query words are interpreted as prefixes.
    removeWordsIfNoResults String
    Strategy to remove words from the query when it doesn’t match any hits.

    VirtualIndexRankingConfig, VirtualIndexRankingConfigArgs

    CustomRankings List<string>
    List of attributes for custom ranking criterion.
    Rankings List<string>
    List of ranking criteria.
    RelevancyStrictness double
    Relevancy threshold below which less relevant results aren’t included in the results
    CustomRankings []string
    List of attributes for custom ranking criterion.
    Rankings []string
    List of ranking criteria.
    RelevancyStrictness float64
    Relevancy threshold below which less relevant results aren’t included in the results
    customRankings List<String>
    List of attributes for custom ranking criterion.
    rankings List<String>
    List of ranking criteria.
    relevancyStrictness Double
    Relevancy threshold below which less relevant results aren’t included in the results
    customRankings string[]
    List of attributes for custom ranking criterion.
    rankings string[]
    List of ranking criteria.
    relevancyStrictness number
    Relevancy threshold below which less relevant results aren’t included in the results
    custom_rankings Sequence[str]
    List of attributes for custom ranking criterion.
    rankings Sequence[str]
    List of ranking criteria.
    relevancy_strictness float
    Relevancy threshold below which less relevant results aren’t included in the results
    customRankings List<String>
    List of attributes for custom ranking criterion.
    rankings List<String>
    List of ranking criteria.
    relevancyStrictness Number
    Relevancy threshold below which less relevant results aren’t included in the results

    VirtualIndexTimeouts, VirtualIndexTimeoutsArgs

    Default string
    Default string
    default_ String
    default string
    default String

    VirtualIndexTyposConfig, VirtualIndexTyposConfigArgs

    AllowTyposOnNumericTokens bool
    Whether to allow typos on numbers (“numeric tokens”) in the query str
    DisableTypoToleranceOnAttributes List<string>
    List of attributes on which you want to disable typo tolerance.
    DisableTypoToleranceOnWords List<string>
    List of words on which typo tolerance will be disabled.
    MinWordSizeFor1Typo double
    Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
    MinWordSizeFor2Typos double
    Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
    SeparatorsToIndex string
    Separators (punctuation characters) to index. By default, separators are not indexed.
    TypoTolerance string
    Whether typo tolerance is enabled and how it is applied
    AllowTyposOnNumericTokens bool
    Whether to allow typos on numbers (“numeric tokens”) in the query str
    DisableTypoToleranceOnAttributes []string
    List of attributes on which you want to disable typo tolerance.
    DisableTypoToleranceOnWords []string
    List of words on which typo tolerance will be disabled.
    MinWordSizeFor1Typo float64
    Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
    MinWordSizeFor2Typos float64
    Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
    SeparatorsToIndex string
    Separators (punctuation characters) to index. By default, separators are not indexed.
    TypoTolerance string
    Whether typo tolerance is enabled and how it is applied
    allowTyposOnNumericTokens Boolean
    Whether to allow typos on numbers (“numeric tokens”) in the query str
    disableTypoToleranceOnAttributes List<String>
    List of attributes on which you want to disable typo tolerance.
    disableTypoToleranceOnWords List<String>
    List of words on which typo tolerance will be disabled.
    minWordSizeFor1Typo Double
    Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
    minWordSizeFor2Typos Double
    Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
    separatorsToIndex String
    Separators (punctuation characters) to index. By default, separators are not indexed.
    typoTolerance String
    Whether typo tolerance is enabled and how it is applied
    allowTyposOnNumericTokens boolean
    Whether to allow typos on numbers (“numeric tokens”) in the query str
    disableTypoToleranceOnAttributes string[]
    List of attributes on which you want to disable typo tolerance.
    disableTypoToleranceOnWords string[]
    List of words on which typo tolerance will be disabled.
    minWordSizeFor1Typo number
    Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
    minWordSizeFor2Typos number
    Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
    separatorsToIndex string
    Separators (punctuation characters) to index. By default, separators are not indexed.
    typoTolerance string
    Whether typo tolerance is enabled and how it is applied
    allow_typos_on_numeric_tokens bool
    Whether to allow typos on numbers (“numeric tokens”) in the query str
    disable_typo_tolerance_on_attributes Sequence[str]
    List of attributes on which you want to disable typo tolerance.
    disable_typo_tolerance_on_words Sequence[str]
    List of words on which typo tolerance will be disabled.
    min_word_size_for1_typo float
    Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
    min_word_size_for2_typos float
    Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
    separators_to_index str
    Separators (punctuation characters) to index. By default, separators are not indexed.
    typo_tolerance str
    Whether typo tolerance is enabled and how it is applied
    allowTyposOnNumericTokens Boolean
    Whether to allow typos on numbers (“numeric tokens”) in the query str
    disableTypoToleranceOnAttributes List<String>
    List of attributes on which you want to disable typo tolerance.
    disableTypoToleranceOnWords List<String>
    List of words on which typo tolerance will be disabled.
    minWordSizeFor1Typo Number
    Minimum number of characters a word in the query string must contain to accept matches with 1 typo.
    minWordSizeFor2Typos Number
    Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
    separatorsToIndex String
    Separators (punctuation characters) to index. By default, separators are not indexed.
    typoTolerance String
    Whether typo tolerance is enabled and how it is applied

    Import

    $ pulumi import algolia:index/virtualIndex:VirtualIndex default {{index_name}}

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    algolia k-yomo/terraform-provider-algolia
    License
    Notes
    This Pulumi package is based on the algolia Terraform Provider.
    algolia logo
    algolia 0.6.0 published on Monday, Apr 14, 2025 by k-yomo
    k-yomo/terraform-provider-algolia