ai

AI related configuration

ai Specification

Parameter	Value
Type	Intermediate Resource
Element Name	ai
Element URI	/axapi/v3/ai
Element Attributes	ai_attributes
Partition Visibility	shared,private
Schema	ai schema

Operations Allowed:

Operation	Method	URI	Payload
Get Object	GET	/axapi/v3/ai	ai_attributes

ai attributes

firewall

Description: firewall is a JSON Block. Please see below for firewall

Type: Object

Reference Object: /axapi/v3/ai/firewall

router

Description: router is a JSON Block. Please see below for router

Type: Object

Reference Object: /axapi/v3/ai/router

firewall

Specification	Value
Type	object

clear-log

Description Clear AI Firewall Application Logging

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

disable

Description Disable AI Firewall Support globally

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

Mutual Exclusion: disable and enable are mutually exclusive

enable

Description Enable AI Firewall Support globally

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: enable and disable are mutually exclusive

pii-redaction

Description Enable/Disable AI Firewall Support globally

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

restart

Description Restart AI Firewall Components and Services

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

sampling-enable

Type: List

start

Description Start AI Firewall Components and Services

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

status

Description: status is a JSON Block. Please see below for firewall_status

Type: Object

Reference Object: /axapi/v3/ai/firewall/status

stop

Description Stop AI Firewall Components and Services

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

firewall_sampling-enable

Specification	Value
Type	list
Block object keys

counters1

Description ‘all’: all; ‘total-requests’: Total AI Firewall Request counts; ‘total-responses’: Total AI Firewall Response counts; ‘total-icap-reqmod’: Total ICAP REQMOD counts; ‘total-icap-respmod’: Total ICAP RESPMOD counts; ‘total-icap-options’: Total ICAP Options counts; ‘total-violatons’: Total AI Firewall Violations counts; ‘total-acceptance’: Total AI Firewall acceptance counts; ‘avg-time-msec’: Average Requests Time in millisec; ‘avg-time-resp-msec’: Average Responses Time in millisec; ‘total-monitor-reqmod’: Total monitored reqmod counts; ‘total-monitor-respmod’: Total monitored respmod counts; ‘total-lic-allow’: Total licensed requests counts; ‘total-lic-block’: Total license drop counts; ‘lic-live-tokens’: Current live licens used counts; ‘lic-peak-tokens’: Peak utilization of licensed tokens; ‘lic-cbr-tokens’: Committed licensed tokens;

Type: string

Supported Values: all, total-requests, total-responses, total-icap-reqmod, total-icap-respmod, total-icap-options, total-violatons, total-acceptance, avg-time-msec, avg-time-resp-msec, total-monitor-reqmod, total-monitor-respmod, total-lic-allow, total-lic-block, lic-live-tokens, lic-peak-tokens, lic-cbr-tokens

firewall_status

Specification	Value
Type	object

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

router

Specification	Value
Type	object

disable

Description Disable AI Router Support globally

Type: boolean

Supported Values: true, false, 1, 0

Default: 1

Mutual Exclusion: disable and enable are mutually exclusive

enable

Description Enable AI Router Support globally

Type: boolean

Supported Values: true, false, 1, 0

Default: 0

Mutual Exclusion: enable and disable are mutually exclusive

sampling-enable

Type: List

uuid

Description uuid of the object

Type: string

Maximum Length: 64 characters

Maximum Length: 1 characters

router_sampling-enable

Specification	Value
Type	list
Block object keys

counters1

Description ‘all’: all; ‘ai_class_summarization’: AI Class Summarization Stats; ‘ai_class_code_generation’: AI Class Code Generation Stats; ‘ai_class_math_logic’: AI Class Code Generation Stats; ‘ai_class_question_answering’: AI Class Question Answering Stats; ‘ai_class_translation’: AI Class Translation Stats; ‘ai_class_creative_writing’: AI Class Creative Writing Stats; ‘ai_class_data_analysis’: AI Class Data Analysis Stats; ‘ai_class_classification’: AI Class Classification Stats; ‘ai_class_extraction’: AI Class Extraction Stats; ‘ai_class_rewriting’: AI Class Rewriting Stats; ‘ai_class_other’: AI Class Other Stats; ‘ai_class_harmful’: AI Class Harmful Stats; ‘ai_class_unknown’: AI Class Unknown Stats;

Type: string

Supported Values: all, ai_class_summarization, ai_class_code_generation, ai_class_math_logic, ai_class_question_answering, ai_class_translation, ai_class_creative_writing, ai_class_data_analysis, ai_class_classification, ai_class_extraction, ai_class_rewriting, ai_class_other, ai_class_harmful, ai_class_unknown