Algolia

フリー
開発者 dimas
更新日 10ヶ月前
検索
-/10
人気度
-
レイテンシ
-
正常稼働率

「Algolia 」のドキュメント

あなたのアプリにオートコンプリート機能を追加する

全文を表示する
POSTaddGlobalApiKey
POSTaddIndexSpecificApiKey
POSTaddSingleObjectToIndex
POSTbatchObjectsWrite
POSTbatchSynonymsWriteOperations
POSTbatchWriteOperations
POSTchangeIndexSettings
POSTclearSingleIndex
POSTcopySingleIndex
POSTcreateAlternativeCorrectionSynonymSet
POSTcreateOneWaySynonymSet
POSTcreatePlaceholderSynonymSet
POSTcreateRegularSynonymSet
POSTdeleteAllSynonyms
POSTdeleteGlobalApiKey
POSTdeleteIndexSpecificApiKey
POSTdeleteRecordByQuery
POSTdeleteSingleIndex
POSTdeleteSingleObject
POSTdeleteSingleSynonymsSet
POSTgetGlobalApiKeyRights
POSTgetGlobalApiKeys
POSTgetIndexApiKeysForAllIndexes
POSTgetIndexContent
POSTgetIndexSettings
POSTgetIndexSpecificApiKeyRights
POSTgetIndexSpecificApiKeys
POSTgetIndexes
POSTgetLogs
POSTgetObjects
POSTgetSingleObject
POSTgetSingleSynonymsSet
POSTgetTaskStatus
POSTmoveSingleIndex
POSTpartiallyUpdateObject
POSTquerySingleIndex
POSTsearchFacetValues
POSTsearchMultipleIndexes
POSTsearchSynonyms
POSTupdateAlternativeCorrectionSynonymSet
POSTupdateGlobalApiKey
POSTupdateIndexSpecificApiKey
POSTupdateOneWaySynonymSet
POSTupdatePlaceholderSynonymSet
POSTupdateRegularSynonymSet
POSTupdateSingleObject
POSTchangeIndexSettings

このメソッドは、インデックス設定の一部を更新し、属性のリストとその動作はget index settings APIにリストがあります。

