Method: instances.submitResponseFeedback

Full name: projects.locations.instances.submitResponseFeedback

Submits a Response Feedback.

HTTP request


Path parameters

Parameters
instance

string

Required. The name of the parent resource, which is the SecOps 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 
{
  "rating": integer,
  "comment": string,
  "productType": string,
  "productId": string,
  "productVersion": string,
  "flags": integer,
  "id": string,

  // Union field metadata can be only one of the following:
  "caseSummaryMetadata": {
    object (CaseSummaryFeedbackMetadata)
  },
  "playbookGenerationMetadata": {
    object (PlaybookGenerationFeedbackMetadata)
  },
  "playbookGenerationByAlertMetadata": {
    object (PlaybookGenerationByAlertFeedbackMetadata)
  }
  // End of list of possible types for union field metadata.
}
Fields
rating

integer

Required. The numerical rating provided by the user; The number should be between 1 to 5.
comment

string

Optional. A user-provided comment offering additional feedback or details about the product. Maximum length: 500 characters.
productType

string

Required. The type or category of the product being reviewed. Maximum length: 50 characters. Example: "CaseSummary_recommendationReasons".
productId

string

Required. A unique identifier for the product being reviewed. Maximum length: 50 characters. Example: "2".
productVersion

string

Required. The version of the product being reviewed. Maximum length: 20 characters. Example: "1.0.0".
flags

integer

Optional. Flags or additional indicators associated with the feature feedback.
id

string

Required. The feedback id to be submitted. This id is a GUID. Example: "123e4567-e89b-12d3-a456-426614174000".

Union field metadata. Metadata containing additional contextual information about the feedback. Metadata must conform to one of the predefined metadata types, such as: - CaseSummaryFeedbackMetadata - PlaybookGenerationFeedbackMetadata - PlaybookGenerationByAlertFeedbackMetadata These types define specific fields that are validated according to their own rules. Example for CaseSummaryFeedbackMetadata: { "deviceProducts": ["Product1", "Product2"], "deviceRuleGenerators": ["RuleGen1"], "deviceVendors": ["Vendor1"] }

Example for PlaybookGenerationFeedbackMetadata: { "prompt": "Generate a new playbook", "type": "Generate" } The metadata field is optional but must adhere to one of the predefined metadata types. metadata can be only one of the following:
caseSummaryMetadata

object (CaseSummaryFeedbackMetadata)

Optional. Metadata specific to case summary feedback.
playbookGenerationMetadata

object (PlaybookGenerationFeedbackMetadata)

Optional. Metadata specific to playbook generation feedback.
playbookGenerationByAlertMetadata

object (PlaybookGenerationByAlertFeedbackMetadata)

Optional. Feedback metadata specific to playbook generation by alert.

Response body

If successful, the response body is an empty JSON object.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

CaseSummaryFeedbackMetadata

Contains metadata specific to case summary feedback.

JSON representation 
{
  "caseAssistantType": enum (CaseAssistantType),
  "deviceProducts": [
    string
  ],
  "deviceRuleGenerators": [
    string
  ],
  "deviceVendors": [
    string
  ],
  "type": string,
  "version": integer
}
Fields
caseAssistantType

enum (CaseAssistantType)

Required. Type of the assistant for the case summary.
deviceProducts[]

string

Optional. List of device products associated with the case summary feedback.
deviceRuleGenerators[]

string

Optional. List of device rule generators associated with the case summary feedback.
deviceVendors[]

string

Optional. List of device vendors associated with the case summary feedback.
type

string

Required. The type of the metadata. Will always be "CaseSummaryFeedbackMetadata".
version

integer

Optional. The version of the case summary feedback format.

CaseAssistantType

Enum to define the types of case assistants for case summary feedback.

Enums
CASE_ASSISTANT_TYPE_UNSPECIFIED Unspecified case assistant type.
THREAT_SUMMARY Represents the threat summary.
RECOMMENDATION_REASONS Represents the reasons for a recommendation.
RECOMMENDATION_NEXT_STEPS Represents the next steps in a recommendation.

PlaybookGenerationFeedbackMetadata

Contains metadata specific to playbook generation feedback.

JSON representation 
{
  "playbookAiType": enum (PlaybookAiType),
  "prompt": string,
  "type": string
}
Fields
playbookAiType

enum (PlaybookAiType)

Required. Type of AI action for the playbook generation (e.g., Generate, Edit).
prompt

string

Required. The prompt used for generating or editing the playbook.
type

string

Required. The type of the metadata. Will always be "PlaybookGenerationFeedbackMetadata".

PlaybookAiType

Enum to define the types of playbook AI actions.

Enums
PLAYBOOK_AI_TYPE_UNSPECIFIED Unspecified Playbook AI type.
GENERATE Represents generating a new playbook.
EDIT Represents editing an existing playbook.

PlaybookGenerationByAlertFeedbackMetadata

Contains feedback metadata specific to playbook generation by alert.

JSON representation 
{
  "type": string,
  "playbookId": string,
  "originalPlaybookId": string,
  "alertId": string,
  "caseId": string,
  "reasons": [
    string
  ],
  "scope": string,
  "stepId": string
}
Fields
type

string

Required. The type of the metadata. Will always be "PlaybookGenerationByAlertFeedbackMetadata".
playbookId

string

Required. The identifier of the generated playbook.
originalPlaybookId

string

Optional. The identifier of the original playbook if this is an edit.
alertId

string

Required. The identifier of the alert that triggered the playbook generation.
caseId

string

Required. The identifier of the case associated with the alert.
reasons[]

string

Optional. Reasons for the feedback.
scope

string

Required. The scope of the feedback (e.g., playbook, step).
stepId

string

Optional. The identifier of the step if the feedback is for a specific step.