use of com.ibm.watson.discovery.v1.model.GetMetricsEventRateOptions in project java-sdk by watson-developer-cloud.
the class Discovery method getMetricsEventRate.
/**
* Percentage of queries with an associated event.
*
* <p>The percentage of queries using the **natural_language_query** parameter that have a
* corresponding "click" event over a specified time window. This metric requires having
* integrated event tracking in your application using the **Events** API.
*
* @param getMetricsEventRateOptions the {@link GetMetricsEventRateOptions} containing the options
* for the call
* @return a {@link ServiceCall} with a result of type {@link MetricResponse}
*/
public ServiceCall<MetricResponse> getMetricsEventRate(GetMetricsEventRateOptions getMetricsEventRateOptions) {
if (getMetricsEventRateOptions == null) {
getMetricsEventRateOptions = new GetMetricsEventRateOptions.Builder().build();
}
RequestBuilder builder = RequestBuilder.get(RequestBuilder.resolveRequestUrl(getServiceUrl(), "/v1/metrics/event_rate"));
Map<String, String> sdkHeaders = SdkCommon.getSdkHeaders("discovery", "v1", "getMetricsEventRate");
for (Entry<String, String> header : sdkHeaders.entrySet()) {
builder.header(header.getKey(), header.getValue());
}
builder.header("Accept", "application/json");
builder.query("version", String.valueOf(this.version));
if (getMetricsEventRateOptions.startTime() != null) {
builder.query("start_time", DateUtils.formatAsDateTime(getMetricsEventRateOptions.startTime()));
}
if (getMetricsEventRateOptions.endTime() != null) {
builder.query("end_time", DateUtils.formatAsDateTime(getMetricsEventRateOptions.endTime()));
}
if (getMetricsEventRateOptions.resultType() != null) {
builder.query("result_type", String.valueOf(getMetricsEventRateOptions.resultType()));
}
ResponseConverter<MetricResponse> responseConverter = ResponseConverterUtils.getValue(new com.google.gson.reflect.TypeToken<MetricResponse>() {
}.getType());
return createServiceCall(builder.build(), responseConverter);
}
use of com.ibm.watson.discovery.v1.model.GetMetricsEventRateOptions in project java-sdk by watson-developer-cloud.
the class DiscoveryServiceTest method getMetricsEventRateIsSuccessful.
/**
* Gets the metrics event rate is successful.
*
* @throws InterruptedException the interrupted exception
*/
@Test
public void getMetricsEventRateIsSuccessful() throws InterruptedException {
server.enqueue(jsonResponse(metricResp));
String interval = "1d";
Long key = 1533513600000L;
Double eventRate = 0.0;
GetMetricsEventRateOptions options = new GetMetricsEventRateOptions.Builder().startTime(date).endTime(date).resultType(GetMetricsEventRateOptions.ResultType.DOCUMENT).build();
MetricResponse response = discoveryService.getMetricsEventRate(options).execute().getResult();
RecordedRequest request = server.takeRequest();
assertEquals(GET, request.getMethod());
assertTrue(!response.getAggregations().isEmpty());
assertEquals(interval, response.getAggregations().get(0).getInterval());
assertEquals(CreateEventOptions.Type.CLICK, response.getAggregations().get(0).getEventType());
assertTrue(!response.getAggregations().get(0).getResults().isEmpty());
assertEquals(key, response.getAggregations().get(0).getResults().get(0).getKey());
assertNotNull(response.getAggregations().get(0).getResults().get(0).getKeyAsString());
assertEquals(eventRate, response.getAggregations().get(0).getResults().get(0).getEventRate());
}
use of com.ibm.watson.discovery.v1.model.GetMetricsEventRateOptions in project java-sdk by watson-developer-cloud.
the class DiscoveryTest method testGetMetricsEventRateWOptions.
// Test the getMetricsEventRate operation with a valid options model parameter
@Test
public void testGetMetricsEventRateWOptions() throws Throwable {
// Register a mock response
String mockResponseBody = "{\"aggregations\": [{\"interval\": \"interval\", \"event_type\": \"eventType\", \"results\": [{\"key_as_string\": \"2019-01-01T12:00:00.000Z\", \"key\": 3, \"matching_results\": 15, \"event_rate\": 9}]}]}";
String getMetricsEventRatePath = "/v1/metrics/event_rate";
server.enqueue(new MockResponse().setHeader("Content-type", "application/json").setResponseCode(200).setBody(mockResponseBody));
// Construct an instance of the GetMetricsEventRateOptions model
GetMetricsEventRateOptions getMetricsEventRateOptionsModel = new GetMetricsEventRateOptions.Builder().startTime(DateUtils.parseAsDateTime("2019-01-01T12:00:00.000Z")).endTime(DateUtils.parseAsDateTime("2019-01-01T12:00:00.000Z")).resultType("document").build();
// Invoke getMetricsEventRate() with a valid options model and verify the result
Response<MetricResponse> response = discoveryService.getMetricsEventRate(getMetricsEventRateOptionsModel).execute();
assertNotNull(response);
MetricResponse responseObj = response.getResult();
assertNotNull(responseObj);
// Verify the contents of the request sent to the mock server
RecordedRequest request = server.takeRequest();
assertNotNull(request);
assertEquals(request.getMethod(), "GET");
// Verify request path
String parsedPath = TestUtilities.parseReqPath(request);
assertEquals(parsedPath, getMetricsEventRatePath);
// Verify query params
Map<String, String> query = TestUtilities.parseQueryString(request);
assertNotNull(query);
assertEquals(query.get("version"), "testString");
assertEquals(query.get("result_type"), "document");
}
Aggregations