Method: projects.locations.apps.runEvaluation

Runs an evaluation of the app.

HTTP request

POST https://ces.googleapis.com/v1beta/{app=projects/*/locations/*/apps/*}:runEvaluation

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
app

string

Required. The app to evaluate. Format: projects/{project}/locations/{location}/apps/{app}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "evaluations": [
    string
  ],
  "evaluationDataset": string,
  "displayName": string,
  "appVersion": string,
  "config": {
    object (EvaluationConfig)
  },
  "personaRunConfigs": [
    {
      object (PersonaRunConfig)
    }
  ],
  "optimizationConfig": {
    object (OptimizationConfig)
  },
  "runCount": integer
}
Fields
evaluations[]

string

Optional. List of evaluations to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluations/{evaluation}
evaluationDataset

string

Optional. An evaluation dataset to run. Format: projects/{project}/locations/{location}/apps/{app}/evaluationDatasets/{evaluationDataset}
displayName

string

Optional. The display name of the evaluation run.
appVersion

string

Required. The app version to evaluate. Format: projects/{project}/locations/{location}/apps/{app}/versions/{version}
config

object (EvaluationConfig)

Optional. The configuration to use for the run.
personaRunConfigs[]

object (PersonaRunConfig)

Optional. The configuration to use for the run per persona.
optimizationConfig

object (OptimizationConfig)

Optional. Configuration for running the optimization step after the evaluation run. If not set, the optimization step will not be run.
runCount

integer

Optional. The number of times to run the evaluation. If not set, the default value is 1 per golden, and 5 per scenario.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.