Gemini Enterprise for Customer Experience v1beta API - Class EvaluationService.EvaluationServiceBase (1.0.0-beta01)

[BindServiceMethod(typeof(EvaluationService), "BindService")]
public abstract class EvaluationService.EvaluationServiceBase

Reference documentation and code samples for the Gemini Enterprise for Customer Experience v1beta API class EvaluationService.EvaluationServiceBase.

Base class for server-side implementations of EvaluationService

Inheritance

object > EvaluationService.EvaluationServiceBase

Inherited Members

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ToString()

Namespace

Google.Cloud.Ces.V1Beta

Assembly

Google.Cloud.Ces.V1Beta.dll

Methods

CreateEvaluation(CreateEvaluationRequest, ServerCallContext)

public virtual Task<Evaluation> CreateEvaluation(CreateEvaluationRequest request, ServerCallContext context)

Creates an evaluation.

Parameters
Name	Description
request	CreateEvaluationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluation	The response to send back to the client (wrapped by a task).

CreateEvaluationDataset(CreateEvaluationDatasetRequest, ServerCallContext)

public virtual Task<EvaluationDataset> CreateEvaluationDataset(CreateEvaluationDatasetRequest request, ServerCallContext context)

Creates an evaluation dataset.

Parameters
Name	Description
request	CreateEvaluationDatasetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluationDataset	The response to send back to the client (wrapped by a task).

CreateEvaluationExpectation(CreateEvaluationExpectationRequest, ServerCallContext)

public virtual Task<EvaluationExpectation> CreateEvaluationExpectation(CreateEvaluationExpectationRequest request, ServerCallContext context)

Creates an evaluation expectation.

Parameters
Name	Description
request	CreateEvaluationExpectationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluationExpectation	The response to send back to the client (wrapped by a task).

CreateScheduledEvaluationRun(CreateScheduledEvaluationRunRequest, ServerCallContext)

public virtual Task<ScheduledEvaluationRun> CreateScheduledEvaluationRun(CreateScheduledEvaluationRunRequest request, ServerCallContext context)

Creates a scheduled evaluation run.

Parameters
Name	Description
request	CreateScheduledEvaluationRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskScheduledEvaluationRun	The response to send back to the client (wrapped by a task).

DeleteEvaluation(DeleteEvaluationRequest, ServerCallContext)

public virtual Task<Empty> DeleteEvaluation(DeleteEvaluationRequest request, ServerCallContext context)

Deletes an evaluation.

Parameters
Name	Description
request	DeleteEvaluationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteEvaluationDataset(DeleteEvaluationDatasetRequest, ServerCallContext)

public virtual Task<Empty> DeleteEvaluationDataset(DeleteEvaluationDatasetRequest request, ServerCallContext context)

Deletes an evaluation dataset.

Parameters
Name	Description
request	DeleteEvaluationDatasetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteEvaluationExpectation(DeleteEvaluationExpectationRequest, ServerCallContext)

public virtual Task<Empty> DeleteEvaluationExpectation(DeleteEvaluationExpectationRequest request, ServerCallContext context)

Deletes an evaluation expectation.

Parameters
Name	Description
request	DeleteEvaluationExpectationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteEvaluationResult(DeleteEvaluationResultRequest, ServerCallContext)

public virtual Task<Empty> DeleteEvaluationResult(DeleteEvaluationResultRequest request, ServerCallContext context)

Deletes an evaluation result.

Parameters
Name	Description
request	DeleteEvaluationResultRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

DeleteEvaluationRun(DeleteEvaluationRunRequest, ServerCallContext)

public virtual Task<Operation> DeleteEvaluationRun(DeleteEvaluationRunRequest request, ServerCallContext context)

Deletes an evaluation run.

Parameters
Name	Description
request	DeleteEvaluationRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

DeleteScheduledEvaluationRun(DeleteScheduledEvaluationRunRequest, ServerCallContext)

public virtual Task<Empty> DeleteScheduledEvaluationRun(DeleteScheduledEvaluationRunRequest request, ServerCallContext context)

Deletes a scheduled evaluation run.

Parameters
Name	Description
request	DeleteScheduledEvaluationRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEmpty	The response to send back to the client (wrapped by a task).

GenerateEvaluation(GenerateEvaluationRequest, ServerCallContext)

public virtual Task<Operation> GenerateEvaluation(GenerateEvaluationRequest request, ServerCallContext context)

Creates a golden evaluation from a conversation.

Parameters
Name	Description
request	GenerateEvaluationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

GetEvaluation(GetEvaluationRequest, ServerCallContext)

public virtual Task<Evaluation> GetEvaluation(GetEvaluationRequest request, ServerCallContext context)

Gets details of the specified evaluation.

Parameters
Name	Description
request	GetEvaluationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluation	The response to send back to the client (wrapped by a task).

GetEvaluationDataset(GetEvaluationDatasetRequest, ServerCallContext)

public virtual Task<EvaluationDataset> GetEvaluationDataset(GetEvaluationDatasetRequest request, ServerCallContext context)

Gets details of the specified evaluation dataset.

Parameters
Name	Description
request	GetEvaluationDatasetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluationDataset	The response to send back to the client (wrapped by a task).

GetEvaluationExpectation(GetEvaluationExpectationRequest, ServerCallContext)

public virtual Task<EvaluationExpectation> GetEvaluationExpectation(GetEvaluationExpectationRequest request, ServerCallContext context)

Gets details of the specified evaluation expectation.

Parameters
Name	Description
request	GetEvaluationExpectationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluationExpectation	The response to send back to the client (wrapped by a task).

GetEvaluationResult(GetEvaluationResultRequest, ServerCallContext)

public virtual Task<EvaluationResult> GetEvaluationResult(GetEvaluationResultRequest request, ServerCallContext context)

Gets details of the specified evaluation result.

Parameters
Name	Description
request	GetEvaluationResultRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluationResult	The response to send back to the client (wrapped by a task).

GetEvaluationRun(GetEvaluationRunRequest, ServerCallContext)

public virtual Task<EvaluationRun> GetEvaluationRun(GetEvaluationRunRequest request, ServerCallContext context)

Gets details of the specified evaluation run.

Parameters
Name	Description
request	GetEvaluationRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluationRun	The response to send back to the client (wrapped by a task).

GetScheduledEvaluationRun(GetScheduledEvaluationRunRequest, ServerCallContext)

public virtual Task<ScheduledEvaluationRun> GetScheduledEvaluationRun(GetScheduledEvaluationRunRequest request, ServerCallContext context)

Gets details of the specified scheduled evaluation run.

Parameters
Name	Description
request	GetScheduledEvaluationRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskScheduledEvaluationRun	The response to send back to the client (wrapped by a task).

ImportEvaluations(ImportEvaluationsRequest, ServerCallContext)

public virtual Task<Operation> ImportEvaluations(ImportEvaluationsRequest request, ServerCallContext context)

Imports evaluations into the app.

Parameters
Name	Description
request	ImportEvaluationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

ListEvaluationDatasets(ListEvaluationDatasetsRequest, ServerCallContext)

public virtual Task<ListEvaluationDatasetsResponse> ListEvaluationDatasets(ListEvaluationDatasetsRequest request, ServerCallContext context)

Lists all evaluation datasets in the given app.

Parameters
Name	Description
request	ListEvaluationDatasetsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListEvaluationDatasetsResponse	The response to send back to the client (wrapped by a task).

ListEvaluationExpectations(ListEvaluationExpectationsRequest, ServerCallContext)

public virtual Task<ListEvaluationExpectationsResponse> ListEvaluationExpectations(ListEvaluationExpectationsRequest request, ServerCallContext context)

Lists all evaluation expectations in the given app.

Parameters
Name	Description
request	ListEvaluationExpectationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListEvaluationExpectationsResponse	The response to send back to the client (wrapped by a task).

ListEvaluationResults(ListEvaluationResultsRequest, ServerCallContext)

public virtual Task<ListEvaluationResultsResponse> ListEvaluationResults(ListEvaluationResultsRequest request, ServerCallContext context)

Lists all evaluation results for a given evaluation.

Parameters
Name	Description
request	ListEvaluationResultsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListEvaluationResultsResponse	The response to send back to the client (wrapped by a task).

ListEvaluationRuns(ListEvaluationRunsRequest, ServerCallContext)

public virtual Task<ListEvaluationRunsResponse> ListEvaluationRuns(ListEvaluationRunsRequest request, ServerCallContext context)

Lists all evaluation runs in the given app.

Parameters
Name	Description
request	ListEvaluationRunsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListEvaluationRunsResponse	The response to send back to the client (wrapped by a task).

ListEvaluations(ListEvaluationsRequest, ServerCallContext)

public virtual Task<ListEvaluationsResponse> ListEvaluations(ListEvaluationsRequest request, ServerCallContext context)

Lists all evaluations in the given app.

Parameters
Name	Description
request	ListEvaluationsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListEvaluationsResponse	The response to send back to the client (wrapped by a task).

ListScheduledEvaluationRuns(ListScheduledEvaluationRunsRequest, ServerCallContext)

public virtual Task<ListScheduledEvaluationRunsResponse> ListScheduledEvaluationRuns(ListScheduledEvaluationRunsRequest request, ServerCallContext context)

Lists all scheduled evaluation runs in the given app.

Parameters
Name	Description
request	ListScheduledEvaluationRunsRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskListScheduledEvaluationRunsResponse	The response to send back to the client (wrapped by a task).

RunEvaluation(RunEvaluationRequest, ServerCallContext)

public virtual Task<Operation> RunEvaluation(RunEvaluationRequest request, ServerCallContext context)

Runs an evaluation of the app.

Parameters
Name	Description
request	RunEvaluationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskOperation	The response to send back to the client (wrapped by a task).

TestPersonaVoice(TestPersonaVoiceRequest, ServerCallContext)

public virtual Task<TestPersonaVoiceResponse> TestPersonaVoice(TestPersonaVoiceRequest request, ServerCallContext context)

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

Parameters
Name	Description
request	TestPersonaVoiceRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskTestPersonaVoiceResponse	The response to send back to the client (wrapped by a task).

UpdateEvaluation(UpdateEvaluationRequest, ServerCallContext)

public virtual Task<Evaluation> UpdateEvaluation(UpdateEvaluationRequest request, ServerCallContext context)

Updates an evaluation.

Parameters
Name	Description
request	UpdateEvaluationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluation	The response to send back to the client (wrapped by a task).

UpdateEvaluationDataset(UpdateEvaluationDatasetRequest, ServerCallContext)

public virtual Task<EvaluationDataset> UpdateEvaluationDataset(UpdateEvaluationDatasetRequest request, ServerCallContext context)

Updates an evaluation dataset.

Parameters
Name	Description
request	UpdateEvaluationDatasetRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluationDataset	The response to send back to the client (wrapped by a task).

UpdateEvaluationExpectation(UpdateEvaluationExpectationRequest, ServerCallContext)

public virtual Task<EvaluationExpectation> UpdateEvaluationExpectation(UpdateEvaluationExpectationRequest request, ServerCallContext context)

Updates an evaluation expectation.

Parameters
Name	Description
request	UpdateEvaluationExpectationRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskEvaluationExpectation	The response to send back to the client (wrapped by a task).

UpdateScheduledEvaluationRun(UpdateScheduledEvaluationRunRequest, ServerCallContext)

public virtual Task<ScheduledEvaluationRun> UpdateScheduledEvaluationRun(UpdateScheduledEvaluationRunRequest request, ServerCallContext context)

Updates a scheduled evaluation run.

Parameters
Name	Description
request	UpdateScheduledEvaluationRunRequest The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskScheduledEvaluationRun	The response to send back to the client (wrapped by a task).

UploadEvaluationAudio(UploadEvaluationAudioRequest, ServerCallContext)

public virtual Task<UploadEvaluationAudioResponse> UploadEvaluationAudio(UploadEvaluationAudioRequest request, ServerCallContext context)

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 The request received from the client.
context	ServerCallContext The context of the server-side call handler being invoked.

Returns
Type	Description
TaskUploadEvaluationAudioResponse	The response to send back to the client (wrapped by a task).