Method: instances.generateSoarChatMessage

Full name: projects.locations.instances.generateSoarChatMessage

Generates an AI-driven chat response based on a specific security intent. Use this method to interact with an AI assistant for tasks such as analyzing case details, summarizing alerts, or exploring playbook logic. The response is tailored based on the provided intent and environmental context.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{instance}:generateSoarChatMessage

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 
{
  "intent": enum (IntentEnum),
  "userPrompt": string,
  "context": {
    object (Context)
  }
}
Fields
intent

enum (IntentEnum)

Required. The intent of the message.
userPrompt

string

Required. The user's prompt.
context

object (Context)

Required. The message's context. The context holds the information that is needed to generate the message.

Response body

If successful, the response body contains an instance of MessageResponse.

Authorization scopes

Requires one of the following OAuth scopes:

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

For more information, see the Authentication Overview.

IntentEnum

An open enumeration of all SOAR's supported chat intents. LINT.IfChange(intent_enum)

Enums
INTENT_ENUM_UNSPECIFIED Represents a nullish value for the enum.
CASE_INTROSPECTION Represents intent for SOAR case introspection.
ALERT_INTROSPECTION Represents intent for SOAR alert introspection.
PLAYBOOK_INTROSPECTION Represents intent for SOAR playbook introspection.