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

close()

Close httplib2 connections.

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

Create feedback label.

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

{ # Represents a conversation, resource, and label provided by the user.
  "createTime": "A String", # Output only. Create time of the label.
  "label": "A String", # String label.
  "labeledResource": "A String", # Resource name of the resource to be labeled.
  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
  "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
    "boolValue": True or False, # Boolean value.
    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
    "naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
    "numValue": 3.14, # Numerical value.
    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
    "score": 3.14, # Output only. Numerical score of the answer.
    "strValue": "A String", # String value.
  },
  "updateTime": "A String", # Output only. Update time of the label.
}

  feedbackLabelId: string, Optional. The ID of the feedback label to create. If one is not specified it will be generated by the server.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a conversation, resource, and label provided by the user.
  "createTime": "A String", # Output only. Create time of the label.
  "label": "A String", # String label.
  "labeledResource": "A String", # Resource name of the resource to be labeled.
  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
  "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
    "boolValue": True or False, # Boolean value.
    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
    "naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
    "numValue": 3.14, # Numerical value.
    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
    "score": 3.14, # Output only. Numerical score of the answer.
    "strValue": "A String", # String value.
  },
  "updateTime": "A String", # Output only. Update time of the label.
}

delete(name, x__xgafv=None)

Delete feedback label.

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

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

    { # Represents a conversation, resource, and label provided by the user.
  "createTime": "A String", # Output only. Create time of the label.
  "label": "A String", # String label.
  "labeledResource": "A String", # Resource name of the resource to be labeled.
  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
  "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
    "boolValue": True or False, # Boolean value.
    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
    "naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
    "numValue": 3.14, # Numerical value.
    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
    "score": 3.14, # Output only. Numerical score of the answer.
    "strValue": "A String", # String value.
  },
  "updateTime": "A String", # Output only. Update time of the label.
}

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

List feedback labels.

Args:
  parent: string, Required. The parent resource of the feedback labels. (required)
  filter: string, Optional. A filter to reduce results to a specific subset. Supports disjunctions (OR) and conjunctions (AND). Automatically sorts by conversation ID. To sort by all feedback labels in a project see ListAllFeedbackLabels. Supported fields: * `issue_model_id` * `qa_question_id` * `qa_scorecard_id` * `min_create_time` * `max_create_time` * `min_update_time` * `max_update_time` * `feedback_label_type`: QUALITY_AI, TOPIC_MODELING
  pageSize: integer, Optional. The maximum number of feedback labels to return in the response. A valid page size ranges from 0 to 100,000 inclusive. If the page size is zero or unspecified, a default page size of 100 will be chosen. Note that a call might return fewer results than the requested page size.
  pageToken: string, Optional. The value returned by the last `ListFeedbackLabelsResponse`. This value indicates that this is a continuation of a prior `ListFeedbackLabels` 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 for listing feedback labels.
  "feedbackLabels": [ # The feedback labels that match the request.
    { # Represents a conversation, resource, and label provided by the user.
      "createTime": "A String", # Output only. Create time of the label.
      "label": "A String", # String label.
      "labeledResource": "A String", # Resource name of the resource to be labeled.
      "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
      "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
        "boolValue": True or False, # Boolean value.
        "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
        "naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
        "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
        "numValue": 3.14, # Numerical value.
        "potentialScore": 3.14, # Output only. The maximum potential score of the question.
        "score": 3.14, # Output only. Numerical score of the answer.
        "strValue": "A String", # String value.
      },
      "updateTime": "A String", # Output only. Update time of the label.
    },
  ],
  "nextPageToken": "A String", # The next page token.
}

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)

Update feedback label.

Args:
  name: string, Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label} (required)
  body: object, The request body.
    The object takes the form of:

{ # Represents a conversation, resource, and label provided by the user.
  "createTime": "A String", # Output only. Create time of the label.
  "label": "A String", # String label.
  "labeledResource": "A String", # Resource name of the resource to be labeled.
  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
  "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
    "boolValue": True or False, # Boolean value.
    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
    "naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
    "numValue": 3.14, # Numerical value.
    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
    "score": 3.14, # Output only. Numerical score of the answer.
    "strValue": "A String", # String value.
  },
  "updateTime": "A String", # Output only. Update time of the label.
}

  updateMask: string, Required. The list of fields to be updated.
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # Represents a conversation, resource, and label provided by the user.
  "createTime": "A String", # Output only. Create time of the label.
  "label": "A String", # String label.
  "labeledResource": "A String", # Resource name of the resource to be labeled.
  "name": "A String", # Immutable. Resource name of the FeedbackLabel. Format: projects/{project}/locations/{location}/conversations/{conversation}/feedbackLabels/{feedback_label}
  "qaAnswerLabel": { # Message for holding the value of a QaAnswer. QaQuestion.AnswerChoice defines the possible answer values for a question. # QaAnswer label.
    "boolValue": True or False, # Boolean value.
    "key": "A String", # A short string used as an identifier. Matches the value used in QaQuestion.AnswerChoice.key.
    "naValue": True or False, # A value of "Not Applicable (N/A)". Should only ever be `true`.
    "normalizedScore": 3.14, # Output only. Normalized score of the questions. Calculated as score / potential_score.
    "numValue": 3.14, # Numerical value.
    "potentialScore": 3.14, # Output only. The maximum potential score of the question.
    "score": 3.14, # Output only. Numerical score of the answer.
    "strValue": "A String", # String value.
  },
  "updateTime": "A String", # Output only. Update time of the label.
}