mirror of
https://github.com/serverless/serverless.git
synced 2026-01-18 14:58:43 +00:00
588 lines
23 KiB
TypeScript
588 lines
23 KiB
TypeScript
import { AuthModeType } from '@algolia/client-common';
|
||
import { ClientTransporterOptions } from '@algolia/client-common';
|
||
import { Destroyable } from '@algolia/requester-common';
|
||
import { RecommendSearchOptions as RecommendSearchOptions_2 } from '@algolia/recommend';
|
||
import { RequestOptions } from '@algolia/transporter';
|
||
import { SearchOptions } from '@algolia/client-search';
|
||
import { SearchResponse } from '@algolia/client-search';
|
||
import { Transporter } from '@algolia/transporter';
|
||
|
||
export declare type BaseRecommendClient = {
|
||
/**
|
||
* The application id.
|
||
*/
|
||
readonly appId: string;
|
||
/**
|
||
* The underlying transporter.
|
||
*/
|
||
readonly transporter: Transporter;
|
||
/**
|
||
* Mutates the transporter, adding the given user agent.
|
||
*/
|
||
readonly addAlgoliaAgent: (segment: string, version?: string) => void;
|
||
/**
|
||
* Clears both requests and responses caches.
|
||
*/
|
||
readonly clearCache: () => Readonly<Promise<void>>;
|
||
};
|
||
|
||
export declare type FrequentlyBoughtTogetherQuery = Omit<RecommendationsQuery, 'model' | 'fallbackParameters'>;
|
||
|
||
export declare type LookingSimilarQuery = Omit<RecommendationsQuery, 'model'>;
|
||
|
||
declare function recommend(appId: string, apiKey: string, options?: RecommendOptions): RecommendClient;
|
||
|
||
declare namespace recommend {
|
||
var version: string;
|
||
var getFrequentlyBoughtTogether: (base: BaseRecommendClient) => <TObject>(queries: readonly Pick<RecommendationsQuery, "queryParameters" | "objectID" | "indexName" | "threshold" | "maxRecommendations">[], requestOptions?: (RequestOptions_2 & SearchOptions_2) | undefined) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
|
||
var getRecommendations: (base: BaseRecommendClient) => <TObject>(queries: readonly (RecommendationsQuery | (TrendingItemsQuery & {
|
||
readonly model: TrendingModel;
|
||
}) | (TrendingFacetsQuery & {
|
||
readonly model: TrendingModel;
|
||
}) | RecommendedForYouQuery)[], requestOptions?: (RequestOptions_2 & SearchOptions_2) | undefined) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
|
||
var getRelatedProducts: (base: BaseRecommendClient) => <TObject>(queries: readonly Pick<RecommendationsQuery, "queryParameters" | "objectID" | "indexName" | "threshold" | "maxRecommendations" | "fallbackParameters">[], requestOptions?: (RequestOptions_2 & SearchOptions_2) | undefined) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
|
||
var getTrendingFacets: (base: BaseRecommendClient) => <TObject>(queries: readonly TrendingFacetsQuery[], requestOptions?: (RequestOptions_2 & SearchOptions_2) | undefined) => Readonly<Promise<RecommendTrendingFacetsQueriesResponse>>;
|
||
var getTrendingItems: (base: BaseRecommendClient) => <TObject>(queries: readonly TrendingItemsQuery[], requestOptions?: (RequestOptions_2 & SearchOptions_2) | undefined) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
|
||
var getLookingSimilar: (base: BaseRecommendClient) => <TObject>(queries: readonly Pick<RecommendationsQuery, "queryParameters" | "objectID" | "indexName" | "threshold" | "maxRecommendations" | "fallbackParameters">[], requestOptions?: (RequestOptions_2 & SearchOptions_2) | undefined) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
|
||
var getRecommendedForYou: (base: BaseRecommendClient) => <TObject>(queries: readonly Pick<RecommendedForYouQuery, "queryParameters" | "indexName" | "threshold" | "maxRecommendations" | "fallbackParameters">[], requestOptions?: (RequestOptions_2 & SearchOptions_2) | undefined) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
|
||
}
|
||
export default recommend;
|
||
|
||
export declare type RecommendationsQuery = {
|
||
/**
|
||
* The name of the target index.
|
||
*/
|
||
readonly indexName: string;
|
||
/**
|
||
* The name of the Recommendation model to use.
|
||
*/
|
||
readonly model: 'related-products' | 'bought-together' | 'looking-similar';
|
||
/**
|
||
* The `objectID` of the item to get recommendations for.
|
||
*/
|
||
readonly objectID: string;
|
||
/**
|
||
* Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.
|
||
*/
|
||
readonly threshold?: number;
|
||
/**
|
||
* How many recommendations to retrieve.
|
||
*/
|
||
readonly maxRecommendations?: number;
|
||
/**
|
||
* List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
|
||
*/
|
||
readonly queryParameters?: RecommendSearchOptions;
|
||
/**
|
||
* List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
|
||
*
|
||
* Additional filters to use as fallback when there aren’t enough recommendations.
|
||
*/
|
||
readonly fallbackParameters?: RecommendSearchOptions;
|
||
};
|
||
|
||
export declare type RecommendClient = WithRecommendMethods<BaseRecommendClient> & Destroyable;
|
||
|
||
export declare type RecommendClientOptions = {
|
||
/**
|
||
* The application id.
|
||
*/
|
||
readonly appId: string;
|
||
/**
|
||
* The api key.
|
||
*/
|
||
readonly apiKey: string;
|
||
/**
|
||
* The auth mode type. In browser environments credentials may
|
||
* be passed within the headers.
|
||
*/
|
||
readonly authMode?: AuthModeType;
|
||
};
|
||
|
||
/**
|
||
* The parameters used for `getRecommendedForYou` method.
|
||
*/
|
||
export declare type RecommendedForYouParams = Omit<RecommendedForYouQuery, 'model'>;
|
||
|
||
export declare type RecommendedForYouQuery = Omit<RecommendationsQuery, 'model' | 'objectID' | 'queryParameters'> & {
|
||
readonly model: 'recommended-for-you';
|
||
/**
|
||
* List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
|
||
*/
|
||
readonly queryParameters: Omit<RecommendSearchOptions, 'userToken'> & {
|
||
/**
|
||
* A user identifier.
|
||
* Format: alpha numeric string [a-zA-Z0-9_-]
|
||
* Length: between 1 and 64 characters.
|
||
*/
|
||
readonly userToken: string;
|
||
};
|
||
};
|
||
|
||
export declare type RecommendModel = 'related-products' | 'bought-together' | 'looking-similar' | 'recommended-for-you' | TrendingModel;
|
||
|
||
export declare type RecommendOptions = Partial<ClientTransporterOptions>;
|
||
|
||
export declare type RecommendQueriesResponse<TObject> = {
|
||
/**
|
||
* The list of results.
|
||
*/
|
||
readonly results: ReadonlyArray<SearchResponse<TObject>>;
|
||
};
|
||
|
||
export declare type RecommendSearchOptions = Omit<SearchOptions, 'page' | 'hitsPerPage' | 'offset' | 'length'>;
|
||
|
||
export declare type RecommendTrendingFacetsQueriesResponse = {
|
||
/**
|
||
* The list of results.
|
||
*/
|
||
readonly results: readonly TrendingFacetsResponse[];
|
||
};
|
||
|
||
export declare type RelatedProductsQuery = Omit<RecommendationsQuery, 'model'>;
|
||
|
||
declare type RequestOptions_2 = {
|
||
/**
|
||
* If the given request should persist on the cache. Keep in mind,
|
||
* that some methods may have this option enabled by default.
|
||
*/
|
||
readonly cacheable?: boolean;
|
||
/**
|
||
* Custom timeout for the request. Note that, in normal situacions
|
||
* the given timeout will be applied. But the transporter layer may
|
||
* increase this timeout if there is need for it.
|
||
*/
|
||
readonly timeout?: number;
|
||
/**
|
||
* Custom headers for the request. This headers are
|
||
* going to be merged the transporter headers.
|
||
*/
|
||
readonly headers?: Readonly<Record<string, string>>;
|
||
/**
|
||
* Custom query parameters for the request. This query parameters are
|
||
* going to be merged the transporter query parameters.
|
||
*/
|
||
readonly queryParameters?: Record<string, any>;
|
||
/**
|
||
* Custom data for the request. This data are
|
||
* going to be merged the transporter data.
|
||
*/
|
||
readonly data?: Record<string, any>;
|
||
/**
|
||
* Additional request body values. It's only taken in
|
||
* consideration in `POST` and `PUT` requests.
|
||
*/
|
||
[key: string]: any;
|
||
};
|
||
|
||
declare type SearchOptions_2 = {
|
||
/**
|
||
* Create a new query with an empty search query.
|
||
*/
|
||
readonly query?: string;
|
||
/**
|
||
* Allows a search for similar objects, but the query has to be constructed on your end and included alongside an empty query.
|
||
*
|
||
* The similarQuery should be made from the tags and keywords of the relevant object.
|
||
*/
|
||
readonly similarQuery?: string;
|
||
/**
|
||
* Filter hits by facet value.
|
||
*/
|
||
readonly facetFilters?: string | readonly string[] | ReadonlyArray<readonly string[] | string>;
|
||
/**
|
||
* Create filters for ranking purposes, where records that match the filter are ranked highest.
|
||
*/
|
||
readonly optionalFilters?: string | readonly string[] | ReadonlyArray<readonly string[] | string>;
|
||
/**
|
||
* Filter on numeric attributes.
|
||
*/
|
||
readonly numericFilters?: string | readonly string[] | ReadonlyArray<readonly string[] | string>;
|
||
/**
|
||
* Filter hits by tags. tagFilters is a different way of filtering, which relies on the _tags
|
||
* attribute. It uses a simpler syntax than filters. You can use it when you want to do
|
||
* simple filtering based on tags.
|
||
*/
|
||
readonly tagFilters?: string | readonly string[] | ReadonlyArray<readonly string[] | string>;
|
||
/**
|
||
* Determines how to calculate the total score for filtering.
|
||
*/
|
||
readonly sumOrFiltersScores?: boolean;
|
||
/**
|
||
* Filter the query with numeric, facet and/or tag filters.
|
||
*/
|
||
readonly filters?: string;
|
||
/**
|
||
* Specify the page to retrieve.
|
||
*/
|
||
readonly page?: number;
|
||
/**
|
||
* Set the number of hits per page.
|
||
*/
|
||
readonly hitsPerPage?: number;
|
||
/**
|
||
* Specify the offset of the first hit to return.
|
||
*/
|
||
readonly offset?: number;
|
||
/**
|
||
* Set the number of hits to retrieve (used only with offset).
|
||
*/
|
||
readonly length?: number;
|
||
/**
|
||
* List of attributes to highlight.
|
||
*/
|
||
readonly attributesToHighlight?: readonly string[];
|
||
/**
|
||
* List of attributes to snippet, with an optional maximum number of words to snippet.
|
||
*/
|
||
readonly attributesToSnippet?: readonly string[];
|
||
/**
|
||
* Gives control over which attributes to retrieve and which not to retrieve.
|
||
*/
|
||
readonly attributesToRetrieve?: readonly string[];
|
||
/**
|
||
* The HTML string to insert before the highlighted parts in all highlight and snippet results.
|
||
*/
|
||
readonly highlightPreTag?: string;
|
||
/**
|
||
* The HTML string to insert after the highlighted parts in all highlight and snippet results
|
||
*/
|
||
readonly highlightPostTag?: string;
|
||
/**
|
||
* String used as an ellipsis indicator when a snippet is truncated.
|
||
*/
|
||
readonly snippetEllipsisText?: string;
|
||
/**
|
||
* Restrict highlighting and snippeting to items that matched the query.
|
||
*/
|
||
readonly restrictHighlightAndSnippetArrays?: boolean;
|
||
/**
|
||
* Facets to retrieve.
|
||
*/
|
||
readonly facets?: readonly string[];
|
||
/**
|
||
* Maximum number of facet values to return for each facet during a regular search.
|
||
*/
|
||
readonly maxValuesPerFacet?: number;
|
||
/**
|
||
* Force faceting to be applied after de-duplication (via the Distinct setting).
|
||
*/
|
||
readonly facetingAfterDistinct?: boolean;
|
||
/**
|
||
* Minimum number of characters a word in the query string must contain to accept matches with 1 typo
|
||
*/
|
||
readonly minWordSizefor1Typo?: number;
|
||
/**
|
||
* Minimum number of characters a word in the query string must contain to accept matches with 2 typos.
|
||
*/
|
||
readonly minWordSizefor2Typos?: number;
|
||
/**
|
||
* Whether to allow typos on numbers (“numeric tokens”) in the query string.
|
||
*/
|
||
readonly allowTyposOnNumericTokens?: boolean;
|
||
/**
|
||
* List of attributes on which you want to disable typo tolerance.
|
||
*/
|
||
readonly disableTypoToleranceOnAttributes?: readonly string[];
|
||
/**
|
||
* Controls if and how query words are interpreted as prefixes.
|
||
*/
|
||
readonly queryType?: 'prefixLast' | 'prefixAll' | 'prefixNone';
|
||
/**
|
||
* Selects a strategy to remove words from the query when it doesn’t match any hits.
|
||
*/
|
||
readonly removeWordsIfNoResults?: 'none' | 'lastWords' | 'firstWords' | 'allOptional';
|
||
/**
|
||
* Enables the advanced query syntax.
|
||
*/
|
||
readonly advancedSyntax?: boolean;
|
||
/**
|
||
* AdvancedSyntaxFeatures can be exactPhrase or excludeWords
|
||
*/
|
||
readonly advancedSyntaxFeatures?: ReadonlyArray<'exactPhrase' | 'excludeWords'>;
|
||
/**
|
||
* A list of words that should be considered as optional when found in the query.
|
||
*/
|
||
readonly optionalWords?: string | readonly string[];
|
||
/**
|
||
* List of attributes on which you want to disable the exact ranking criterion.
|
||
*/
|
||
readonly disableExactOnAttributes?: readonly string[];
|
||
/**
|
||
* Controls how the exact ranking criterion is computed when the query contains only one word.
|
||
*/
|
||
readonly exactOnSingleWordQuery?: 'attribute' | 'none' | 'word';
|
||
/**
|
||
* List of alternatives that should be considered an exact match by the exact ranking criterion.
|
||
*/
|
||
readonly alternativesAsExact?: ReadonlyArray<'ignorePlurals' | 'singleWordSynonym' | 'multiWordsSynonym'>;
|
||
/**
|
||
* Whether rules should be globally enabled.
|
||
*/
|
||
readonly enableRules?: boolean;
|
||
/**
|
||
* Enables contextual rules.
|
||
*/
|
||
readonly ruleContexts?: readonly string[];
|
||
/**
|
||
* Enables de-duplication or grouping of results.
|
||
*/
|
||
readonly distinct?: boolean | number;
|
||
/**
|
||
* Whether the current query will be taken into account in the Analytics
|
||
*/
|
||
readonly analytics?: boolean;
|
||
/**
|
||
* List of tags to apply to the query in the analytics.
|
||
*/
|
||
readonly analyticsTags?: readonly string[];
|
||
/**
|
||
* Whether to take into account an index’s synonyms for a particular search.
|
||
*/
|
||
readonly synonyms?: boolean;
|
||
/**
|
||
* Whether to highlight and snippet the original word that matches the synonym or the synonym itself.
|
||
*/
|
||
readonly replaceSynonymsInHighlight?: boolean;
|
||
/**
|
||
* Precision of the proximity ranking criterion.
|
||
*/
|
||
readonly minProximity?: number;
|
||
/**
|
||
* Choose which fields the response will contain. Applies to search and browse queries.
|
||
*/
|
||
readonly responseFields?: readonly string[];
|
||
/**
|
||
* Maximum number of facet hits to return during a search for facet values.
|
||
*/
|
||
readonly maxFacetHits?: number;
|
||
/**
|
||
* Whether to include or exclude a query from the processing-time percentile computation.
|
||
*/
|
||
readonly percentileComputation?: boolean;
|
||
/**
|
||
* Enable the Click Analytics feature.
|
||
*/
|
||
readonly clickAnalytics?: boolean;
|
||
/**
|
||
* The `personalizationImpact` parameter sets the percentage of the impact that personalization has on ranking records. The
|
||
* value must be between 0 and 100 (inclusive). This parameter will not be taken into account if `enablePersonalization`
|
||
* is **false**.
|
||
*/
|
||
readonly personalizationImpact?: number;
|
||
/**
|
||
* Enable personalization for the query
|
||
*/
|
||
readonly enablePersonalization?: boolean;
|
||
/**
|
||
* Restricts a given query to look in only a subset of your searchable attributes.
|
||
*/
|
||
readonly restrictSearchableAttributes?: readonly string[];
|
||
/**
|
||
* Controls how facet values are sorted.
|
||
*/
|
||
readonly sortFacetValuesBy?: 'count' | 'alpha';
|
||
/**
|
||
* Controls whether typo tolerance is enabled and how it is applied.
|
||
*/
|
||
readonly typoTolerance?: boolean | 'min' | 'strict';
|
||
/**
|
||
* Search for entries around a central geolocation, enabling a geo search within a circular area.
|
||
*/
|
||
readonly aroundLatLng?: string;
|
||
/**
|
||
* Search for entries around a given location automatically computed from the requester’s IP address.
|
||
*/
|
||
readonly aroundLatLngViaIP?: boolean;
|
||
/**
|
||
* Define the maximum radius for a geo search (in meters).
|
||
*/
|
||
readonly aroundRadius?: number | 'all';
|
||
/**
|
||
* Precision of geo search (in meters), to add grouping by geo location to the ranking formula.
|
||
*/
|
||
readonly aroundPrecision?: number | ReadonlyArray<{
|
||
readonly from: number;
|
||
readonly value: number;
|
||
}>;
|
||
/**
|
||
* Minimum radius (in meters) used for a geo search when aroundRadius is not set.
|
||
*/
|
||
readonly minimumAroundRadius?: number;
|
||
/**
|
||
* Search inside a rectangular area (in geo coordinates).
|
||
*/
|
||
readonly insideBoundingBox?: ReadonlyArray<readonly number[]> | string;
|
||
/**
|
||
* Search inside a polygon (in geo coordinates).
|
||
*/
|
||
readonly insidePolygon?: ReadonlyArray<readonly number[]>;
|
||
/**
|
||
* Treats singular, plurals, and other forms of declensions as matching terms.
|
||
*/
|
||
readonly ignorePlurals?: boolean | readonly string[];
|
||
/**
|
||
* Removes stop (common) words from the query before executing it.
|
||
*/
|
||
readonly removeStopWords?: boolean | readonly string[];
|
||
/**
|
||
* List of supported languages with their associated language ISO code.
|
||
*
|
||
* Apply a set of natural language best practices such as ignorePlurals,
|
||
* removeStopWords, removeWordsIfNoResults, analyticsTags and ruleContexts.
|
||
*/
|
||
readonly naturalLanguages?: readonly string[];
|
||
/**
|
||
* When true, each hit in the response contains an additional _rankingInfo object.
|
||
*/
|
||
readonly getRankingInfo?: boolean;
|
||
/**
|
||
* A user identifier.
|
||
* Format: alpha numeric string [a-zA-Z0-9_-]
|
||
* Length: between 1 and 64 characters.
|
||
*/
|
||
readonly userToken?: string;
|
||
/**
|
||
* Can be to enable or disable A/B tests at query time.
|
||
* Engine's default: true
|
||
*/
|
||
readonly enableABTest?: boolean;
|
||
/**
|
||
* Enable word segmentation (also called decompounding) at query time for
|
||
* compatible languages. For example, this turns the Dutch query
|
||
* "spaanplaatbehang" into "spaan plaat behang" to retrieve more relevant
|
||
* results.
|
||
*/
|
||
readonly decompoundQuery?: boolean;
|
||
/**
|
||
* The relevancy threshold to apply to search in a virtual index [0-100]. A Bigger
|
||
* value means fewer, but more relevant results, smaller value means more, but
|
||
* less relevant results.
|
||
*/
|
||
readonly relevancyStrictness?: number;
|
||
/**
|
||
* Whether this search should use Dynamic Re-Ranking.
|
||
* @link https://www.algolia.com/doc/guides/algolia-ai/re-ranking/
|
||
*
|
||
* Note: You need to turn on Dynamic Re-Ranking on your index for it to have an effect on
|
||
* your search results. You can do this through the Re-Ranking page on the dashboard.
|
||
* This parameter is only used to turn off Dynamic Re-Ranking (with false) at search time.
|
||
*/
|
||
readonly enableReRanking?: boolean;
|
||
/**
|
||
* When Dynamic Re-Ranking is enabled, only records that match these filters will be impacted by Dynamic Re-Ranking.
|
||
*/
|
||
readonly reRankingApplyFilter?: string | readonly string[] | ReadonlyArray<readonly string[] | string> | null;
|
||
/**
|
||
* Sets the languages to be used by language-specific settings and functionalities such as ignorePlurals, removeStopWords, and CJK word-detection.
|
||
*/
|
||
readonly queryLanguages?: readonly string[];
|
||
/**
|
||
* Enriches the API’s response with meta-information as to how the query was processed.
|
||
*/
|
||
readonly explain?: readonly string[];
|
||
};
|
||
|
||
export declare type TrendingFacetHit = {
|
||
readonly _score: number;
|
||
readonly facetName: string;
|
||
readonly facetValue: string;
|
||
};
|
||
|
||
export declare type TrendingFacetsQuery = {
|
||
/**
|
||
* The name of the target index.
|
||
*/
|
||
readonly indexName: string;
|
||
/**
|
||
* Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.
|
||
*/
|
||
readonly threshold?: number;
|
||
/**
|
||
* How many recommendations to retrieve.
|
||
*/
|
||
readonly maxRecommendations?: number;
|
||
/**
|
||
* The facet attribute to get recommendations for.
|
||
*/
|
||
readonly facetName: string;
|
||
};
|
||
|
||
export declare type TrendingFacetsResponse = Omit<SearchResponse, 'hits'> & {
|
||
readonly hits: readonly TrendingFacetHit[];
|
||
};
|
||
|
||
export declare type TrendingItemsQuery = {
|
||
/**
|
||
* The name of the target index.
|
||
*/
|
||
readonly indexName: string;
|
||
/**
|
||
* Threshold for the recommendations confidence score (between 0 and 100). Only recommendations with a greater score are returned.
|
||
*/
|
||
readonly threshold?: number;
|
||
/**
|
||
* How many recommendations to retrieve.
|
||
*/
|
||
readonly maxRecommendations?: number;
|
||
/**
|
||
* List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
|
||
*/
|
||
readonly queryParameters?: RecommendSearchOptions_2;
|
||
/**
|
||
* List of [search parameters](https://www.algolia.com/doc/api-reference/search-api-parameters/) to send.
|
||
*
|
||
* Additional filters to use as fallback when there aren’t enough recommendations.
|
||
*/
|
||
readonly fallbackParameters?: RecommendSearchOptions_2;
|
||
/**
|
||
* The facet attribute to get recommendations for.
|
||
*/
|
||
readonly facetName?: string;
|
||
/**
|
||
* The value of the target facet.
|
||
*/
|
||
readonly facetValue?: string;
|
||
};
|
||
|
||
export declare type TrendingModel = 'trending-items' | 'trending-facets';
|
||
|
||
export declare type TrendingQuery = (TrendingItemsQuery & {
|
||
readonly model: TrendingModel;
|
||
}) | (TrendingFacetsQuery & {
|
||
readonly model: TrendingModel;
|
||
});
|
||
|
||
export declare type WithRecommendMethods<TType> = TType & {
|
||
/**
|
||
* Returns recommendations.
|
||
*/
|
||
readonly getRecommendations: <TObject>(queries: ReadonlyArray<RecommendationsQuery | TrendingQuery | RecommendedForYouQuery>, requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
|
||
/**
|
||
* Returns [Related Products](https://algolia.com/doc/guides/algolia-ai/recommend/#related-products).
|
||
*/
|
||
readonly getRelatedProducts: <TObject>(queries: readonly RelatedProductsQuery[], requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
|
||
/**
|
||
* Returns [Frequently Bought Together](https://algolia.com/doc/guides/algolia-ai/recommend/#frequently-bought-together) products.
|
||
*/
|
||
readonly getFrequentlyBoughtTogether: <TObject>(queries: readonly FrequentlyBoughtTogetherQuery[], requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
|
||
/**
|
||
* Returns trending items
|
||
*/
|
||
readonly getTrendingItems: <TObject>(queries: readonly TrendingItemsQuery[], requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
|
||
/**
|
||
* Returns trending items per facet
|
||
*/
|
||
readonly getTrendingFacets: <TObject>(queries: readonly TrendingFacetsQuery[], requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<RecommendTrendingFacetsQueriesResponse>>;
|
||
/**
|
||
* Returns Looking Similar
|
||
*/
|
||
readonly getLookingSimilar: <TObject>(queries: readonly LookingSimilarQuery[], requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
|
||
/**
|
||
* Returns Recommended for you
|
||
*/
|
||
readonly getRecommendedForYou: <TObject>(queries: readonly RecommendedForYouParams[], requestOptions?: RequestOptions & SearchOptions) => Readonly<Promise<RecommendQueriesResponse<TObject>>>;
|
||
};
|
||
|
||
export { }
|