appeal(name, body=None, x__xgafv=None)

Appeal an Assessment.

Args:
  name: string, Required. The name of the assessment to appeal. (required)
  body: object, The request body.
    The object takes the form of:

{ # The message to appeal an assessment.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The assessment resource.
  "agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for.
    "agentId": "A String", # A user-specified string representing the agent.
    "agentType": "A String", # The agent type, e.g. HUMAN_AGENT.
    "displayName": "A String", # The agent's name.
    "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
    "location": "A String", # The agent's location.
    "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
    "teams": [ # User-specified strings representing the agent's teams.
      "A String",
    ],
  },
  "createTime": "A String", # Output only. The time at which the assessment was created.
  "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}
  "state": "A String", # Output only. The state of the assessment.
  "updateTime": "A String", # Output only. The time at which the assessment was last updated.
}

close()

Close httplib2 connections.

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

Create Assessment.

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

{ # The assessment resource.
  "agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for.
    "agentId": "A String", # A user-specified string representing the agent.
    "agentType": "A String", # The agent type, e.g. HUMAN_AGENT.
    "displayName": "A String", # The agent's name.
    "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
    "location": "A String", # The agent's location.
    "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
    "teams": [ # User-specified strings representing the agent's teams.
      "A String",
    ],
  },
  "createTime": "A String", # Output only. The time at which the assessment was created.
  "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}
  "state": "A String", # Output only. The state of the assessment.
  "updateTime": "A String", # Output only. The time at which the assessment was last updated.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The assessment resource.
  "agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for.
    "agentId": "A String", # A user-specified string representing the agent.
    "agentType": "A String", # The agent type, e.g. HUMAN_AGENT.
    "displayName": "A String", # The agent's name.
    "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
    "location": "A String", # The agent's location.
    "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
    "teams": [ # User-specified strings representing the agent's teams.
      "A String",
    ],
  },
  "createTime": "A String", # Output only. The time at which the assessment was created.
  "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}
  "state": "A String", # Output only. The state of the assessment.
  "updateTime": "A String", # Output only. The time at which the assessment was last updated.
}

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

Delete an Assessment.

Args:
  name: string, Required. The name of the assessment to delete. (required)
  force: boolean, Optional. If set to true, all of this assessment's notes will also be deleted. Otherwise, the request will only succeed if it has no notes.
  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); }
}

finalize(name, body=None, x__xgafv=None)

Finalize an Assessment.

Args:
  name: string, Required. The name of the assessment to finalize. (required)
  body: object, The request body.
    The object takes the form of:

{ # The message to finalize an assessment. Finalizing makes an assessment and its notes immutable.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The assessment resource.
  "agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for.
    "agentId": "A String", # A user-specified string representing the agent.
    "agentType": "A String", # The agent type, e.g. HUMAN_AGENT.
    "displayName": "A String", # The agent's name.
    "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
    "location": "A String", # The agent's location.
    "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
    "teams": [ # User-specified strings representing the agent's teams.
      "A String",
    ],
  },
  "createTime": "A String", # Output only. The time at which the assessment was created.
  "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}
  "state": "A String", # Output only. The state of the assessment.
  "updateTime": "A String", # Output only. The time at which the assessment was last updated.
}

get(name, x__xgafv=None)

Get Assessment.

Args:
  name: string, Required. The name of the assessment 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:

    { # The assessment resource.
  "agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for.
    "agentId": "A String", # A user-specified string representing the agent.
    "agentType": "A String", # The agent type, e.g. HUMAN_AGENT.
    "displayName": "A String", # The agent's name.
    "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
    "location": "A String", # The agent's location.
    "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
    "teams": [ # User-specified strings representing the agent's teams.
      "A String",
    ],
  },
  "createTime": "A String", # Output only. The time at which the assessment was created.
  "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}
  "state": "A String", # Output only. The state of the assessment.
  "updateTime": "A String", # Output only. The time at which the assessment was last updated.
}

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

List Assessments.

Args:
  parent: string, Required. The parent resource of the assessments. To list all assessments in a location, substitute the conversation ID with a '-' character. (required)
  filter: string, Optional. A filter to reduce results to a specific subset. Supported filters include: * `state` - The state of the assessment * `agent_info.agent_id` - The ID of the agent the assessment is for
  pageSize: integer, The maximum number of assessments to list. If zero, the service will select a default size. A call may 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 `ListAssessmentRulesResponse`; indicates that this is a continuation of a prior `ListAssessmentRules` call and 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 of listing assessments.
  "assessments": [ # The assessments that match the request.
    { # The assessment resource.
      "agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for.
        "agentId": "A String", # A user-specified string representing the agent.
        "agentType": "A String", # The agent type, e.g. HUMAN_AGENT.
        "displayName": "A String", # The agent's name.
        "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
        "location": "A String", # The agent's location.
        "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
        "teams": [ # User-specified strings representing the agent's teams.
          "A String",
        ],
      },
      "createTime": "A String", # Output only. The time at which the assessment was created.
      "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}
      "state": "A String", # Output only. The state of the assessment.
      "updateTime": "A String", # Output only. The time at which the assessment was last updated.
    },
  ],
  "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.
}

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.

publish(name, body=None, x__xgafv=None)

Publish an Assessment.

Args:
  name: string, Required. The name of the assessment to publish. (required)
  body: object, The request body.
    The object takes the form of:

{ # The message to publish an assessment. Draft and appealed assessments can be published. Publishing simply changes the state of the assessment to published, allowing the console and authorized views to filter on the state.
}

  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The assessment resource.
  "agentInfo": { # Information about an agent involved in the conversation. # Information about the agent the assessment is for.
    "agentId": "A String", # A user-specified string representing the agent.
    "agentType": "A String", # The agent type, e.g. HUMAN_AGENT.
    "displayName": "A String", # The agent's name.
    "dispositionCode": "A String", # A user-provided string indicating the outcome of the agent's segment of the call.
    "location": "A String", # The agent's location.
    "team": "A String", # A user-specified string representing the agent's team. Deprecated in favor of the `teams` field.
    "teams": [ # User-specified strings representing the agent's teams.
      "A String",
    ],
  },
  "createTime": "A String", # Output only. The time at which the assessment was created.
  "name": "A String", # Identifier. The resource name of the assessment. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}
  "state": "A String", # Output only. The state of the assessment.
  "updateTime": "A String", # Output only. The time at which the assessment was last updated.
}

Contact Center AI Insights API . projects . locations . conversations . assessments

Instance Methods

Method Details