REST Resource: projects.locations.authorizedViewSets.authorizedViews.conversations.assessments.notes

Resource: Note

The conversation assessment note resource.

JSON representation
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "noteCreator": {
    object (UserInfo)
  },

  // Union field note_type can be only one of the following:
  "conversationTurnNote": {
    object (ConversationTurnNote)
  },
  "qaQuestionNote": {
    object (QaQuestionNote)
  },
  "assessmentNote": {
    object (AssessmentNote)
  }
  // End of list of possible types for union field note_type.
  "content": string
}
Fields
name

string

Identifier. The resource name of the note. Format: projects/{project}/locations/{location}/conversations/{conversation}/assessments/{assessment}/notes/{note}

createTime

string (Timestamp format)

Output only. The time at which the note was created.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

updateTime

string (Timestamp format)

Output only. The time at which the note was last updated.

Uses RFC 3339, where generated output will always be Z-normalized and uses 0, 3, 6 or 9 fractional digits. Offsets other than "Z" are also accepted. Examples: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" or "2014-10-02T15:01:23+05:30".

noteCreator

object (UserInfo)

Output only. The user that created the note.

Union field note_type. The type of the note. note_type can be only one of the following:
conversationTurnNote

object (ConversationTurnNote)

The note is associated with a conversation turn.

qaQuestionNote

object (QaQuestionNote)

The note is associated with a QA question in one of the conversation's scorecard results.

assessmentNote

object (AssessmentNote)

The note is associated to the entire parent assessment.

content

string

The note content.

ConversationTurnNote

A note about a conversation turn.

JSON representation
{
  "turnIndex": integer
}
Fields
turnIndex

integer

The conversation turn index that the note is associated with.

QaQuestionNote

A note about a QA question.

JSON representation
{
  "qaQuestion": string
}
Fields
qaQuestion

string

The question resource that the note is associated with.

AssessmentNote

This type has no fields.

A note about the entire parent assessment.

UserInfo

Information about a user.

JSON representation
{
  "username": string
}
Fields
username

string

The user's username.

Methods

create

Create Note.

delete

Deletes a Note.

list

List Notes.

patch

Update Note.