Interface EvaluationServiceGrpc.AsyncService (0.3.0) 

public static interface EvaluationServiceGrpc.AsyncService

EvaluationService exposes methods to perform evaluation for the CES app.

Methods

createEvaluation(CreateEvaluationRequest request, StreamObserver<Evaluation> responseObserver)

public default void createEvaluation(CreateEvaluationRequest request, StreamObserver<Evaluation> responseObserver)

Creates an evaluation.

Parameters
Name Description
request CreateEvaluationRequest
responseObserver io.grpc.stub.StreamObserver<Evaluation>

createEvaluationDataset(CreateEvaluationDatasetRequest request, StreamObserver<EvaluationDataset> responseObserver)

public default void createEvaluationDataset(CreateEvaluationDatasetRequest request, StreamObserver<EvaluationDataset> responseObserver)

Creates an evaluation dataset.

Parameters
Name Description
request CreateEvaluationDatasetRequest
responseObserver io.grpc.stub.StreamObserver<EvaluationDataset>

createEvaluationExpectation(CreateEvaluationExpectationRequest request, StreamObserver<EvaluationExpectation> responseObserver)

public default void createEvaluationExpectation(CreateEvaluationExpectationRequest request, StreamObserver<EvaluationExpectation> responseObserver)

Creates an evaluation expectation.

Parameters
Name Description
request CreateEvaluationExpectationRequest
responseObserver io.grpc.stub.StreamObserver<EvaluationExpectation>

createScheduledEvaluationRun(CreateScheduledEvaluationRunRequest request, StreamObserver<ScheduledEvaluationRun> responseObserver)

public default void createScheduledEvaluationRun(CreateScheduledEvaluationRunRequest request, StreamObserver<ScheduledEvaluationRun> responseObserver)

Creates a scheduled evaluation run.

Parameters
Name Description
request CreateScheduledEvaluationRunRequest
responseObserver io.grpc.stub.StreamObserver<ScheduledEvaluationRun>

deleteEvaluation(DeleteEvaluationRequest request, StreamObserver<Empty> responseObserver)

public default void deleteEvaluation(DeleteEvaluationRequest request, StreamObserver<Empty> responseObserver)

Deletes an evaluation.

Parameters
Name Description
request DeleteEvaluationRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteEvaluationDataset(DeleteEvaluationDatasetRequest request, StreamObserver<Empty> responseObserver)

public default void deleteEvaluationDataset(DeleteEvaluationDatasetRequest request, StreamObserver<Empty> responseObserver)

Deletes an evaluation dataset.

Parameters
Name Description
request DeleteEvaluationDatasetRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteEvaluationExpectation(DeleteEvaluationExpectationRequest request, StreamObserver<Empty> responseObserver)

public default void deleteEvaluationExpectation(DeleteEvaluationExpectationRequest request, StreamObserver<Empty> responseObserver)

Deletes an evaluation expectation.

Parameters
Name Description
request DeleteEvaluationExpectationRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteEvaluationResult(DeleteEvaluationResultRequest request, StreamObserver<Empty> responseObserver)

public default void deleteEvaluationResult(DeleteEvaluationResultRequest request, StreamObserver<Empty> responseObserver)

Deletes an evaluation result.

Parameters
Name Description
request DeleteEvaluationResultRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

deleteEvaluationRun(DeleteEvaluationRunRequest request, StreamObserver<Operation> responseObserver)

public default void deleteEvaluationRun(DeleteEvaluationRunRequest request, StreamObserver<Operation> responseObserver)

Deletes an evaluation run.

Parameters
Name Description
request DeleteEvaluationRunRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

deleteScheduledEvaluationRun(DeleteScheduledEvaluationRunRequest request, StreamObserver<Empty> responseObserver)

public default void deleteScheduledEvaluationRun(DeleteScheduledEvaluationRunRequest request, StreamObserver<Empty> responseObserver)

Deletes a scheduled evaluation run.

Parameters
Name Description
request DeleteScheduledEvaluationRunRequest
responseObserver io.grpc.stub.StreamObserver<Empty>

generateEvaluation(GenerateEvaluationRequest request, StreamObserver<Operation> responseObserver)

public default void generateEvaluation(GenerateEvaluationRequest request, StreamObserver<Operation> responseObserver)

Creates a golden evaluation from a conversation.

Parameters
Name Description
request GenerateEvaluationRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

