Generates a summary of predefined performance metrics for a set of conversations. Conversations can be specified by specifying a time window and an agent id, for now. The summary includes a comparison of metrics computed for conversations in the previous time period, and also a comparison with peers in the same time period.

Method Details

close()

Close httplib2 connections.

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

Create AuthorizedView

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

{ # An AuthorizedView represents a view of accessible Insights resources (for example, Conversation and Scorecard). Who have read access to the AuthorizedView resource will have access to these Insight resources as well.
"conversationFilter": "A String", # A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having *authorizedViews.get* access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations linked to the conversation) that this AuthorizedView has.
"createTime": "A String", # Output only. The time at which the authorized view was created.
"displayName": "A String", # Display Name. Limit 64 characters.
"name": "A String", # Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}
"updateTime": "A String", # Output only. The most recent time at which the authorized view was updated.
}

authorizedViewId: string, Optional. A unique ID for the new AuthorizedView. This ID will become the final component of the AuthorizedView'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-z]([a-z0-9-]{0,61}[a-z0-9])?$`. See aip.dev/122#resource-id-segments
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format

Returns:
An object of the form:

delete(name, x__xgafv=None)

Deletes an AuthorizedView.

Args:
  name: string, Required. The name of the AuthorizedView to delete. (required)
  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)

Get AuthorizedView

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

    { # An AuthorizedView represents a view of accessible Insights resources (for example, Conversation and Scorecard). Who have read access to the AuthorizedView resource will have access to these Insight resources as well.
  "conversationFilter": "A String", # A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having *authorizedViews.get* access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations linked to the conversation) that this AuthorizedView has.
  "createTime": "A String", # Output only. The time at which the authorized view was created.
  "displayName": "A String", # Display Name. Limit 64 characters.
  "name": "A String", # Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}
  "updateTime": "A String", # Output only. The most recent time at which the authorized view was updated.
}

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

List AuthorizedViewSets

Args:
  parent: string, Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned. (required)
  filter: string, Optional. The filter expression to filter authorized views listed in the response.
  orderBy: string, Optional. The order by expression to order authorized views listed in the response.
  pageSize: integer, Optional. The maximum number of view 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 `ListAuthorizedViewsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViews` 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 ListAuthorizedViews request.
  "authorizedViews": [ # The AuthorizedViews under the parent.
    { # An AuthorizedView represents a view of accessible Insights resources (for example, Conversation and Scorecard). Who have read access to the AuthorizedView resource will have access to these Insight resources as well.
      "conversationFilter": "A String", # A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having *authorizedViews.get* access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations linked to the conversation) that this AuthorizedView has.
      "createTime": "A String", # Output only. The time at which the authorized view was created.
      "displayName": "A String", # Display Name. Limit 64 characters.
      "name": "A String", # Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}
      "updateTime": "A String", # Output only. The most recent time at which the authorized view was 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.

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

Updates an AuthorizedView.

Args:
  name: string, Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view} (required)
  body: object, The request body.
    The object takes the form of:

{ # An AuthorizedView represents a view of accessible Insights resources (for example, Conversation and Scorecard). Who have read access to the AuthorizedView resource will have access to these Insight resources as well.
  "conversationFilter": "A String", # A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having *authorizedViews.get* access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations linked to the conversation) that this AuthorizedView has.
  "createTime": "A String", # Output only. The time at which the authorized view was created.
  "displayName": "A String", # Display Name. Limit 64 characters.
  "name": "A String", # Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}
  "updateTime": "A String", # Output only. The most recent time at which the authorized view was updated.
}

  updateMask: string, Optional. 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: * `conversation_filter` * `display_name`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # An AuthorizedView represents a view of accessible Insights resources (for example, Conversation and Scorecard). Who have read access to the AuthorizedView resource will have access to these Insight resources as well.
  "conversationFilter": "A String", # A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having *authorizedViews.get* access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations linked to the conversation) that this AuthorizedView has.
  "createTime": "A String", # Output only. The time at which the authorized view was created.
  "displayName": "A String", # Display Name. Limit 64 characters.
  "name": "A String", # Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}
  "updateTime": "A String", # Output only. The most recent time at which the authorized view was updated.
}

queryMetrics(location, body=None, x__xgafv=None)

Query metrics.

Args:
  location: string, Required. The location of the data. "projects/{project}/locations/{location}" (required)
  body: object, The request body.
    The object takes the form of:

