REST Resource: projects.locations.qaScorecards.revisions

Resource: QaScorecardRevision

A revision of a QaScorecard.

Modifying published scorecard fields would invalidate existing scorecard results — the questions may have changed, or the score weighting will make existing scores impossible to understand. So changes must create a new revision, rather than modifying the existing resource.

JSON representation
{
  "name": string,
  "snapshot": {
    object (QaScorecard)
  },
  "createTime": string,
  "alternateIds": [
    string
  ],
  "state": enum (State)
}
Fields
name

string

Identifier. The name of the scorecard revision. Format: projects/{project}/locations/{location}/qaScorecards/{qaScorecard}/revisions/{revision}

snapshot

object (QaScorecard)

The snapshot of the scorecard at the time of this revision's creation.

createTime

string (Timestamp format)

Output only. The timestamp that the revision was created.

A timestamp in RFC3339 UTC "Zulu" format, with nanosecond resolution and up to nine fractional digits. Examples: "2014-10-02T15:01:23Z" and "2014-10-02T15:01:23.045123456Z".

alternateIds[]

string

Output only. Alternative IDs for this revision of the scorecard, e.g., latest.

state

enum (State)

Output only. State of the scorecard revision, indicating whether it's ready to be used in analysis.

State

Enum representing the set of states a scorecard revision may be in.

Enums
STATE_UNSPECIFIED Unspecified.
EDITABLE The scorecard revision can be edited.
TRAINING Scorecard model training is in progress.
TRAINING_FAILED Scorecard revision model training failed.
READY The revision can be used in analysis.
DELETING Scorecard is being deleted.
TRAINING_CANCELLED Scorecard model training was explicitly cancelled by the user.

Methods

create

Creates a QaScorecardRevision.

delete

Deletes a QaScorecardRevision.

deploy

Deploy a QaScorecardRevision.

get

Gets a QaScorecardRevision.

list

Lists all revisions under the parent QaScorecard.

tuneQaScorecardRevision

Fine tune one or more QaModels.

undeploy

Undeploy a QaScorecardRevision.