feedback_messages
Creates, updates, deletes, gets or lists a feedback_messages
resource.
Overview
Name | feedback_messages |
Type | Resource |
Id | google.datalabeling.feedback_messages |
Fields
The following fields are returned by SELECT
queries:
- projects_datasets_annotated_datasets_feedback_threads_feedback_messages_get
- projects_datasets_annotated_datasets_feedback_threads_feedback_messages_list
Successful response
Name | Datatype | Description |
---|---|---|
name | string | Name of the feedback message in a feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessage/{feedback_message_id}' |
body | string | String content of the feedback. Maximum of 10000 characters. |
createTime | string (google-datetime) | Create time. |
image | string (byte) | The image storing this feedback if the feedback is an image representing operator's comments. |
operatorFeedbackMetadata | object | Metadata describing the feedback from the operator. (id: GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata) |
requesterFeedbackMetadata | object | Metadata describing the feedback from the labeling task requester. (id: GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata) |
Successful response
Name | Datatype | Description |
---|---|---|
name | string | Name of the feedback message in a feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessage/{feedback_message_id}' |
body | string | String content of the feedback. Maximum of 10000 characters. |
createTime | string (google-datetime) | Create time. |
image | string (byte) | The image storing this feedback if the feedback is an image representing operator's comments. |
operatorFeedbackMetadata | object | Metadata describing the feedback from the operator. (id: GoogleCloudDatalabelingV1beta1OperatorFeedbackMetadata) |
requesterFeedbackMetadata | object | Metadata describing the feedback from the labeling task requester. (id: GoogleCloudDatalabelingV1beta1RequesterFeedbackMetadata) |
Methods
The following methods are available for this resource:
Name | Accessible by | Required Params | Optional Params | Description |
---|---|---|---|---|
projects_datasets_annotated_datasets_feedback_threads_feedback_messages_get | select | projectsId , datasetsId , annotatedDatasetsId , feedbackThreadsId , feedbackMessagesId | Get a FeedbackMessage object. | |
projects_datasets_annotated_datasets_feedback_threads_feedback_messages_list | select | projectsId , datasetsId , annotatedDatasetsId , feedbackThreadsId | pageSize , pageToken | List FeedbackMessages with pagination. |
projects_datasets_annotated_datasets_feedback_threads_feedback_messages_create | insert | projectsId , datasetsId , annotatedDatasetsId , feedbackThreadsId | Create a FeedbackMessage object. | |
projects_datasets_annotated_datasets_feedback_threads_feedback_messages_delete | delete | projectsId , datasetsId , annotatedDatasetsId , feedbackThreadsId , feedbackMessagesId | Delete a FeedbackMessage. |
Parameters
Parameters can be passed in the WHERE
clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
Name | Datatype | Description |
---|---|---|
annotatedDatasetsId | string | |
datasetsId | string | |
feedbackMessagesId | string | |
feedbackThreadsId | string | |
projectsId | string | |
pageSize | integer (int32) | |
pageToken | string |
SELECT
examples
- projects_datasets_annotated_datasets_feedback_threads_feedback_messages_get
- projects_datasets_annotated_datasets_feedback_threads_feedback_messages_list
Get a FeedbackMessage object.
SELECT
name,
body,
createTime,
image,
operatorFeedbackMetadata,
requesterFeedbackMetadata
FROM google.datalabeling.feedback_messages
WHERE projectsId = '{{ projectsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND annotatedDatasetsId = '{{ annotatedDatasetsId }}' -- required
AND feedbackThreadsId = '{{ feedbackThreadsId }}' -- required
AND feedbackMessagesId = '{{ feedbackMessagesId }}' -- required;
List FeedbackMessages with pagination.
SELECT
name,
body,
createTime,
image,
operatorFeedbackMetadata,
requesterFeedbackMetadata
FROM google.datalabeling.feedback_messages
WHERE projectsId = '{{ projectsId }}' -- required
AND datasetsId = '{{ datasetsId }}' -- required
AND annotatedDatasetsId = '{{ annotatedDatasetsId }}' -- required
AND feedbackThreadsId = '{{ feedbackThreadsId }}' -- required
AND pageSize = '{{ pageSize }}'
AND pageToken = '{{ pageToken }}';
INSERT
examples
- projects_datasets_annotated_datasets_feedback_threads_feedback_messages_create
- Manifest
Create a FeedbackMessage object.
INSERT INTO google.datalabeling.feedback_messages (
data__requesterFeedbackMetadata,
data__operatorFeedbackMetadata,
data__name,
data__body,
data__image,
data__createTime,
projectsId,
datasetsId,
annotatedDatasetsId,
feedbackThreadsId
)
SELECT
'{{ requesterFeedbackMetadata }}',
'{{ operatorFeedbackMetadata }}',
'{{ name }}',
'{{ body }}',
'{{ image }}',
'{{ createTime }}',
'{{ projectsId }}',
'{{ datasetsId }}',
'{{ annotatedDatasetsId }}',
'{{ feedbackThreadsId }}'
RETURNING
name,
done,
error,
metadata,
response
;
# Description fields are for documentation purposes
- name: feedback_messages
props:
- name: projectsId
value: string
description: Required parameter for the feedback_messages resource.
- name: datasetsId
value: string
description: Required parameter for the feedback_messages resource.
- name: annotatedDatasetsId
value: string
description: Required parameter for the feedback_messages resource.
- name: feedbackThreadsId
value: string
description: Required parameter for the feedback_messages resource.
- name: requesterFeedbackMetadata
value: object
description: >
Metadata describing the feedback from the labeling task requester.
- name: operatorFeedbackMetadata
value: object
description: >
Metadata describing the feedback from the operator.
- name: name
value: string
description: >
Name of the feedback message in a feedback thread. Format: 'project/{project_id}/datasets/{dataset_id}/annotatedDatasets/{annotated_dataset_id}/feedbackThreads/{feedback_thread_id}/feedbackMessage/{feedback_message_id}'
- name: body
value: string
description: >
String content of the feedback. Maximum of 10000 characters.
- name: image
value: string
description: >
The image storing this feedback if the feedback is an image representing operator's comments.
- name: createTime
value: string
description: >
Create time.
DELETE
examples
- projects_datasets_annotated_datasets_feedback_threads_feedback_messages_delete
Delete a FeedbackMessage.
DELETE FROM google.datalabeling.feedback_messages
WHERE projectsId = '{{ projectsId }}' --required
AND datasetsId = '{{ datasetsId }}' --required
AND annotatedDatasetsId = '{{ annotatedDatasetsId }}' --required
AND feedbackThreadsId = '{{ feedbackThreadsId }}' --required
AND feedbackMessagesId = '{{ feedbackMessagesId }}' --required;