getEvaluation(GetEvaluationRequest request, StreamObserver<Evaluation> responseObserver)

public default void getEvaluation(GetEvaluationRequest request, StreamObserver<Evaluation> responseObserver)

Gets details of the specified evaluation.

Parameters
Name Description
request GetEvaluationRequest
responseObserver io.grpc.stub.StreamObserver<Evaluation>

getEvaluationDataset(GetEvaluationDatasetRequest request, StreamObserver<EvaluationDataset> responseObserver)

public default void getEvaluationDataset(GetEvaluationDatasetRequest request, StreamObserver<EvaluationDataset> responseObserver)

Gets details of the specified evaluation dataset.

Parameters
Name Description
request GetEvaluationDatasetRequest
responseObserver io.grpc.stub.StreamObserver<EvaluationDataset>

getEvaluationExpectation(GetEvaluationExpectationRequest request, StreamObserver<EvaluationExpectation> responseObserver)

public default void getEvaluationExpectation(GetEvaluationExpectationRequest request, StreamObserver<EvaluationExpectation> responseObserver)

Gets details of the specified evaluation expectation.

Parameters
Name Description
request GetEvaluationExpectationRequest
responseObserver io.grpc.stub.StreamObserver<EvaluationExpectation>

getEvaluationResult(GetEvaluationResultRequest request, StreamObserver<EvaluationResult> responseObserver)

public default void getEvaluationResult(GetEvaluationResultRequest request, StreamObserver<EvaluationResult> responseObserver)

Gets details of the specified evaluation result.

Parameters
Name Description
request GetEvaluationResultRequest
responseObserver io.grpc.stub.StreamObserver<EvaluationResult>

getEvaluationRun(GetEvaluationRunRequest request, StreamObserver<EvaluationRun> responseObserver)

public default void getEvaluationRun(GetEvaluationRunRequest request, StreamObserver<EvaluationRun> responseObserver)

Gets details of the specified evaluation run.

Parameters
Name Description
request GetEvaluationRunRequest
responseObserver io.grpc.stub.StreamObserver<EvaluationRun>

getScheduledEvaluationRun(GetScheduledEvaluationRunRequest request, StreamObserver<ScheduledEvaluationRun> responseObserver)

public default void getScheduledEvaluationRun(GetScheduledEvaluationRunRequest request, StreamObserver<ScheduledEvaluationRun> responseObserver)

Gets details of the specified scheduled evaluation run.

Parameters
Name Description
request GetScheduledEvaluationRunRequest
responseObserver io.grpc.stub.StreamObserver<ScheduledEvaluationRun>

importEvaluations(ImportEvaluationsRequest request, StreamObserver<Operation> responseObserver)

public default void importEvaluations(ImportEvaluationsRequest request, StreamObserver<Operation> responseObserver)

Imports evaluations into the app.

Parameters
Name Description
request ImportEvaluationsRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

listEvaluationDatasets(ListEvaluationDatasetsRequest request, StreamObserver<ListEvaluationDatasetsResponse> responseObserver)

public default void listEvaluationDatasets(ListEvaluationDatasetsRequest request, StreamObserver<ListEvaluationDatasetsResponse> responseObserver)

Lists all evaluation datasets in the given app.

Parameters
Name Description
request ListEvaluationDatasetsRequest
responseObserver io.grpc.stub.StreamObserver<ListEvaluationDatasetsResponse>

listEvaluationExpectations(ListEvaluationExpectationsRequest request, StreamObserver<ListEvaluationExpectationsResponse> responseObserver)

public default void listEvaluationExpectations(ListEvaluationExpectationsRequest request, StreamObserver<ListEvaluationExpectationsResponse> responseObserver)

Lists all evaluation expectations in the given app.

Parameters
Name Description
request ListEvaluationExpectationsRequest
responseObserver io.grpc.stub.StreamObserver<ListEvaluationExpectationsResponse>

listEvaluationResults(ListEvaluationResultsRequest request, StreamObserver<ListEvaluationResultsResponse> responseObserver)

public default void listEvaluationResults(ListEvaluationResultsRequest request, StreamObserver<ListEvaluationResultsResponse> responseObserver)

Lists all evaluation results for a given evaluation.

Parameters
Name Description
request ListEvaluationResultsRequest
responseObserver io.grpc.stub.StreamObserver<ListEvaluationResultsResponse>

listEvaluationRuns(ListEvaluationRunsRequest request, StreamObserver<ListEvaluationRunsResponse> responseObserver)

