Method: instances.createFeedback

Full name: projects.locations.instances.createFeedback

RPC to submit user feedback on content generated by Malachite Atlas services.

HTTP request

POST https://chronicle.googleapis.com/v1alpha/{instance}:createFeedback

Path parameters

Parameters
instance

string

Required. The Chronicle instance associated with the request. Format: projects/{project}/locations/{location}/instances/{instance}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "type": enum (FeedbackType),
  "comment": string,

  // Union field metadata can be only one of the following:
  "udm_query_feedback": {
    object (UdmQueryFeedback)
  },
  "yl_rule_feedback": {
    object (YLRuleFeedback)
  }
  // End of list of possible types for union field metadata.
}
Fields
type

enum (FeedbackType)

Optional. Feedback type.
comment

string

Optional. Feedback comment.
Union field metadata. The feedback metadata associated with the user feedback. metadata can be only one of the following:
udm_query_feedback

object (UdmQueryFeedback)

Feedback metadata for UDM query translation.
yl_rule_feedback

object (YLRuleFeedback)

Feedback metadata for Yara-L rule translation.

Response body

Response message for CreateFeedback.

If successful, the response body contains data with the following structure:

JSON representation 
{
  "feedback_id": string
}
Fields
feedback_id

string

Unique ID for this translation. Currently only used for audit logging purpose only.

Authorization scopes

Requires the following OAuth scope:

  • https://www.googleapis.com/auth/cloud-platform

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the instance resource:

  • chronicle.ais.createFeedback

For more information, see the IAM documentation.

UdmQueryFeedback

UdmQueryFeedback contains metadata for the feedback submitted on UDM query translation.

JSON representation 
{
  "original_input_text": string,
  "original_output_query": string,
  "rewritten_query": string
}
Fields
original_input_text

string

Required. The original natural language text used for the translation.
original_output_query

string

Optional. Original UDM query returned by the translation.
rewritten_query

string

Optional. Rewritten UDM query (if modified).

YLRuleFeedback

YLRuleFeedback contains metadata for the feedback submitted on Yara-L rule translation.

JSON representation 
{
  "original_input_description": string,
  "original_input_query": string,
  "original_output_rule": string,
  "rewritten_rule": string
}
Fields
original_input_description

string

Required. The original natural language description used for the translation.
original_input_query

string

Optional. The original UDM query used for the rule generation.
original_output_rule

string

Optional. Original Yara-L rule returned by the translation.
rewritten_rule

string

Optional. Rewritten Yara-L rule text (if modified).

FeedbackType

Feedback types.

Enums
FEEDBACK_TYPE_UNKNOWN Unknown feedback.
POSITIVE Positive feedback.
NEGATIVE Negative feedback.
REWRITE Negative feedback with a rewritten answer.
DISCARD Indicates a generated response was discarded.