Method: projects.locations.templates.sanitizeModelResponse

Sanitizes Model Response.

HTTP request


The URLs use gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. Represents resource name of template e.g. name=projects/sample-project/locations/us-central1/templates/templ01

Request body

The request body contains data with the following structure:

JSON representation 
{
  "modelResponseData": {
    object (DataItem)
  },
  "userPrompt": string,
  "multiLanguageDetectionMetadata": {
    object (MultiLanguageDetectionMetadata)
  }
}
Fields
modelResponseData

object (DataItem)

Required. Model response data to sanitize.
userPrompt

string

Optional. User Prompt associated with Model response.
multiLanguageDetectionMetadata

object (MultiLanguageDetectionMetadata)

Optional. Metadata related for multi language detection.

Response body

Sanitized Model Response Response.

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

JSON representation 
{
  "sanitizationResult": {
    object (SanitizationResult)
  }
}
Fields
sanitizationResult

object (SanitizationResult)

Output only. Sanitization Result.

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 name resource:

  • modelarmor.templates.useToSanitizeModelResponse

For more information, see the IAM documentation.