public default void listEvaluationRuns(ListEvaluationRunsRequest request, StreamObserver<ListEvaluationRunsResponse> responseObserver)

Lists all evaluation runs in the given app.

Parameters
Name Description
request ListEvaluationRunsRequest
responseObserver io.grpc.stub.StreamObserver<ListEvaluationRunsResponse>

listEvaluations(ListEvaluationsRequest request, StreamObserver<ListEvaluationsResponse> responseObserver)

public default void listEvaluations(ListEvaluationsRequest request, StreamObserver<ListEvaluationsResponse> responseObserver)

Lists all evaluations in the given app.

Parameters
Name Description
request ListEvaluationsRequest
responseObserver io.grpc.stub.StreamObserver<ListEvaluationsResponse>

listScheduledEvaluationRuns(ListScheduledEvaluationRunsRequest request, StreamObserver<ListScheduledEvaluationRunsResponse> responseObserver)

public default void listScheduledEvaluationRuns(ListScheduledEvaluationRunsRequest request, StreamObserver<ListScheduledEvaluationRunsResponse> responseObserver)

Lists all scheduled evaluation runs in the given app.

Parameters
Name Description
request ListScheduledEvaluationRunsRequest
responseObserver io.grpc.stub.StreamObserver<ListScheduledEvaluationRunsResponse>

runEvaluation(RunEvaluationRequest request, StreamObserver<Operation> responseObserver)

public default void runEvaluation(RunEvaluationRequest request, StreamObserver<Operation> responseObserver)

Runs an evaluation of the app.

Parameters
Name Description
request RunEvaluationRequest
responseObserver io.grpc.stub.StreamObserver<Operation>

testPersonaVoice(TestPersonaVoiceRequest request, StreamObserver<TestPersonaVoiceResponse> responseObserver)

public default void testPersonaVoice(TestPersonaVoiceRequest request, StreamObserver<TestPersonaVoiceResponse> responseObserver)

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

Parameters
Name Description
request TestPersonaVoiceRequest
responseObserver io.grpc.stub.StreamObserver<TestPersonaVoiceResponse>

updateEvaluation(UpdateEvaluationRequest request, StreamObserver<Evaluation> responseObserver)

public default void updateEvaluation(UpdateEvaluationRequest request, StreamObserver<Evaluation> responseObserver)

Updates an evaluation.

Parameters
Name Description
request UpdateEvaluationRequest
responseObserver io.grpc.stub.StreamObserver<Evaluation>

updateEvaluationDataset(UpdateEvaluationDatasetRequest request, StreamObserver<EvaluationDataset> responseObserver)

public default void updateEvaluationDataset(UpdateEvaluationDatasetRequest request, StreamObserver<EvaluationDataset> responseObserver)

Updates an evaluation dataset.

Parameters
Name Description
request UpdateEvaluationDatasetRequest
responseObserver io.grpc.stub.StreamObserver<EvaluationDataset>

updateEvaluationExpectation(UpdateEvaluationExpectationRequest request, StreamObserver<EvaluationExpectation> responseObserver)

public default void updateEvaluationExpectation(UpdateEvaluationExpectationRequest request, StreamObserver<EvaluationExpectation> responseObserver)

Updates an evaluation expectation.

Parameters
Name Description
request UpdateEvaluationExpectationRequest
responseObserver io.grpc.stub.StreamObserver<EvaluationExpectation>

updateScheduledEvaluationRun(UpdateScheduledEvaluationRunRequest request, StreamObserver<ScheduledEvaluationRun> responseObserver)

public default void updateScheduledEvaluationRun(UpdateScheduledEvaluationRunRequest request, StreamObserver<ScheduledEvaluationRun> responseObserver)

Updates a scheduled evaluation run.

Parameters
Name Description
request UpdateScheduledEvaluationRunRequest
responseObserver io.grpc.stub.StreamObserver<ScheduledEvaluationRun>

uploadEvaluationAudio(UploadEvaluationAudioRequest request, StreamObserver<UploadEvaluationAudioResponse> responseObserver)

public default void uploadEvaluationAudio(UploadEvaluationAudioRequest request, StreamObserver<UploadEvaluationAudioResponse> responseObserver)

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.

Parameters
Name Description
request UploadEvaluationAudioRequest
responseObserver io.grpc.stub.StreamObserver<UploadEvaluationAudioResponse>