- HTTP request
- Path parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
- UdmQueryFeedback
- YLRuleFeedback
- FeedbackType
- Try it!
Full name: projects.locations.instances.createFeedback
RPC to submit user feedback on content generated by AI services.
HTTP request
Path parameters
Parameters | |
---|---|
instance |
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 ( |
Fields | |
---|---|
type |
Optional. Feedback type. |
comment |
Optional. Feedback comment. |
Union field metadata . The feedback metadata associated with the user feedback. metadata can be only one of the following: |
|
udmQueryFeedback |
Feedback metadata for UDM query translation. |
ylRuleFeedback |
Feedback metadata for Yara-L rule translation. |
Response body
Response message for instances.createFeedback.
If successful, the response body contains data with the following structure:
JSON representation |
---|
{ "feedbackId": string } |
Fields | |
---|---|
feedbackId |
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 |
---|
{ "originalInputText": string, "originalOutputQuery": string, "rewrittenQuery": string } |
Fields | |
---|---|
originalInputText |
Required. The original natural language text used for the translation. |
originalOutputQuery |
Optional. Original UDM query returned by the translation. |
rewrittenQuery |
Optional. Rewritten UDM query (if modified). |
YLRuleFeedback
YLRuleFeedback contains metadata for the feedback submitted on Yara-L rule translation.
JSON representation |
---|
{ "originalInputDescription": string, "originalInputQuery": string, "originalOutputRule": string, "rewrittenRule": string } |
Fields | |
---|---|
originalInputDescription |
Required. The original natural language description used for the translation. |
originalInputQuery |
Optional. The original UDM query used for the rule generation. |
originalOutputRule |
Optional. Original Yara-L rule returned by the translation. |
rewrittenRule |
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. |