AI Prompt Guard

Overview Examples Configuration reference Changelog

Configuration

configobject

Hide Child Parameters

allow_all_conversation_historyboolean

If true, will ignore all previous chat prompts from the conversation history.

Default:false

allow_patternsarray[string]

Array of valid regex patterns, or valid questions from the ‘user’ role in chat.

>= 1 characters<= 500 characters

deny_patternsarray[string]

Array of invalid regex patterns, or invalid questions from the ‘user’ role in chat.

>= 1 characters<= 500 characters

genai_categorystring

Generative AI category of the request

Allowed values:audio/speechaudio/transcriptionimage/generationrealtime/generationtext/embeddingstext/generation

Default:text/generation

llm_formatstring

LLM input and output format and schema to use

Allowed values:bedrockcoheregeminihuggingfaceopenai

Default:openai

match_all_rolesboolean

If true, will match all roles in addition to ‘user’ role in conversation history.

Default:false

max_request_body_sizeinteger

max allowed body size allowed to be introspected. 0 means unlimited, but the size of this body will still be limited by Nginx’s client_max_body_size.

Default:8192

>= 0

consumerobject

If set, the plugin will activate only for requests where the specified has been authenticated. (Note that some plugins can not be restricted to consumers this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

consumer_groupobject

If set, the plugin will activate only for requests where the specified consumer group has been authenticated. (Note that some plugins can not be restricted to consumers groups this way.). Leave unset for the plugin to activate regardless of the authenticated Consumer Groups

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

protocolsarray[string]

A set of strings representing HTTP protocols.

Allowed values:grpcgrpcshttphttps

Default:grpc, grpcs, http, https

routeobject

If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

serviceobject

If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.

* Additional properties are NOT allowed.

Hide Child Parameters

idstring

AI Prompt Guard

Configuration

Did this doc help?

Help us make these docs great!

Still need help