Close httplib2 connections.
Deletes a diagnostic.
Gets a diagnostic.
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists diagnostics.
Retrieves the next page of results.
close()
Close httplib2 connections.
delete(name, x__xgafv=None)
Deletes a diagnostic.
Args:
name: string, Required. The name of the diagnostic 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)
Gets a diagnostic.
Args:
name: string, Required. The name of the diagnostic to retrieve. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The diagnostic resource.
"analysisSummary": "A String", # Output only. The complete sequence of thoughts and actions taken by the agent.
"conversationFilter": "A String", # Output only. The filter used to select the conversations that were included in the diagnostic.
"createTime": "A String", # Output only. The time at which the diagnostic was created.
"name": "A String", # Immutable. Identifier. The resource name of the diagnostic.
"report": { # A diagnostic report containing aggregate metrics and intent breakdowns. # Output only. The report containing the findings of the diagnostic.
"intentStats": [ # Output only. A breakdown of metrics grouped by intent.
{ # A breakdown of metrics grouped by intent.
"conversationCount": 42, # Output only. The number of conversations associated with this intent.
"intentDisplayName": "A String", # Output only. The display name of the intent.
"intentId": "A String", # Output only. The unique identifier for the intent (from Discovery Engine).
"lossPatterns": [ # Output only. A list of loss patterns identified for this intent.
{ # A loss pattern of a virtual agent and suggested fixes.
"conversationIds": [ # Output only. A list of conversation IDs that match this loss pattern.
"A String",
],
"description": "A String", # Output only. A markdown description of the loss pattern.
"displayName": "A String", # Output only. The display name of the loss pattern.
"examples": "A String", # Output only. A markdown of loss pattern examples.
"id": "A String", # Output only. The unique identifier for the loss pattern.
"percentage": 3.14, # Output only. The percentage of conversations that match this loss pattern.
"suggestedFixes": "A String", # Output only. A markdown description of the suggested fixes.
},
],
"metrics": { # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
"a_key": { # Deprecated: MetricValue is no longer used for diagnostics.
"conversations": [ # Output only. The list of conversation names that contributed to this metric (hits). Format: `projects/{project}/locations/{location}/conversations/{conversation}`
"A String",
],
"displayName": "A String", # Output only. The user-visible name of the metric (e.g., "Containment Rate").
"hitCount": 42, # Output only. The number of positive matches (hits) for this metric.
"metricType": "A String", # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
"sourceId": "A String", # Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.
"totalCount": 42, # Output only. The total number of items evaluated for this metric.
"value": 3.14, # Output only. The calculated value of the metric (usually a ratio or rate 0.0 - 1.0).
},
},
},
],
"lossPatterns": [ # Output only. A list of loss patterns identified for the entire project/dataset.
{ # A loss pattern of a virtual agent and suggested fixes.
"conversationIds": [ # Output only. A list of conversation IDs that match this loss pattern.
"A String",
],
"description": "A String", # Output only. A markdown description of the loss pattern.
"displayName": "A String", # Output only. The display name of the loss pattern.
"examples": "A String", # Output only. A markdown of loss pattern examples.
"id": "A String", # Output only. The unique identifier for the loss pattern.
"percentage": 3.14, # Output only. The percentage of conversations that match this loss pattern.
"suggestedFixes": "A String", # Output only. A markdown description of the suggested fixes.
},
],
"metrics": { # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
"a_key": { # Deprecated: MetricValue is no longer used for diagnostics.
"conversations": [ # Output only. The list of conversation names that contributed to this metric (hits). Format: `projects/{project}/locations/{location}/conversations/{conversation}`
"A String",
],
"displayName": "A String", # Output only. The user-visible name of the metric (e.g., "Containment Rate").
"hitCount": 42, # Output only. The number of positive matches (hits) for this metric.
"metricType": "A String", # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
"sourceId": "A String", # Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.
"totalCount": 42, # Output only. The total number of items evaluated for this metric.
"value": 3.14, # Output only. The calculated value of the metric (usually a ratio or rate 0.0 - 1.0).
},
},
},
}
list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)
Lists diagnostics.
Args:
parent: string, Required. The parent resource of the diagnostics. (required)
filter: string, Optional. A filter to apply to the list (e.g. `create_time > "2023-01-01T00:00:00Z"`).
pageSize: integer, Optional. The maximum number of diagnostics to return. The service may return fewer than this value. If unspecified, at most 100 diagnostics will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A page token, received from a previous `ListDiagnostics` call. Provide this to retrieve the subsequent page.
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 ListDiagnostics request.
"diagnostics": [ # Optional. The diagnostics that match the request.
{ # The diagnostic resource.
"analysisSummary": "A String", # Output only. The complete sequence of thoughts and actions taken by the agent.
"conversationFilter": "A String", # Output only. The filter used to select the conversations that were included in the diagnostic.
"createTime": "A String", # Output only. The time at which the diagnostic was created.
"name": "A String", # Immutable. Identifier. The resource name of the diagnostic.
"report": { # A diagnostic report containing aggregate metrics and intent breakdowns. # Output only. The report containing the findings of the diagnostic.
"intentStats": [ # Output only. A breakdown of metrics grouped by intent.
{ # A breakdown of metrics grouped by intent.
"conversationCount": 42, # Output only. The number of conversations associated with this intent.
"intentDisplayName": "A String", # Output only. The display name of the intent.
"intentId": "A String", # Output only. The unique identifier for the intent (from Discovery Engine).
"lossPatterns": [ # Output only. A list of loss patterns identified for this intent.
{ # A loss pattern of a virtual agent and suggested fixes.
"conversationIds": [ # Output only. A list of conversation IDs that match this loss pattern.
"A String",
],
"description": "A String", # Output only. A markdown description of the loss pattern.
"displayName": "A String", # Output only. The display name of the loss pattern.
"examples": "A String", # Output only. A markdown of loss pattern examples.
"id": "A String", # Output only. The unique identifier for the loss pattern.
"percentage": 3.14, # Output only. The percentage of conversations that match this loss pattern.
"suggestedFixes": "A String", # Output only. A markdown description of the suggested fixes.
},
],
"metrics": { # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
"a_key": { # Deprecated: MetricValue is no longer used for diagnostics.
"conversations": [ # Output only. The list of conversation names that contributed to this metric (hits). Format: `projects/{project}/locations/{location}/conversations/{conversation}`
"A String",
],
"displayName": "A String", # Output only. The user-visible name of the metric (e.g., "Containment Rate").
"hitCount": 42, # Output only. The number of positive matches (hits) for this metric.
"metricType": "A String", # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
"sourceId": "A String", # Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.
"totalCount": 42, # Output only. The total number of items evaluated for this metric.
"value": 3.14, # Output only. The calculated value of the metric (usually a ratio or rate 0.0 - 1.0).
},
},
},
],
"lossPatterns": [ # Output only. A list of loss patterns identified for the entire project/dataset.
{ # A loss pattern of a virtual agent and suggested fixes.
"conversationIds": [ # Output only. A list of conversation IDs that match this loss pattern.
"A String",
],
"description": "A String", # Output only. A markdown description of the loss pattern.
"displayName": "A String", # Output only. The display name of the loss pattern.
"examples": "A String", # Output only. A markdown of loss pattern examples.
"id": "A String", # Output only. The unique identifier for the loss pattern.
"percentage": 3.14, # Output only. The percentage of conversations that match this loss pattern.
"suggestedFixes": "A String", # Output only. A markdown description of the suggested fixes.
},
],
"metrics": { # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
"a_key": { # Deprecated: MetricValue is no longer used for diagnostics.
"conversations": [ # Output only. The list of conversation names that contributed to this metric (hits). Format: `projects/{project}/locations/{location}/conversations/{conversation}`
"A String",
],
"displayName": "A String", # Output only. The user-visible name of the metric (e.g., "Containment Rate").
"hitCount": 42, # Output only. The number of positive matches (hits) for this metric.
"metricType": "A String", # Output only. Deprecated: The type of the metric. Metrics for Outcome Based Insights derived from QueryMetrics.
"sourceId": "A String", # Output only. The resource name of the underlying Insights primitive (e.g., Tag or QaQuestion) used to calculate this metric.
"totalCount": 42, # Output only. The total number of items evaluated for this metric.
"value": 3.14, # Output only. The calculated value of the metric (usually a ratio or rate 0.0 - 1.0).
},
},
},
},
],
"nextPageToken": "A String", # Optional. 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.