editSettings
You can have up to 100 configurations per Algolia application.
Usage
// Initialize the client
var client = new QuerySuggestionsClient(
new QuerySuggestionsConfig(
"ALGOLIA_APPLICATION_ID",
"ALGOLIA_API_KEY",
"ALGOLIA_APPLICATION_REGION"
)
);
// Call the API
var response = await client.CreateConfigAsync(
new ConfigurationWithIndex
{
IndexName = "<YOUR_INDEX_NAME>",
SourceIndices = new List<SourceIndex>
{
new SourceIndex
{
IndexName = "<YOUR_INDEX_NAME>",
Facets = new List<Facet> { new Facet { Attribute = "test" } },
Generate = new List<List<string>>
{
new List<string> { "facetA", "facetB" },
new List<string> { "facetC" },
},
},
},
Languages = new Languages(new List<string> { "french" }),
Exclude = new List<string> { "test" },
}
);
// print the response
Console.WriteLine(response);
// Initialize the client with your application region, eg. suggestions.ALGOLIA_APPLICATION_REGION
client, err := suggestions.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", suggestions.US)
if err != nil {
// The client can fail to initialize if you pass an invalid parameter.
panic(err)
}
// Call the API
response, err := client.CreateConfig(client.NewApiCreateConfigRequest(
suggestions.NewEmptyConfigurationWithIndex().SetIndexName("<YOUR_INDEX_NAME>").SetSourceIndices(
[]suggestions.SourceIndex{*suggestions.NewEmptySourceIndex().SetIndexName("<YOUR_INDEX_NAME>").SetFacets(
[]suggestions.Facet{*suggestions.NewEmptyFacet().SetAttribute("test")}).SetGenerate(
[][]string{
{"facetA", "facetB"},
{"facetC"},
})}).SetLanguages(suggestions.ArrayOfStringAsLanguages(
[]string{"french"})).SetExclude(
[]string{"test"})))
if err != nil {
// handle the eventual error
panic(err)
}
// print the response
print(response)
// Initialize the client
QuerySuggestionsClient client = new QuerySuggestionsClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION");
// Call the API
BaseResponse response = client.createConfig(
new ConfigurationWithIndex()
.setIndexName("<YOUR_INDEX_NAME>")
.setSourceIndices(
Arrays.asList(
new SourceIndex()
.setIndexName("<YOUR_INDEX_NAME>")
.setFacets(Arrays.asList(new Facet().setAttribute("test")))
.setGenerate(Arrays.asList(Arrays.asList("facetA", "facetB"), Arrays.asList("facetC")))
)
)
.setLanguages(Languages.of(Arrays.asList("french")))
.setExclude(Arrays.asList("test"))
);
// print the response
System.out.println(response);
// Initialize the client
// Replace 'us' with your Algolia Application Region
const client = algoliasearch('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY').initQuerySuggestions({ region: 'us' });
// Call the API
const response = await client.createConfig({
indexName: 'theIndexName',
sourceIndices: [
{ indexName: 'testIndex', facets: [{ attribute: 'test' }], generate: [['facetA', 'facetB'], ['facetC']] },
],
languages: ['french'],
exclude: ['test'],
});
// print the response
console.log(response);
// Initialize the client
val client =
QuerySuggestionsClient(
appId = "ALGOLIA_APPLICATION_ID",
apiKey = "ALGOLIA_API_KEY",
region = "ALGOLIA_APPLICATION_REGION",
)
// Call the API
var response =
client.createConfig(
configurationWithIndex =
ConfigurationWithIndex(
indexName = "<YOUR_INDEX_NAME>",
sourceIndices =
listOf(
SourceIndex(
indexName = "<YOUR_INDEX_NAME>",
facets = listOf(Facet(attribute = "test")),
generate = listOf(listOf("facetA", "facetB"), listOf("facetC")),
)
),
languages = Languages.of(listOf("french")),
exclude = listOf("test"),
)
)
// print the response
println(response)
// Initialize the client
$client = QuerySuggestionsClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY', 'ALGOLIA_APPLICATION_REGION');
// Call the API
$response = $client->createConfig(
['indexName' => '<YOUR_INDEX_NAME>',
'sourceIndices' => [
['indexName' => '<YOUR_INDEX_NAME>',
'facets' => [
['attribute' => 'test',
],
],
'generate' => [
[
'facetA',
'facetB',
],
[
'facetC',
],
],
],
],
'languages' => [
'french',
],
'exclude' => [
'test',
],
],
);
// print the response
var_dump($response);
# Initialize the client
# In an asynchronous context, you can use QuerySuggestionsClient instead, which exposes the exact same methods.
client = QuerySuggestionsClientSync(
"ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY", "ALGOLIA_APPLICATION_REGION"
)
# Call the API
response = client.create_config(
configuration_with_index={
"indexName": "<YOUR_INDEX_NAME>",
"sourceIndices": [
{
"indexName": "<YOUR_INDEX_NAME>",
"facets": [
{
"attribute": "test",
},
],
"generate": [
[
"facetA",
"facetB",
],
[
"facetC",
],
],
},
],
"languages": [
"french",
],
"exclude": [
"test",
],
},
)
# print the response
print(response)
# Initialize the client
client = Algolia::QuerySuggestionsClient.create(
"ALGOLIA_APPLICATION_ID",
"ALGOLIA_API_KEY",
"ALGOLIA_APPLICATION_REGION"
)
# Call the API
response = client.create_config(
Algolia::QuerySuggestions::ConfigurationWithIndex.new(
index_name: "<YOUR_INDEX_NAME>",
source_indices: [
Algolia::QuerySuggestions::SourceIndex.new(
index_name: "<YOUR_INDEX_NAME>",
facets: [Algolia::QuerySuggestions::Facet.new(attribute: "test")],
generate: [["facetA", "facetB"], ["facetC"]]
)
],
languages: ["french"],
exclude: ["test"]
)
)
# print the response
puts(response)
// Initialize the client
val client = QuerySuggestionsClient(
appId = "ALGOLIA_APPLICATION_ID",
apiKey = "ALGOLIA_API_KEY",
region = "ALGOLIA_APPLICATION_REGION"
)
// Call the API
val response = Await.result(
client.createConfig(
configurationWithIndex = ConfigurationWithIndex(
indexName = "<YOUR_INDEX_NAME>",
sourceIndices = Seq(
SourceIndex(
indexName = "<YOUR_INDEX_NAME>",
facets = Some(
Seq(
Facet(
attribute = Some("test")
)
)
),
generate = Some(Seq(Seq("facetA", "facetB"), Seq("facetC")))
)
),
languages = Some(Languages(Seq("french"))),
exclude = Some(Seq("test"))
)
),
Duration(100, "sec")
)
// print the response
println(response)
// Initialize the client
let client = try QuerySuggestionsClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY", region: .us)
// Call the API
let response = try await client.createConfig(configurationWithIndex: ConfigurationWithIndex(
sourceIndices: [SourceIndex(
indexName: "<YOUR_INDEX_NAME>",
facets: [Facet(attribute: "test")],
generate: [["facetA", "facetB"], ["facetC"]]
)],
languages: QuerySuggestionsLanguages.arrayOfString(["french"]),
exclude: ["test"],
indexName: "<YOUR_INDEX_NAME>"
))
// print the response
print(response)
See the full API reference
For more details about input parameters
and response fields.