ヘッダーパラメータ
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
必須パラメータ
indexNameSTRING
REQUIREDIndex name to retrieve settings for.
apiKeyCREDENTIALS
REQUIREDAlgolia Application Key.
appIdCREDENTIALS
REQUIREDAlgolia Application ID.
パラメータ(Option)
attributesToIndexLIST
OPTIONALList of Strings. The list of fields you want to index. If set to null, all textual attributes of your objects are indexed, but you should update it to get optimal results. See README for more info.
attributesForFacetingLIST
OPTIONALThe list of fields you want to use for faceting. All strings in the attribute selected for faceting are extracted and added as a facet. By default, no attribute is used for faceting.
rankingLIST
OPTIONALLink of Strings. Controls the way results are sorted. See README for more info.
customRankingLIST
OPTIONALList of Strings. Lets you specify part of the ranking. The syntax of this condition is an array of strings containing attributes prefixed by asc (ascending order) or desc (descending order) operator. For example: `customRanking`: [`desc(population)`, `asc(name)`]
disableTypoToleranceOnWordsLIST
OPTIONALList of String. Specify a list of words on which the automatic typo tolerance will be disabled.
optionalWordsLIST
OPTIONALList of Strings. Specify a list of words that should be considered as optional when found in the query
alternativesAsExactLIST
OPTIONALSpecify the list of approximation that should be considered as an exact match in the ranking formula. See README for more info.
enableRulesSELECT
OPTIONALWhether rules should be globally enabled. This is a global switch that affects all rules. When true, rules processing is enabled: rules may match the query. When false, rules processing is disabled: no rule will match the query.
camelCaseAttributesSTRING
OPTIONALComma-separated list of attributes on which to do a decomposition of camel case words.See more in readme.
forwardToSlavesSELECT
OPTIONALIf this parameter is true, the change is also applied on slaves of this index.
removeWordsIfNoResultsSELECT
OPTIONALConfigure the way query words are removed when the query doesn’t retrieve any results. See README for more info.
responseFieldsSTRING
OPTIONALComma-separated string list. See README for more info.
paginationLimitedToNUMBER
OPTIONALSet the maximum number of hits accessible via pagination. This can be set at indexing time, to define a default. The index value can also be overidden at query time. By default, this parameter is set to 1000 to guarantee good performance.
maxFacetHitsNUMBER
OPTIONALMaximum number of facet hits to return during a search for facet values.See more in readme.
sortFacetValuesBySELECT
OPTIONALWhen using facets, Algolia retrieves a list of matching facet values for each faceted attribute. This parameter controls how the facet values are sorted within each faceted attribute. See README for more info.
restrictHighlightAndSnippetArraysSELECT
OPTIONALRestrict arrays in highlight and snippet results to items that matched the query.
numericAttributesToIndexJSON
OPTIONALAll numerical attributes are automatically indexed as numerical filters. If you don’t need filtering on some of your numerical attributes, please consider sending them as strings to speed up the indexing. If you only need to filter on a numeric value with the operator = or !=, you can speed up the indexing by specifying the attribute with equalOnly(AttributeName). The other operators will be disabled.
attributeForDistinctSTRING
OPTIONALThe attribute name used for the Distinct feature. This feature is similar to the SQL “distinct” keyword: when enabled in query with the distinct=1 parameter, all hits containing a duplicate value for this attribute are removed from results. For example, if the chosen attribute is show_name and several hits have the same value for show_name, then only the best one is kept and others are removed.
slavesJSON
OPTIONALJSON Array of String. The list of indexes on which you want to replicate all write operations. In order to get response times in milliseconds, we pre-compute part of the ranking during indexing. If you want to use different ranking configurations depending of the use-case, you need to create one index per ranking configuration. This option enables you to perform write operations only on this index, and to automatically update slave indexes with the same operations.
altCorrectionsJSON
OPTIONALSpecify alternative corrections that you want to consider. See README for more info.
placeholdersJSON
OPTIONALJSON Hash. This is an advanced use case to define a token substitutable by a list of words without having the original token searchable. See README for more info.
separatorsToIndexSTRING
OPTIONALSpecify the separators (punctuation characters) to index. By default, separators are not indexed. Use `+#` to be able to search Google+ or C#.
unretrievableAttributesJSON
OPTIONALJSON Array Of Strings. List of attributes that cannot be retrieved at query time. This feature allows you to have an attribute that is used for indexing and/or ranking but which cannot be retrieved. This setting will be bypassed if the query is done with the ADMIN API key. Defaults to null.
allowCompressionOfIntegerArraySELECT
OPTIONALAllows compression of big integer arrays. We recommended to store the list of user ID or rights as an integer array and enable this setting. When enabled the integer array are reordered to reach a better compression ratio. Defaults to false.
attributesToSnippetJSON
OPTIONALJSON Array of Strings. Default list of attributes to snippet alongside the number of words to return (syntax is ‘attributeName:nbWords’). If set to null, no snippet is computed.
minWordSizefor1TypoNUMBER
OPTIONALThe minimum number of characters to accept one typo (default = 4).
disableExactOnAttributesJSON
OPTIONALJSON Array of String. List of attributes on which you want to disable the computation of “exact” criteria (must be a subset of the attributesToIndex index setting). By default the list is empty.
hitsPerPageNUMBER
OPTIONALThe number of hits per page (default = 10).
disablePrefixOnAttributesJSON
OPTIONALJSON Array of Strings.List of attributes on which you want to disable prefix matching
disableTypoToleranceOnAttributesJSON
OPTIONALJSON Array of Strings. List of attributes on which you want to disable typo tolerance (must be a subset of the attributesToIndex index setting). By default the list is empty.
highlightPreTagSTRING
OPTIONALSpecify the string that is inserted before the highlighted parts in the query result (defaults to `<em>`).
queryTypeSELECT
OPTIONALSelect how the query words are interpreted, it can be one of the following value: `prefixAll`, `prefixLast`, `prefixNone`.
minWordSizefor2TyposNUMBER
OPTIONALThe minimum number of characters to accept two typos (default = 8).
attributesToRetrieveJSON
OPTIONALJSON Array of String. Default list of attributes to retrieve in objects. If set to null, all attributes are retrieved.
attributesToHighlightJSON
OPTIONALJSON Array of String. Default list of attributes to highlight. If set to null, all indexed attributes are highlighted.
highlightPostTagSTRING
OPTIONALSpecify the string that is inserted after the highlighted parts in the query result (defaults to `</em>`).
advancedSyntaxSELECT
OPTIONALEnable the advanced query syntax. Defaults to 0 (false).
removeStopWordsSTRING
OPTIONALRemove stop words from query before executing it. It can be a boolean: enable or disable all 41 supported languages or a string array with the list of languages you have in your record (using language iso code).
distinctNUMBER
OPTIONALEnable the distinct feature (disabled by default) if the attributeForDistinct index setting is set. This feature is similar to the SQL “distinct” keyword: when enabled in a query with the distinct=1 parameter, all hits containing a duplicate value for theattributeForDistinct attribute are removed from results. For example, if the chosen attribute is show_name and several hits have the same value for show_name, then only the best one is kept and others are removed.
maxValuesPerFacetNUMBER
OPTIONALLimit the number of facet values returned for each facet. For example: maxValuesPerFacet=10 will retrieve max 10 values per facet. Defaults to 100.
allowTyposOnNumericTokensSELECT
OPTIONALIf set to false, disable typo-tolerance on numeric tokens (=numbers) in the query word. For example the query `304` will match with `30450`, but not with `40450` that would have been the case with typo-tolerance enabled. Can be very useful on serial numbers and zip codes searches. Defaults to false.
typoToleranceSELECT
OPTIONALThis setting has four different options: `true`, `false`, `min`, `strict`.
snippetEllipsisTextSTRING
OPTIONALString used as an ellipsis indicator when a snippet is truncated. Default: `…` (U+2026 HORIZONTAL ELLIPSIS).
ignorePluralsSELECT
OPTIONALIf set to true, simple plural forms won’t be considered as typos (for example car/cars will be considered as equal). Defaults to false.
replaceSynonymsInHighlightSELECT
OPTIONALIf set to false, words matched via synonyms expansion will not be replaced by the matched synonym in the highlighted result. Defaults to true.
exactOnSingleWordQuerySELECT
OPTIONALThis parameter control how the exact ranking criterion is computed when the query contains one word. There is three different values: `none`, `word`, `attribute`.
minProximityNUMBER
OPTIONALConfigure the precision of the proximity ranking criterion. See README for more info.
コードスニペット
SDKをインストール
レスポンス例

SDKをインストール((Node.js)Unirest)

OAuth2認証
クライアントID
クライアントシークレット
OAuth2認証