Method: projects.locations.templates.sanitizeUserPrompt

Sanitizes User Prompt.

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 
{
  "userPromptData": {
    object (DataItem)
  },
  "filterConfig": {
    object (FilterConfig)
  }
}
Fields
userPromptData

object (DataItem)

Required. User prompt data to sanitize.
filterConfig

object (FilterConfig)

Optional. Optional Filter configuration to Sanitize User Prompt.

If below configuration is specified then Sanitization will be performed using settings in this configuration along with settings defined at template level (union of both).

If a filter setting overlaps, then the lowest threshold value i.e. value with greater false positives will be applied. For example, the filter_configuration defines LOW_AND_ABOVE confidence level for TOXICITY, and template defines HIGH confidence level, then Sanitization is performed using LOW_AND_ABOVE confidence level.

Response body

Sanitized User Prompt 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.