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
POSTquerySingleIndex

クエリに一致するオブジェクトを返します。 READMEを参照してください。

ヘッダーパラメータ
X-RapidAPI-HostSTRING
REQUIRED
X-RapidAPI-KeySTRING
REQUIRED
必須パラメータ
apiKeyCREDENTIALS
REQUIREDAlgolia Application Key.
appIdCREDENTIALS
REQUIREDAlgolia Application ID.
indexNameSTRING
REQUIREDInex name to retrieve.
パラメータ(Option)
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.
optionalFiltersLIST
OPTIONALCreate filters for ranking purposes, to rank higher records that contain the filter(s).Example : author:John Doe.
disableExactOnAttributesLIST
OPTIONALList of attributes on which you want to disable computation of the exact ranking criterion.The list must be a subset of the searchableAttributes index setting.searchableAttributes must not be empty nor null for disableExactOnAttributes to be applied.
ruleContextsLIST
OPTIONALEnables contextual rules. Provides a list of contexts for which rules are enabled. Contextual rules matching any of these contexts are eligible, as well as generic rules. When empty, only generic rules are eligible.
allowTyposOnNumericTokensSTRING
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 true.
querySTRING
OPTIONALThe instant-search query string, all words of the query are interpreted as prefixes (for example “John Mc” will match “John Mccamey” and “Johnathan Mccamey”). If no query parameter is set, retrieves all objects.
queryTypeSELECT
OPTIONALSelects how the query words are interpreted: `prefixAll`, `prefixLast`, `prefixNone`
typoToleranceSELECT
OPTIONALThis setting has four different options: `true` (default), `false`, `min`: keep only results with the lowest number of typo, `strict`: if there is a match without typo, then all results with 2 typos or more will be removed.
minWordSizefor2TyposNUMBER
OPTIONALThe minimum number of characters in a query word to accept two typos in this word. Defaults to 8.
restrictSearchableAttributesSTRING
OPTIONALList of attributes you want to use for textual search
advancedSyntaxSELECT
OPTIONALEnable the advanced query syntax. Defaults to 0 (false).
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.
minWordSizefor1TypoNUMBER
OPTIONALThe minimum number of characters in a query word to accept one typo in this word. Defaults to 4.
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.
analyticsSELECT
OPTIONALIf set to false, this query will not be taken into account for the Analytics. Defaults to true.
synonymsSELECT
OPTIONALIf set to false, this query will not use synonyms defined in configuration. Defaults to true.
analyticsTagsSTRING
OPTIONALComma-separated string list. If set, tag your query with the specified identifiers. Tags can then be used in the Analytics to analyze a subset of searches only.
minProximityNUMBER
OPTIONALConfigure the precision of the proximity ranking criterion. See README for more info.
removeWordsIfNoResultsSELECT
OPTIONALConfigure the way query words are removed when the query doesn’t retrieve any results. See README for more info.
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`.
removeStopWordsSTRING
OPTIONALRemove stop words from the query before executing it.Boolean or comma-separated string list. See README for more info
disableTypoToleranceOnAttributesSTRING
OPTIONALList of attributes on which you want to disable typo tolerance
offsetNUMBER
OPTIONALSpecify the offset of the first hit to return.Instead of page/hitsPerPage, you can use offset/length to specify the number of hits you want to retrieve and from which offset you want to start.
pageNUMBER
OPTIONALPagination parameter used to select the page to retrieve. Page is zero-based and defaults to 0. Thus, to retrieve the 10th page you need to set page=9
lengthNUMBER
OPTIONALSet the number of hits to retrieve (used only with offset).Instead of page/hitsPerPage, you can use offset/length to specify the number of hits you want to retrieve and from which offset you want to start.
hitsPerPageNUMBER
OPTIONALPagination parameter used to select the number of hits per page. Defaults to 20.
getRankingInfoNUMBER
OPTIONALIf set to 1, the result hits will contain ranking information in _rankingInfo attribute.
attributesToSnippetSTRING
OPTIONALList of attributes to snippet alongside the number of words to return. See README for more info.
highlightPreTagSTRING
OPTIONALSpecify the string that is inserted before the highlighted parts in the query result (defaults to `<em>`).
attributesToRetrieveSTRING
OPTIONALList of object attributes you want to retrieve (let you minimize the answer size). See README for more info.
facetFiltersSTRING
OPTIONALFilter the query by a list of facets. Facets are separated by commas and each facet is encoded as attributeName:value. See README for more info.
filtersSTRING
OPTIONALFilter the query with numeric, facet or/and tag filters. The syntax is a SQL like syntax, you can use the OR and AND keywords. See README for more info.
responseFieldsSTRING
OPTIONALComma-separated string list. See README for more info.
numericFiltersSTRING
OPTIONALThe list of numeric filters you want to apply separated by a comma. See README for more info.
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.
facetsSTRING
OPTIONALList of object attributes that you want to use for faceting. Attributes are separated with a comma. See README for more info.
aroundPrecisionNUMBER
OPTIONALControl the precision of a aroundLatLng query. In meter. For example if you set aroundPrecision=100, two objects that are in the range 0-99m will be considered as identical in the ranking for the .variable geo ranking parameter (same for 100-199, 200-299, … ranges).
minimumAroundRadiusNUMBER
OPTIONALDefine the minimum radius used for aroundLatLng or aroundLatLngViaIP when aroundRadius is not set. The radius is computed automatically using the density of the area. You can retrieve the computed radius in the automaticRadius attribute of the answer.
insidePolygonSTRING
OPTIONALSearch entries inside a given area defined by a set of points (defined by a minimum of 6 floats. See README for more info.
tagFiltersSTRING
OPTIONALFilter the query by a set of tags. You can AND tags by separating them by commas. See README for more info.
aroundLatLngSTRING
OPTIONALSearch for entries around a given latitude/longitude (specified as two floats separated by a comma. See README for more info.
highlightPostTagSTRING
OPTIONALSpecify the string that is inserted after the highlighted parts in the query result (defaults to `</em>`
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.
insideBoundingBoxSTRING
OPTIONALSearch for entries inside a given area defined by the two extreme points of a rectangle. See README for more info.
aroundRadiusSTRING
OPTIONALControl the radius associated with a aroundLatLng or aroundLatLngViaIP query.
snippetEllipsisTextSTRING
OPTIONALString used as an ellipsis indicator when a snippet is truncated (defaults to empty).
attributesToHighlightSTRING
OPTIONALList of attributes you want to highlight according to the query. Attributes are separated by a comma. See README for more info.
aroundLatLngViaIPSELECT
OPTIONALSearch for entries around a given location automatically computed from the requester’s IP address.
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.
facetingAfterDistinctSELECT
OPTIONALForce faceting to be applied after de-duplication. See README for more info.
restrictHighlightAndSnippetArraysSELECT
OPTIONALRestrict arrays in highlight and snippet results to items that matched the query.
sumOrFiltersScoresSELECT
OPTIONALDetermines how to calculate the total score for filtering. 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.
maxFacetHitsNUMBER
OPTIONALMaximum number of facet hits to return during a search for facet values.See more in readme.
percentileComputationSELECT
OPTIONALWhether to include the query in processing time percentile computation.See more in readme.
コードスニペット
SDKをインストール
レスポンス例

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

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