Class EvaluationServiceGrpc.EvaluationServiceFutureStub (0.3.0)

public static final class EvaluationServiceGrpc.EvaluationServiceFutureStub extends AbstractFutureStub<EvaluationServiceGrpc.EvaluationServiceFutureStub>

A stub to allow clients to do ListenableFuture-style rpc calls to service EvaluationService.

EvaluationService exposes methods to perform evaluation for the CES app.

Inheritance

java.lang.Object > io.grpc.stub.AbstractStub > io.grpc.stub.AbstractFutureStub > EvaluationServiceGrpc.EvaluationServiceFutureStub

Methods

build(Channel channel, CallOptions callOptions)

protected EvaluationServiceGrpc.EvaluationServiceFutureStub build(Channel channel, CallOptions callOptions)
Parameters
Name Description
channel io.grpc.Channel
callOptions io.grpc.CallOptions
Returns
Type Description
EvaluationServiceGrpc.EvaluationServiceFutureStub
Overrides
io.grpc.stub.AbstractStub.build(io.grpc.Channel,io.grpc.CallOptions)

createEvaluation(CreateEvaluationRequest request)

public ListenableFuture<Evaluation> createEvaluation(CreateEvaluationRequest request)

Creates an evaluation.

Parameter
Name Description
request CreateEvaluationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Evaluation>

createEvaluationDataset(CreateEvaluationDatasetRequest request)

public ListenableFuture<EvaluationDataset> createEvaluationDataset(CreateEvaluationDatasetRequest request)

Creates an evaluation dataset.

Parameter
Name Description
request CreateEvaluationDatasetRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EvaluationDataset>

createEvaluationExpectation(CreateEvaluationExpectationRequest request)

public ListenableFuture<EvaluationExpectation> createEvaluationExpectation(CreateEvaluationExpectationRequest request)

Creates an evaluation expectation.

Parameter
Name Description
request CreateEvaluationExpectationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EvaluationExpectation>

createScheduledEvaluationRun(CreateScheduledEvaluationRunRequest request)

public ListenableFuture<ScheduledEvaluationRun> createScheduledEvaluationRun(CreateScheduledEvaluationRunRequest request)

Creates a scheduled evaluation run.

Parameter
Name Description
request CreateScheduledEvaluationRunRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ScheduledEvaluationRun>

deleteEvaluation(DeleteEvaluationRequest request)

public ListenableFuture<Empty> deleteEvaluation(DeleteEvaluationRequest request)

Deletes an evaluation.

Parameter
Name Description
request DeleteEvaluationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteEvaluationDataset(DeleteEvaluationDatasetRequest request)

public ListenableFuture<Empty> deleteEvaluationDataset(DeleteEvaluationDatasetRequest request)

Deletes an evaluation dataset.

Parameter
Name Description
request DeleteEvaluationDatasetRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteEvaluationExpectation(DeleteEvaluationExpectationRequest request)

public ListenableFuture<Empty> deleteEvaluationExpectation(DeleteEvaluationExpectationRequest request)

Deletes an evaluation expectation.

Parameter
Name Description
request DeleteEvaluationExpectationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteEvaluationResult(DeleteEvaluationResultRequest request)

public ListenableFuture<Empty> deleteEvaluationResult(DeleteEvaluationResultRequest request)

Deletes an evaluation result.

Parameter
Name Description
request DeleteEvaluationResultRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

deleteEvaluationRun(DeleteEvaluationRunRequest request)

public ListenableFuture<Operation> deleteEvaluationRun(DeleteEvaluationRunRequest request)

Deletes an evaluation run.

Parameter
Name Description
request DeleteEvaluationRunRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

deleteScheduledEvaluationRun(DeleteScheduledEvaluationRunRequest request)

public ListenableFuture<Empty> deleteScheduledEvaluationRun(DeleteScheduledEvaluationRunRequest request)

Deletes a scheduled evaluation run.

Parameter
Name Description
request DeleteScheduledEvaluationRunRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Empty>

generateEvaluation(GenerateEvaluationRequest request)

public ListenableFuture<Operation> generateEvaluation(GenerateEvaluationRequest request)

Creates a golden evaluation from a conversation.

Parameter
Name Description
request GenerateEvaluationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

getEvaluation(GetEvaluationRequest request)

public ListenableFuture<Evaluation> getEvaluation(GetEvaluationRequest request)

Gets details of the specified evaluation.

Parameter
Name Description
request GetEvaluationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Evaluation>

getEvaluationDataset(GetEvaluationDatasetRequest request)

public ListenableFuture<EvaluationDataset> getEvaluationDataset(GetEvaluationDatasetRequest request)

Gets details of the specified evaluation dataset.

Parameter
Name Description
request GetEvaluationDatasetRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EvaluationDataset>

getEvaluationExpectation(GetEvaluationExpectationRequest request)

public ListenableFuture<EvaluationExpectation> getEvaluationExpectation(GetEvaluationExpectationRequest request)

Gets details of the specified evaluation expectation.

Parameter
Name Description
request GetEvaluationExpectationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EvaluationExpectation>

getEvaluationResult(GetEvaluationResultRequest request)

public ListenableFuture<EvaluationResult> getEvaluationResult(GetEvaluationResultRequest request)

Gets details of the specified evaluation result.

Parameter
Name Description
request GetEvaluationResultRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EvaluationResult>

