Recombee API Client
Public Member Functions | Properties | List of all members
Recombee.ApiClient.ApiRequests.AddSearchSynonym Class Reference

Add search synonym More...

Inheritance diagram for Recombee.ApiClient.ApiRequests.AddSearchSynonym:
Inheritance graph
[legend]
Collaboration diagram for Recombee.ApiClient.ApiRequests.AddSearchSynonym:
Collaboration graph
[legend]

Public Member Functions

 AddSearchSynonym (string term, string synonym, bool? oneWay=null)
 Construct the request More...
 
override string Path ()
 
Returns
URI to the endpoint including path parameters
More...
 
override Dictionary< string, object > QueryParameters ()
 Get query parameters More...
 
override Dictionary< string, object > BodyParameters ()
 Get body parameters More...
 
- Public Member Functions inherited from Recombee.ApiClient.ApiRequests.Request
 Request (HttpMethod httpMethod, int timeoutMilliseconds, bool ensureHttps=false)
 Construct the request More...
 

Properties

string Term [get]
 A word to which the synonym is specified. More...
 
string Synonym [get]
 A word that should be considered equal to the term by the full-text search engine. More...
 
bool? OneWay [get]
 If set to true, only term -> synonym is considered. If set to false, also synonym -> term works. Default: false. More...
 
- Properties inherited from Recombee.ApiClient.ApiRequests.Request
TimeSpan Timeout [get, set]
 Timeout for the request in milliseconds More...
 
bool EnsureHttps [get]
 If true, HTTPS must be chosen over HTTP for this request More...
 
HttpMethod RequestHttpMehod [get]
 Used HTTP method More...
 

Additional Inherited Members

- Protected Member Functions inherited from Recombee.ApiClient.ApiRequests.Request
double ConvertToUnixTimestamp (DateTime date)
 
Returns
Converts DateTime to UNIX timestamp (epoch)
More...
 

Detailed Description

Add search synonym

Adds a new synonym for the Search items. When the term is used in the search query, the synonym is also used for the full-text search. Unless oneWay=true, it works also in the opposite way (synonym -> term). An example of a synonym can be science fiction for the term sci-fi.

Constructor & Destructor Documentation

◆ AddSearchSynonym()

Recombee.ApiClient.ApiRequests.AddSearchSynonym.AddSearchSynonym ( string  term,
string  synonym,
bool?  oneWay = null 
)
inline

Construct the request

Parameters
termA word to which the synonym is specified.
synonymA word that should be considered equal to the term by the full-text search engine.
oneWayIf set to true, only term -> synonym is considered. If set to false, also synonym -> term works. Default: false.

Member Function Documentation

◆ BodyParameters()

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.AddSearchSynonym.BodyParameters ( )
inlinevirtual

Get body parameters

Returns
Dictionary containing values of body parameters (name of parameter: value of the parameter)

Implements Recombee.ApiClient.ApiRequests.Request.

◆ Path()

override string Recombee.ApiClient.ApiRequests.AddSearchSynonym.Path ( )
inlinevirtual

Returns
URI to the endpoint including path parameters

Implements Recombee.ApiClient.ApiRequests.Request.

◆ QueryParameters()

override Dictionary<string, object> Recombee.ApiClient.ApiRequests.AddSearchSynonym.QueryParameters ( )
inlinevirtual

Get query parameters

Returns
Dictionary containing values of query parameters (name of parameter: value of the parameter)

Implements Recombee.ApiClient.ApiRequests.Request.

Property Documentation

◆ OneWay

bool? Recombee.ApiClient.ApiRequests.AddSearchSynonym.OneWay
get

If set to true, only term -> synonym is considered. If set to false, also synonym -> term works. Default: false.

◆ Synonym

string Recombee.ApiClient.ApiRequests.AddSearchSynonym.Synonym
get

A word that should be considered equal to the term by the full-text search engine.

◆ Term

string Recombee.ApiClient.ApiRequests.AddSearchSynonym.Term
get

A word to which the synonym is specified.


The documentation for this class was generated from the following file: