Method: projects.locations.apps.importEvaluations

Imports evaluations into the app.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
parent

string

Required. The app to import the evaluations into. Format: projects/{project}/locations/{location}/apps/{app}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "importOptions": {
    object (ImportEvaluationsRequest.ImportOptions)
  },

  // Union field source can be only one of the following:
  "conversationList": {
    object (ImportEvaluationsRequest.ConversationList)
  },
  "gcsUri": string,
  "csvContent": string
  // End of list of possible types for union field source.
}
Fields
importOptions

object (ImportEvaluationsRequest.ImportOptions)

Optional. Options governing the import process for the evaluations.
Union field source. The source of the evaluations to import from. source can be only one of the following:
conversationList

object (ImportEvaluationsRequest.ConversationList)

The conversations to import the evaluations from.
gcsUri

string

The Google Cloud Storage URI from which to import evaluations. The format of this URI must be gs://<bucket-name>/<object-name>.
csvContent

string (bytes format)

Raw bytes representing the csv file with the evaluations structure.

A base64-encoded string.

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.

IAM Permissions

Requires the following IAM permissions on the parent resource:

  • ces.evaluations.create
  • ces.evaluations.update

For more information, see the IAM documentation.

ImportEvaluationsRequest.ConversationList

A list of conversation resource names.

JSON representation 
{
  "conversations": [
    string
  ]
}
Fields
conversations[]

string

Optional. Conversation resource names.

ImportEvaluationsRequest.ImportOptions

Configuration options for the evaluation import process. These options control how the import behaves, particularly when conflicts arise with existing evaluations data.

JSON representation 
{
  "conflictResolutionStrategy": enum (ImportEvaluationsRequest.ImportOptions.ConflictResolutionStrategy)
}
Fields
conflictResolutionStrategy

enum (ImportEvaluationsRequest.ImportOptions.ConflictResolutionStrategy)

Optional. The strategy to use when resolving conflicts during import.

ImportEvaluationsRequest.ImportOptions.ConflictResolutionStrategy

Defines the strategy for handling conflicts when an evaluation with the same evaluation ID already exists in the app.

Enums
CONFLICT_RESOLUTION_STRATEGY_UNSPECIFIED The conflict resolution strategy is unspecified.
OVERWRITE Overwrite the existing evaluation with the new one.
SKIP Keep the existing evaluation and skip the new one.
DUPLICATE Keep the existing evaluation and duplicate the new one as a new evaluation.