getEvaluationRun(GetEvaluationRunRequest request)

public ListenableFuture<EvaluationRun> getEvaluationRun(GetEvaluationRunRequest request)

Gets details of the specified evaluation run.

Parameter
Name Description
request GetEvaluationRunRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EvaluationRun>

getScheduledEvaluationRun(GetScheduledEvaluationRunRequest request)

public ListenableFuture<ScheduledEvaluationRun> getScheduledEvaluationRun(GetScheduledEvaluationRunRequest request)

Gets details of the specified scheduled evaluation run.

Parameter
Name Description
request GetScheduledEvaluationRunRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ScheduledEvaluationRun>

importEvaluations(ImportEvaluationsRequest request)

public ListenableFuture<Operation> importEvaluations(ImportEvaluationsRequest request)

Imports evaluations into the app.

Parameter
Name Description
request ImportEvaluationsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

listEvaluationDatasets(ListEvaluationDatasetsRequest request)

public ListenableFuture<ListEvaluationDatasetsResponse> listEvaluationDatasets(ListEvaluationDatasetsRequest request)

Lists all evaluation datasets in the given app.

Parameter
Name Description
request ListEvaluationDatasetsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEvaluationDatasetsResponse>

listEvaluationExpectations(ListEvaluationExpectationsRequest request)

public ListenableFuture<ListEvaluationExpectationsResponse> listEvaluationExpectations(ListEvaluationExpectationsRequest request)

Lists all evaluation expectations in the given app.

Parameter
Name Description
request ListEvaluationExpectationsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEvaluationExpectationsResponse>

listEvaluationResults(ListEvaluationResultsRequest request)

public ListenableFuture<ListEvaluationResultsResponse> listEvaluationResults(ListEvaluationResultsRequest request)

Lists all evaluation results for a given evaluation.

Parameter
Name Description
request ListEvaluationResultsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEvaluationResultsResponse>

listEvaluationRuns(ListEvaluationRunsRequest request)

public ListenableFuture<ListEvaluationRunsResponse> listEvaluationRuns(ListEvaluationRunsRequest request)

Lists all evaluation runs in the given app.

Parameter
Name Description
request ListEvaluationRunsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEvaluationRunsResponse>

listEvaluations(ListEvaluationsRequest request)

public ListenableFuture<ListEvaluationsResponse> listEvaluations(ListEvaluationsRequest request)

Lists all evaluations in the given app.

Parameter
Name Description
request ListEvaluationsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListEvaluationsResponse>

listScheduledEvaluationRuns(ListScheduledEvaluationRunsRequest request)

public ListenableFuture<ListScheduledEvaluationRunsResponse> listScheduledEvaluationRuns(ListScheduledEvaluationRunsRequest request)

Lists all scheduled evaluation runs in the given app.

Parameter
Name Description
request ListScheduledEvaluationRunsRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ListScheduledEvaluationRunsResponse>

runEvaluation(RunEvaluationRequest request)

public ListenableFuture<Operation> runEvaluation(RunEvaluationRequest request)

Runs an evaluation of the app.

Parameter
Name Description
request RunEvaluationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Operation>

testPersonaVoice(TestPersonaVoiceRequest request)

public ListenableFuture<TestPersonaVoiceResponse> testPersonaVoice(TestPersonaVoiceRequest request)

Tests the voice of a persona. Also accepts a default persona.

Parameter
Name Description
request TestPersonaVoiceRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<TestPersonaVoiceResponse>

updateEvaluation(UpdateEvaluationRequest request)

public ListenableFuture<Evaluation> updateEvaluation(UpdateEvaluationRequest request)

Updates an evaluation.

Parameter
Name Description
request UpdateEvaluationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<Evaluation>

updateEvaluationDataset(UpdateEvaluationDatasetRequest request)

public ListenableFuture<EvaluationDataset> updateEvaluationDataset(UpdateEvaluationDatasetRequest request)

Updates an evaluation dataset.

Parameter
Name Description
request UpdateEvaluationDatasetRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EvaluationDataset>

updateEvaluationExpectation(UpdateEvaluationExpectationRequest request)

public ListenableFuture<EvaluationExpectation> updateEvaluationExpectation(UpdateEvaluationExpectationRequest request)

Updates an evaluation expectation.

Parameter
Name Description
request UpdateEvaluationExpectationRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<EvaluationExpectation>

updateScheduledEvaluationRun(UpdateScheduledEvaluationRunRequest request)

public ListenableFuture<ScheduledEvaluationRun> updateScheduledEvaluationRun(UpdateScheduledEvaluationRunRequest request)

Updates a scheduled evaluation run.

Parameter
Name Description
request UpdateScheduledEvaluationRunRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<ScheduledEvaluationRun>

uploadEvaluationAudio(UploadEvaluationAudioRequest request)

public ListenableFuture<UploadEvaluationAudioResponse> uploadEvaluationAudio(UploadEvaluationAudioRequest request)

Uploads audio for use in Golden Evaluations. Stores the audio in the Cloud Storage bucket defined in 'App.logging_settings.evaluation_audio_recording_config.gcs_bucket' and returns a transcript.

Parameter
Name Description
request UploadEvaluationAudioRequest
Returns
Type Description
com.google.common.util.concurrent.ListenableFuture<UploadEvaluationAudioResponse>