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

close()

Close httplib2 connections.

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

Create Note.

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

{ # The conversation assessment note resource.
  "assessmentNote": { # A note about the entire parent assessment. # The note is associated to the entire parent assessment.
  },
  "content": "A String", # The note content.
  "conversationTurnNote": { # A note about a conversation turn. # The note is associated with a conversation turn.
    "turnIndex": 42, # The conversation turn index that the note is associated with.
  },
  "createTime": "A String", # Output only. The time at which the note was created.
  "name": "A String", # Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}
  "noteCreator": { # Information about a user. # Output only. The user that created the note.
    "username": "A String", # The user's username.
  },
  "qaQuestionNote": { # A note about a QA question. # The note is associated with a QA question in one of the conversation's scorecard results.
    "qaQuestion": "A String", # The question resource that the note is associated with.
  },
  "updateTime": "A String", # Output only. The time at which the note 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 conversation assessment note resource.
  "assessmentNote": { # A note about the entire parent assessment. # The note is associated to the entire parent assessment.
  },
  "content": "A String", # The note content.
  "conversationTurnNote": { # A note about a conversation turn. # The note is associated with a conversation turn.
    "turnIndex": 42, # The conversation turn index that the note is associated with.
  },
  "createTime": "A String", # Output only. The time at which the note was created.
  "name": "A String", # Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}
  "noteCreator": { # Information about a user. # Output only. The user that created the note.
    "username": "A String", # The user's username.
  },
  "qaQuestionNote": { # A note about a QA question. # The note is associated with a QA question in one of the conversation's scorecard results.
    "qaQuestion": "A String", # The question resource that the note is associated with.
  },
  "updateTime": "A String", # Output only. The time at which the note was last updated.
}

delete(name, x__xgafv=None)

Deletes a Note.

Args:
  name: string, Required. The name of the note 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); }
}

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

List Notes.

Args:
  parent: string, Required. The parent resource of the notes. (required)
  pageSize: integer, Optional. The maximum number of notes to return in the response. If 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 `ListNotesResponse`. This value indicates that this is a continuation of a prior `ListNotes` 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 of listing notes.
  "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.
  "notes": [ # The notes that match the request.
    { # The conversation assessment note resource.
      "assessmentNote": { # A note about the entire parent assessment. # The note is associated to the entire parent assessment.
      },
      "content": "A String", # The note content.
      "conversationTurnNote": { # A note about a conversation turn. # The note is associated with a conversation turn.
        "turnIndex": 42, # The conversation turn index that the note is associated with.
      },
      "createTime": "A String", # Output only. The time at which the note was created.
      "name": "A String", # Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}
      "noteCreator": { # Information about a user. # Output only. The user that created the note.
        "username": "A String", # The user's username.
      },
      "qaQuestionNote": { # A note about a QA question. # The note is associated with a QA question in one of the conversation's scorecard results.
        "qaQuestion": "A String", # The question resource that the note is associated with.
      },
      "updateTime": "A String", # Output only. The time at which the note was last updated.
    },
  ],
}

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 Note.

Args:
  name: string, Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note} (required)
  body: object, The request body.
    The object takes the form of:

{ # The conversation assessment note resource.
  "assessmentNote": { # A note about the entire parent assessment. # The note is associated to the entire parent assessment.
  },
  "content": "A String", # The note content.
  "conversationTurnNote": { # A note about a conversation turn. # The note is associated with a conversation turn.
    "turnIndex": 42, # The conversation turn index that the note is associated with.
  },
  "createTime": "A String", # Output only. The time at which the note was created.
  "name": "A String", # Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}
  "noteCreator": { # Information about a user. # Output only. The user that created the note.
    "username": "A String", # The user's username.
  },
  "qaQuestionNote": { # A note about a QA question. # The note is associated with a QA question in one of the conversation's scorecard results.
    "qaQuestion": "A String", # The question resource that the note is associated with.
  },
  "updateTime": "A String", # Output only. The time at which the note was last updated.
}

  updateMask: string, Optional. The list of fields to be updated. If the update_mask is empty, all updateable fields will be updated. Acceptable fields include: * `content`
  x__xgafv: string, V1 error format.
    Allowed values
      1 - v1 error format
      2 - v2 error format

Returns:
  An object of the form:

    { # The conversation assessment note resource.
  "assessmentNote": { # A note about the entire parent assessment. # The note is associated to the entire parent assessment.
  },
  "content": "A String", # The note content.
  "conversationTurnNote": { # A note about a conversation turn. # The note is associated with a conversation turn.
    "turnIndex": 42, # The conversation turn index that the note is associated with.
  },
  "createTime": "A String", # Output only. The time at which the note was created.
  "name": "A String", # Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}
  "noteCreator": { # Information about a user. # Output only. The user that created the note.
    "username": "A String", # The user's username.
  },
  "qaQuestionNote": { # A note about a QA question. # The note is associated with a QA question in one of the conversation's scorecard results.
    "qaQuestion": "A String", # The question resource that the note is associated with.
  },
  "updateTime": "A String", # Output only. The time at which the note was last updated.
}