search
Usage
// Initialize the client
var client = new CompositionClient(
new CompositionConfig("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
);
// Call the API
var response = await client.SearchAsync<Hit>(
"foo",
new RequestBody
{
Params = new Params { Query = "batman" },
ExternalProvider = new ExternalProvider
{
ConfigurationParams = new Dictionary<string, object> { { "customer_id", "customer123" } },
},
}
);
// print the response
Console.WriteLine(response);
// Initialize the client
final client = CompositionClient(
appId: 'ALGOLIA_APPLICATION_ID', apiKey: 'ALGOLIA_API_KEY');
// Call the API
final response = await client.search(
compositionID: "foo",
requestBody: RequestBody(
params: Params(
query: "batman",
),
externalProvider: ExternalProvider(
configurationParams: {
'customer_id': "customer123",
},
),
),
);
// print the response
print(response);
// Initialize the client
client, err := composition.NewClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
if err != nil {
// The client can fail to initialize if you pass an invalid parameter.
panic(err)
}
// Call the API
response, err := client.Search(client.NewApiSearchRequest(
"foo",
composition.NewEmptyRequestBody().SetParams(
composition.NewEmptyParams().SetQuery("batman")).SetExternalProvider(
composition.NewEmptyExternalProvider().SetConfigurationParams(map[string]any{"customer_id": "customer123"}))))
if err != nil {
// handle the eventual error
panic(err)
}
// print the response
print(response)
// Initialize the client
CompositionClient client = new CompositionClient("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY");
// Call the API
SearchResponse response = client.search(
"foo",
new RequestBody().setParams(new Params().setQuery("batman")).setExternalProvider(
new ExternalProvider().setConfigurationParams(
new HashMap() {
{
put("customer_id", "customer123");
}
}
)
),
Hit.class
);
// print the response
System.out.println(response);
// Initialize the client
const client = compositionClient('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
// Call the API
const response = await client.search({
compositionID: 'foo',
requestBody: {
params: { query: 'batman' },
externalProvider: { configurationParams: { customer_id: 'customer123' } },
},
});
// print the response
console.log(response);
// Initialize the client
val client = CompositionClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
// Call the API
var response =
client.search(
compositionID = "foo",
requestBody =
RequestBody(
params = Params(query = "batman"),
externalProvider =
ExternalProvider(
configurationParams =
buildJsonObject { put("customer_id", JsonPrimitive("customer123")) }
),
),
)
// print the response
println(response)
// Initialize the client
$client = CompositionClient::create('ALGOLIA_APPLICATION_ID', 'ALGOLIA_API_KEY');
// Call the API
$response = $client->search(
'foo',
['params' => ['query' => 'batman',
],
'externalProvider' => ['configurationParams' => ['customer_id' => 'customer123',
],
],
],
);
// print the response
var_dump($response);
# Initialize the client
# In an asynchronous context, you can use CompositionClient instead, which exposes the exact same methods.
client = CompositionClientSync("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
# Call the API
response = client.search(
composition_id="foo",
request_body={
"params": {
"query": "batman",
},
"externalProvider": {
"configurationParams": {
"customer_id": "customer123",
},
},
},
)
# print the response
print(response)
# Initialize the client
client = Algolia::CompositionClient.create("ALGOLIA_APPLICATION_ID", "ALGOLIA_API_KEY")
# Call the API
response = client.search(
"foo",
Algolia::Composition::RequestBody.new(
params: Algolia::Composition::Params.new(query: "batman"),
external_provider: Algolia::Composition::ExternalProvider.new(configuration_params: {customer_id: "customer123"})
)
)
# print the response
puts(response)
// Initialize the client
val client = CompositionClient(appId = "ALGOLIA_APPLICATION_ID", apiKey = "ALGOLIA_API_KEY")
// Call the API
val response = Await.result(
client.search(
compositionID = "foo",
requestBody = RequestBody(
params = Some(
Params(
query = Some("batman")
)
),
externalProvider = Some(
ExternalProvider(
configurationParams = Some(Map("customer_id" -> "customer123"))
)
)
)
),
Duration(100, "sec")
)
// print the response
println(response)
// Initialize the client
let client = try CompositionClient(appID: "ALGOLIA_APPLICATION_ID", apiKey: "ALGOLIA_API_KEY")
// Call the API
let response: CompositionSearchResponse<CompositionHit> = try await client.search(
compositionID: "foo",
requestBody: RequestBody(
params: CompositionParams(query: "batman"),
externalProvider: ExternalProvider(configurationParams: ["customer_id": AnyCodable("customer123")])
)
)
// print the response
print(response)
See the full API reference
For more details about input parameters
and response fields.