Get settings

This is documentation for v3 of the PHP API clients, which is not the latest version. To see the documentation for the latest version, see PHP v4.

This is documentation for v2 of the Ruby API clients, which is not the latest version. To see the documentation for the latest version, see Ruby v3.

This is documentation for v4 of the JavaScript API clients, which is not the latest version. To see the documentation for the latest version, see JavaScript v5.

This is documentation for v3 of the Python API clients, which is not the latest version. To see the documentation for the latest version, see Python v4.

This is documentation for v8 of the Swift API clients, which is not the latest version. To see the documentation for the latest version, see Swift v9.

This is documentation for v2 of the Kotlin API clients, which is not the latest version. To see the documentation for the latest version, see Kotlin v3.

This is documentation for v6 of the C# API clients, which is not the latest version. To see the documentation for the latest version, see C# v7.

This is documentation for v3 of the Java API clients, which is not the latest version. To see the documentation for the latest version, see Java v4.

This is documentation for v3 of the Go API clients, which is not the latest version. To see the documentation for the latest version, see Go v4.

This is documentation for v1 of the Scala API clients, which is not the latest version. To see the documentation for the latest version, see Scala v2.

$index->getSettings()

index.get_settings()

index.getSettings()

index.getSettings({
  // Any other requestOptions
})

index.get_settings()

index.getSettings(
  requestOptions: RequestOptions? = nil,
  completion: Result<Settings> -> Void
)

suspend fun Index.getSettings(
    requestOptions: RequestOptions? = null
): Settings

index.GetSettings()

index.getSettings()

index.GetSettings()

settings.of("myIndex")

1
2
$settings = $index->getSettings();
var_dump($settings);

1
2
settings = index.get_settings
puts settings.to_json

1
2
3
index.getSettings().then(settings => {
  console.log(settings);
});

1
2
settings = index.get_settings()
print(settings)

1
2
3
4
5
index.getSettings { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
val settings = index.getSettings()
println(settings)

1
2
3
4
IndexSettings settings = index.GetSettings();

// Asynchronous
IndexSettings settings = await index.GetSettingsAsync();

1
2
3
4
IndexSettings settings = index.getSettings();

//Asynchronous
CompletableFuture<IndexSettings> settings = index.getSettingsAsync();

1
settings, err := index.GetSettings()

1
2
3
val result: Future[IndexSettings] = client.execute {
  settings of "myIndex"
}

1
algolia settings get <INDEX>

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
{
  "minWordSizefor1Typo": 4,
  "minWordSizefor2Typos": 8,
  "hitsPerPage": 20,
  "maxValuesPerFacet": 100,
  "searchableAttributes": [
    "title",
    "description",
    "author_name"
  ],
  "numericAttributesToIndex": null,
  "attributesToRetrieve": null,
  "unretrievableAttributes": null,
  "optionalWords": null,
  "attributesForFaceting": null,
  "attributesToSnippet": null,
  "attributesToHighlight": null,
  "paginationLimitedTo": 1000,
  "attributeForDistinct": null,
  "exactOnSingleWordQuery": "attribute",
  "ranking": [
    "typo",
    "geo",
    "words",
    "filters",
    "proximity",
    "attribute",
    "exact",
    "custom"
  ],
  "customRanking": null,
  "separatorsToIndex": "",
  "removeWordsIfNoResults": "none",
  "queryType": "prefixLast",
  "highlightPreTag": "<em>",
  "highlightPostTag": "<\/em>",
  "alternativesAsExact": [
    "ignorePlurals",
    "singleWordSynonym"
  ]
}