length parameter can be used with offset as an alternative approach to pagination.
Usage
- If
offsetis omitted,lengthis ignored. - If
offsetis specified butlengthomitted, the number of records returned is equal tohitsPerPage.
offset and length, the response includes these fields:
{
// ...
"offset": 5,
"length": 10,
// ...
}
Example
Current API clients
Current API clients
var response = await client.SearchSingleIndexAsync<Hit>(
"INDEX_NAME",
new SearchParams(new SearchParamsObject { Query = "query", Length = 4 })
);
final response = await client.searchSingleIndex(
indexName: "INDEX_NAME",
searchParams: SearchParamsObject(
query: "query",
length: 4,
),
);
response, err := client.SearchSingleIndex(client.NewApiSearchSingleIndexRequest(
"INDEX_NAME").WithSearchParams(search.SearchParamsObjectAsSearchParams(
search.NewEmptySearchParamsObject().SetQuery("query").SetLength(4))))
if err != nil {
// handle the eventual error
panic(err)
}
SearchResponse response = client.searchSingleIndex(
"INDEX_NAME",
new SearchParamsObject().setQuery("query").setLength(4),
Hit.class
);
const response = await client.searchSingleIndex({
indexName: 'indexName',
searchParams: { query: 'query', length: 4 },
});
var response =
client.searchSingleIndex(
indexName = "INDEX_NAME",
searchParams = SearchParamsObject(query = "query", length = 4),
)
$response = $client->searchSingleIndex(
'INDEX_NAME',
['query' => 'query',
'length' => 4,
],
);
response = client.search_single_index(
index_name="INDEX_NAME",
search_params={
"query": "query",
"length": 4,
},
)
response = client.search_single_index(
"INDEX_NAME",
Algolia::Search::SearchParamsObject.new(query: "query", length: 4)
)
val response = Await.result(
client.searchSingleIndex(
indexName = "INDEX_NAME",
searchParams = Some(
SearchParamsObject(
query = Some("query"),
length = Some(4)
)
)
),
Duration(100, "sec")
)
let response: SearchResponse<Hit> = try await client.searchSingleIndex(
indexName: "INDEX_NAME",
searchParams: SearchSearchParams.searchSearchParamsObject(SearchSearchParamsObject(
query: "query",
length: 4
))
)
Legacy API clients
Legacy API clients
index.Search(new Query("query")
{
Length = 4
Offset = 1
});
res, err := index.Search(
"query",
opt.Length(4),
opt.Offset(4),
)
index.search(
new Query("query").setLength(4).setOffset(1)
);
index
.search("query", {
offset: 1,
length: 4,
})
.then(({ hits }) => {
console.log(hits);
});
val query = query("query") {
length = 4
offset = 1
}
index.search(query)
$results = $index->search('query', [
'offset' => 1,
'length' => 4
]);
results = index.search("query", {"offset": 1, "length": 4})
results = index.search(
"query",
{
offset: 1,
length: 4
}
)
client.execute {
search into "myIndex" query Query(
query = Some("query"),
offset = Some("1"),
length = Some("4")
)
}
let query = Query("query")
.set(\.length, to: 4)
.set(\.offset, to: 1)
index.search(query: query) { result in
if case .success(let response) = result {
print("Response: \(response)")
}
}