{ # The request for querying metrics.
  "dimensions": [ # The dimensions that determine the grouping key for the query. Defaults to no dimension if this field is unspecified. If a dimension is specified, its key must also be specified. Each dimension's key must be unique. If a time granularity is also specified, metric values in the dimension will be bucketed by this granularity. Up to one dimension is supported for now.
    { # A dimension determines the grouping key for the query. In SQL terms, these would be part of both the "SELECT" and "GROUP BY" clauses.
      "agentDimensionMetadata": { # Metadata about the agent dimension. # Output only. Metadata about the agent dimension.
        "agentDisplayName": "A String", # Optional. The agent's name
        "agentId": "A String", # Optional. A user-specified string representing the agent.
        "agentTeam": "A String", # Optional. A user-specified string representing the agent's team.
      },
      "dimensionKey": "A String", # The key of the dimension.
      "issueDimensionMetadata": { # Metadata about the issue dimension. # Output only. Metadata about the issue dimension.
        "issueDisplayName": "A String", # The issue display name.
        "issueId": "A String", # The issue ID.
        "issueModelId": "A String", # The parent issue model ID.
      },
      "qaQuestionAnswerDimensionMetadata": { # Metadata about the QA question-answer dimension. This is useful for showing the answer distribution for questions for a given scorecard. # Output only. Metadata about the QA question-answer dimension.
        "answerValue": "A String", # Optional. The full body of the question.
        "qaQuestionId": "A String", # Optional. The QA question ID.
        "qaScorecardId": "A String", # Optional. The QA scorecard ID.
        "questionBody": "A String", # Optional. The full body of the question.
      },
      "qaQuestionDimensionMetadata": { # Metadata about the QA question dimension. # Output only. Metadata about the QA question dimension.
        "qaQuestionId": "A String", # Optional. The QA question ID.
        "qaScorecardId": "A String", # Optional. The QA scorecard ID.
        "questionBody": "A String", # Optional. The full body of the question.
      },
    },
  ],
  "filter": "A String", # Required. Filter to select a subset of conversations to compute the metrics. Must specify a window of the conversation create time to compute the metrics. The returned metrics will be from the range [DATE(starting create time), DATE(ending create time)).
  "measureMask": "A String", # Measures to return. Defaults to all measures if this field is unspecified. A valid mask should traverse from the `measure` field from the response. For example, a path from a measure mask to get the conversation count is "conversation_measure.count".
  "timeGranularity": "A String", # The time granularity of each data point in the time series. Defaults to NONE if this field is unspecified.
}

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

Returns:
  An object of the form:

    { # This resource represents a long-running operation that is the result of a network API call.
  "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
  "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
    "code": 42, # The status code, which should be an enum value of google.rpc.Code.
    "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
      {
        "a_key": "", # Properties of the object. Contains field @type with type URL.
      },
    ],
    "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
  },
  "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
  "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
  "response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
    "a_key": "", # Properties of the object. Contains field @type with type URL.
  },
}

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

Args:
parent: string, Required. The parent resource of the conversations to derive performance stats from. "projects/{project}/locations/{location}" (required)
body: object, The request body.
The object takes the form of:

{ # The request for summarizing performance according to different metrics for conversations over a specified time window.
"agentPerformanceSource": { # The entity whose performance is being queried is a single agent. # Conversations are from a single agent.
"agentId": "A String", # Required. Agent id to query performance overview for.
},
"comparisonQueryInterval": { # A time window for querying conversations. # The time window of the conversations to compare the performance to.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
"filter": "A String", # Optional. Filter to select a subset of conversations to compute the performance overview. Supports the same filters as the filter field in QueryMetricsRequest. The source and query interval/comparison query interval should not be included here.
"queryInterval": { # A time window for querying conversations. # Required. The time window of the conversations to derive performance stats from.
"endTime": "A String", # Required. The end time of the time window.
"startTime": "A String", # Required. The start time of the time window.
},
}

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

Returns:
An object of the form:

{ # This resource represents a long-running operation that is the result of a network API call.
"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.
"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.
},
"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.
"response": { # The normal, successful response of the operation. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}

search(parent, orderBy=None, pageSize=None, pageToken=None, query=None, x__xgafv=None)

SearchAuthorizedViewSets

Args:
  parent: string, Required. The parent resource of the AuthorizedViews. If the parent is set to `-`, all AuthorizedViews under the location will be returned. (required)
  orderBy: string, Optional. The order by expression to order authorized views listed in the response.
  pageSize: integer, Optional. The maximum number of view 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 `ListAuthorizedViewsResponse`. This value indicates that this is a continuation of a prior `ListAuthorizedViews` call and that the system should return the next page of data.
  query: string, Optional. The query expression to search authorized views.
  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 ListAuthorizedViews request.
  "authorizedViews": [ # The AuthorizedViews under the parent.
    { # An AuthorizedView represents a view of accessible Insights resources (for example, Conversation and Scorecard). Who have read access to the AuthorizedView resource will have access to these Insight resources as well.
      "conversationFilter": "A String", # A filter to reduce conversation results to a specific subset. The AuthorizedView's assigned permission (read/write) could be applied to the subset of conversations. If conversation_filter is empty, there is no restriction on the conversations that the AuthorizedView can access. Having *authorizedViews.get* access to the AuthorizedView means having the same read/write access to the Conversations (as well as metadata/annotations linked to the conversation) that this AuthorizedView has.
      "createTime": "A String", # Output only. The time at which the authorized view was created.
      "displayName": "A String", # Display Name. Limit 64 characters.
      "name": "A String", # Identifier. The resource name of the AuthorizedView. Format: projects/{project}/locations/{location}/authorizedViewSets/{authorized_view_set}/authorizedViews/{authorized_view}
      "updateTime": "A String", # Output only. The most recent time at which the authorized view was 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.
}

Contact Center AI Insights API . projects . locations . authorizedViewSets . authorizedViews

Instance Methods

Method Details