create(parent, body=None, qaScorecardId=None, x__xgafv=None)

Create a QaScorecard.

Args:
  parent: string, Required. The parent resource of the QaScorecard. (required)
  body: object, The request body.
    The object takes the form of:

{ # A QaScorecard represents a collection of questions to be scored during analysis.
  "createTime": "A String", # Output only. The time at which this scorecard was created.
  "description": "A String", # A text description explaining the intent of the scorecard.
  "displayName": "A String", # The user-specified display name of the scorecard.
  "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
  "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
}

  qaScorecardId: string, Optional. A unique ID for the new QaScorecard. This ID will become the final component of the QaScorecard's resource name. If no ID is specified, a server-generated ID will be used. This value should be 4-64 characters and must match the regular expression `^[a-z0-9-]{4,64}$`. Valid characters are `a-z-`.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A QaScorecard represents a collection of questions to be scored during analysis.
  "createTime": "A String", # Output only. The time at which this scorecard was created.
  "description": "A String", # A text description explaining the intent of the scorecard.
  "displayName": "A String", # The user-specified display name of the scorecard.
  "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
  "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
}

delete(name, force=None, x__xgafv=None)

Deletes a QaScorecard.

Args:
  name: string, Required. The name of the QaScorecard to delete. (required)
  force: boolean, Optional. If set to true, all of this QaScorecard's child resources will also be deleted. Otherwise, the request will only succeed if it has none.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); }
}

get(name, x__xgafv=None)

Gets a QaScorecard.

Args:
  name: string, Required. The name of the QaScorecard to get. (required)
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A QaScorecard represents a collection of questions to be scored during analysis.
  "createTime": "A String", # Output only. The time at which this scorecard was created.
  "description": "A String", # A text description explaining the intent of the scorecard.
  "displayName": "A String", # The user-specified display name of the scorecard.
  "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
  "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
}

list(parent, pageSize=None, pageToken=None, x__xgafv=None)

Lists QaScorecards.

Args:
  parent: string, Required. The parent resource of the scorecards. (required)
  pageSize: integer, Optional. The maximum number of scorecards to return in the response. If the value is zero, the service will select a default size. A call might return fewer objects than requested. A non-empty `next_page_token` in the response indicates that more data is available.
  pageToken: string, Optional. The value returned by the last `ListQaScorecardsResponse`. This value indicates that this is a continuation of a prior `ListQaScorecards` call and that the system should return the next page of data.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The response from a ListQaScorecards request.
  "nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.
  "qaScorecards": [ # The QaScorecards under the parent.
    { # A QaScorecard represents a collection of questions to be scored during analysis.
      "createTime": "A String", # Output only. The time at which this scorecard was created.
      "description": "A String", # A text description explaining the intent of the scorecard.
      "displayName": "A String", # The user-specified display name of the scorecard.
      "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
      "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
    },
  ],
}

list_next()

Retrieves the next page of results.

        Args:
          previous_request: The request for the previous page. (required)
          previous_response: The response from the request for the previous page. (required)

        Returns:
          A request object that you can call 'execute()' on to request the next
          page. Returns None if there are no more items in the collection.

patch(name, body=None, updateMask=None, x__xgafv=None)

Updates a QaScorecard.

Args:
  name: string, Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard} (required)
  body: object, The request body.
    The object takes the form of:

{ # A QaScorecard represents a collection of questions to be scored during analysis.
  "createTime": "A String", # Output only. The time at which this scorecard was created.
  "description": "A String", # A text description explaining the intent of the scorecard.
  "displayName": "A String", # The user-specified display name of the scorecard.
  "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
  "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
}

  updateMask: string, Required. The list of fields to be updated. All possible fields can be updated by passing `*`, or a subset of the following updateable fields can be provided: * `description` * `display_name`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # A QaScorecard represents a collection of questions to be scored during analysis.
  "createTime": "A String", # Output only. The time at which this scorecard was created.
  "description": "A String", # A text description explaining the intent of the scorecard.
  "displayName": "A String", # The user-specified display name of the scorecard.
  "name": "A String", # Identifier. The scorecard name. Format: projects/{project}/locations/{location}/qaScorecards/{qa_scorecard}
  "updateTime": "A String", # Output only. The most recent time at which the scorecard was updated.
}

Contact Center AI Insights API . projects . locations . qaScorecards

Instance Methods

Method Details