Search Synonyms | Ruby API Client V1 (Deprecated)

1
2
3
4
5
6
7
# Searching for "street" in synonyms and one-way synonyms;
# fetch the second page with 10 hits per page
results = index.search_synonyms('street', {
  type: ['synonym', 'oneWaySynonym'],
  page: 1,
  hitsPerPage: 10
})

1
2
3
4
5
6
7
8
9
10
// Searching for "street" in synonyms and one-way synonyms;
// fetch the second page with 10 hits per page

index.searchSynonyms('street', {
  type: 'synonym, oneWaySynonym',
  page: 1,
  hitsPerPage: 10
}).then(({ hits }) => {
  console.log(hits);
});

1
2
3
4
5
6
# Searching for "street" in synonyms and one-way synonyms; fetch the second page with 10 hits per page
results = index.search_synonyms('street', {
    'type': 'synonym, oneWaySynonym',
    'page': 1,
    'hitsPerPage': 10
})

1
2
3
4
5
6
7
8
9
10
11
12
13
// Searching for "street" in synonyms and one-way synonyms;
// fetch the second page with 10 hits per page
var query = SynonymQuery()
query.query = "street"
query.hitsPerPage = 10
query.page = 1
query.synonymTypes = [.multiWay, .oneWay]

index.searchSynonyms(query) { result in
  if case .success(let response) = result {
    print("Response: \(response)")
  }
}

1
2
3
4
5
6
7
8
9
10
11
// Searching for "street" in synonyms and one-way synonyms;
// fetch the second page with 10 hits per page

var result = index.SearchSynonyms(
  new SynonymQuery ("street")
  {
    Type = "synonym, oneWaySynonym" 
    Page = 1,
    HitsPerPage = 10
  }
);

1
2
3
4
5
6
7
8
9
10
11
// Searching for "street" in synonyms and one-way synonyms;
// fetch the second page with 10 hits per page
SynonymQuery query =  new SynonymQuery("street")
    .setTypes(Arrays.asList("synonym", "one_way"))
    .setPage(1)
    .setHitsPerPage(10);

SearchResult<Synonym> results = index.searchSynonyms(query);

// Async
SearchResult<Synonym> results = index.searchSynonyms(query);

1
2
3
4
5
6
7
8
9
10
11
// Searching for "street" in synonyms and one-way synonyms;
// fetch the second page with 10 hits per page

opts := []interface{}{
  opt.Type("synonym", "oneWaySynonym"),
  opt.Page(1),
  opt.HitsPerPage(10),
}

res, err := index.SearchSynonyms("street", opts...)
synonyms := res.Synonyms()

1
2
3
4
5
6
7
8
9
10
11
// Searching for "street" in synonyms and one-way synonyms;
// fetch the second page with 10 hits per page

var results = client.execute {
  search synonyms in index "index_name" query QuerySynonyms(
    query = "street",
    types = Some(Seq(SynonymType.synonym, SynonymType.oneWaySynonym)),
    page = Some(1),
    hitsPerPage = Some(10)
  )
}

1
2
3
4
5
curl -X POST \
     -H "X-Algolia-API-Key: ${API_KEY}" \
     -H "X-Algolia-Application-Id: ${APPLICATION_ID}" \
     --data-binary '{ "query": "iphone", "type": "synonym,onewaysynonym", "page": 0, "hitsPerPage": 10 }' \
     "https://${APPLICATION_ID}.algolia.net/1/indexes/{indexName}/synonyms/search"

1
2
3
4
5
6
7
8
val query = SynonymQuery(
    query = "street",
    hitsPerPage = 10,
    page = 1,
    types = listOf(SynonymType.MultiWay, SynonymType.OneWay)
)

index.searchSynonyms(query)