Method: cases.getOrCreateCaseSummary

Full name: projects.locations.instances.cases.getOrCreateCaseSummary

Gets or initiates the creation of an AI-driven summary for a case. Use this method to leverage AI for generating a concise overview of case reasons, next steps, and a general investigation summary.

HTTP request


POST https://chronicle.africa-south1.rep.googleapis.com/v1alpha/{name}:getOrCreateCaseSummary

Path parameters

Parameters
name

string

Required. The resource name of the Case. Format: projects/{project}/locations/{location}/instances/{instance}/cases/{case}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "isFirstRequest": boolean
}
Fields
isFirstRequest

boolean

Required. Whether this is the first request during polling the case generation state.

Response body

Response message for cases.getOrCreateCaseSummary.

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

JSON representation 
{
  "reasons": [
    string
  ],
  "nextSteps": [
    string
  ],
  "summary": string,
  "state": enum (SummaryState),
  "markdownResults": {
    object (CaseSummaryMarkdownResults)
  }
}
Fields
reasons[]

string

Output only. The reasons in the case summary.
nextSteps[]

string

Output only. The next steps in the case summary.
summary

string

Output only. The summary prediction.
state

enum (SummaryState)

Output only. The state of the case summary generation.
markdownResults

object (CaseSummaryMarkdownResults)

Output only. The raw results after entity marking.

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.

IAM Permissions

Requires the following IAM permission on the name resource:

  • chronicle.cases.update

For more information, see the IAM documentation.

SummaryState

Possible states for the case summary generation.

Enums
SUMMARY_STATE_UNSPECIFIED Unspecified state.
PENDING_START Not yet started - pending to start due to resources limitation.
IN_PROGRESS Currently being generated by the AI in another thread.
SUCCESSFUL Generation Completed.
ERROR Generation Failed with an error.

CaseSummaryMarkdownResults

The raw results after entity marking.

JSON representation 
{
  "reasons": [
    string
  ],
  "nextSteps": [
    string
  ],
  "summary": string
}
Fields
reasons[]

string

Output only. List of reasons that were generated for the case summary, with entity markers.
nextSteps[]

string

Output only. List of next steps that were generated for the case summary, with entity markers.
summary

string

Output only. The case summary, with entity markers.