| <html><body> |
| <style> |
| |
| body, h1, h2, h3, div, span, p, pre, a { |
| margin: 0; |
| padding: 0; |
| border: 0; |
| font-weight: inherit; |
| font-style: inherit; |
| font-size: 100%; |
| font-family: inherit; |
| vertical-align: baseline; |
| } |
| |
| body { |
| font-size: 13px; |
| padding: 1em; |
| } |
| |
| h1 { |
| font-size: 26px; |
| margin-bottom: 1em; |
| } |
| |
| h2 { |
| font-size: 24px; |
| margin-bottom: 1em; |
| } |
| |
| h3 { |
| font-size: 20px; |
| margin-bottom: 1em; |
| margin-top: 1em; |
| } |
| |
| pre, code { |
| line-height: 1.5; |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| } |
| |
| pre { |
| margin-top: 0.5em; |
| } |
| |
| h1, h2, h3, p { |
| font-family: Arial, sans serif; |
| } |
| |
| h1, h2, h3 { |
| border-bottom: solid #CCC 1px; |
| } |
| |
| .toc_element { |
| margin-top: 0.5em; |
| } |
| |
| .firstline { |
| margin-left: 2 em; |
| } |
| |
| .method { |
| margin-top: 1em; |
| border: solid 1px #CCC; |
| padding: 1em; |
| background: #EEE; |
| } |
| |
| .details { |
| font-weight: bold; |
| font-size: 14px; |
| } |
| |
| </style> |
| |
| <h1><a href="contactcenterinsights_v1.html">Contact Center AI Insights API</a> . <a href="contactcenterinsights_v1.projects.html">projects</a> . <a href="contactcenterinsights_v1.projects.locations.html">locations</a> . <a href="contactcenterinsights_v1.projects.locations.conversations.html">conversations</a> . <a href="contactcenterinsights_v1.projects.locations.conversations.feedbackLabels.html">feedbackLabels</a></h1> |
| <h2>Instance Methods</h2> |
| <p class="toc_element"> |
| <code><a href="#close">close()</a></code></p> |
| <p class="firstline">Close httplib2 connections.</p> |
| <p class="toc_element"> |
| <code><a href="#create">create(parent, body=None, feedbackLabelId=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Create feedback label.</p> |
| <p class="toc_element"> |
| <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Delete feedback label.</p> |
| <p class="toc_element"> |
| <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| <p class="firstline">Get feedback label.</p> |
| <p class="toc_element"> |
| <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">List feedback labels.</p> |
| <p class="toc_element"> |
| <code><a href="#list_next">list_next()</a></code></p> |
| <p class="firstline">Retrieves the next page of results.</p> |
| <p class="toc_element"> |
| <code><a href="#patch">patch(name, body=None, updateMask=None, x__xgafv=None)</a></code></p> |
| <p class="firstline">Update feedback label.</p> |
| <h3>Method Details</h3> |
| <div class="method"> |
| <code class="details" id="close">close()</code> |
| <pre>Close httplib2 connections.</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="create">create(parent, body=None, feedbackLabelId=None, x__xgafv=None)</code> |
| <pre>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. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization. |
| "createTime": "A String", # Output only. Create time of the label. |
| "label": "A String", # String label used for Topic Modeling. |
| "labeledResource": "A String", # Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}` |
| "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 used for Quality AI example conversations. |
| "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. |
| "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. |
| "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. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization. |
| "createTime": "A String", # Output only. Create time of the label. |
| "label": "A String", # String label used for Topic Modeling. |
| "labeledResource": "A String", # Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}` |
| "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 used for Quality AI example conversations. |
| "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. |
| "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. |
| "strValue": "A String", # String value. |
| }, |
| "updateTime": "A String", # Output only. Update time of the label. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| <pre>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); } |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="get">get(name, x__xgafv=None)</code> |
| <pre>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. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization. |
| "createTime": "A String", # Output only. Create time of the label. |
| "label": "A String", # String label used for Topic Modeling. |
| "labeledResource": "A String", # Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}` |
| "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 used for Quality AI example conversations. |
| "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. |
| "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. |
| "strValue": "A String", # String value. |
| }, |
| "updateTime": "A String", # Output only. Update time of the label. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> |
| <pre>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. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization. |
| "createTime": "A String", # Output only. Create time of the label. |
| "label": "A String", # String label used for Topic Modeling. |
| "labeledResource": "A String", # Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}` |
| "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 used for Quality AI example conversations. |
| "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. |
| "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. |
| "strValue": "A String", # String value. |
| }, |
| "updateTime": "A String", # Output only. Update time of the label. |
| }, |
| ], |
| "nextPageToken": "A String", # The next page token. |
| }</pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="list_next">list_next()</code> |
| <pre>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. |
| </pre> |
| </div> |
| |
| <div class="method"> |
| <code class="details" id="patch">patch(name, body=None, updateMask=None, x__xgafv=None)</code> |
| <pre>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. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization. |
| "createTime": "A String", # Output only. Create time of the label. |
| "label": "A String", # String label used for Topic Modeling. |
| "labeledResource": "A String", # Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}` |
| "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 used for Quality AI example conversations. |
| "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. |
| "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. |
| "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. Can take the form of a string label or a QaAnswer label. QaAnswer labels are used for Quality AI example conversations. String labels are used for Topic Modeling. AgentAssistSummary labels are used for Agent Assist Summarization. |
| "createTime": "A String", # Output only. Create time of the label. |
| "label": "A String", # String label used for Topic Modeling. |
| "labeledResource": "A String", # Name of the resource to be labeled. Supported resources are: * `projects/{project}/locations/{location}/qaScorecards/{scorecard}/revisions/{revision}/qaQuestions/{question}` * `projects/{project}/locations/{location}/issueModels/{issue_model}` * `projects/{project}/locations/{location}/generators/{generator_id}` |
| "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 used for Quality AI example conversations. |
| "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. |
| "skipValue": True or False, # Output only. A value of "Skip". If provided, this field may only be set to `true`. If a question receives this answer, it will be excluded from any score calculations. This would mean that the question was not evaluated. |
| "strValue": "A String", # String value. |
| }, |
| "updateTime": "A String", # Output only. Update time of the label. |
| }</pre> |
| </div> |
| |
| </body></html> |
