.. _ai:

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**                             :download:`ai schema <ai/ai.txt>`
	===================================== ===========================================





	**Operations Allowed:**




.. raw:: html

   <script type="text/javascript">
 function showExample(a,b) { document.getElementById(a+'_div').style.display = 'block'; document.getElementById(a+'_cl').style.display = 'block'; document.getElementById(a+'_eg').style.display = 'none';}
   function closeExample(a,b) { document.getElementById(a+'_div').style.display = 'none'; document.getElementById(a+'_cl').style.display = 'none'; document.getElementById(a+'_eg').style.display = 'block';}
 </script>
   <table width='90%' style='margin-left:5%'>



.. raw:: html

   <tr style='border-bottom: thin solid; border-top: thin solid'><th width=15%>Operation</th><th width=10%>Method</th><th>URI</th><th width=15%>Payload</th><th width=10%></th></tr>




.. raw:: html

   <tr  style='border-bottom: thin solid;'><td valign = 'top'>


Get Object



.. raw:: html

   </td><td valign = 'top'>


GET



.. raw:: html

   </td><td valign = 'top'>


/axapi/v3/ai



.. raw:: html

   </td><td valign = 'top'>


ai_attributes



.. raw:: html

   </td><td></td></tr>




.. raw:: html

   </table>

.. _196_ai_attributes:

ai attributes
-------------

    **firewall**

        **Description:** firewall is a **JSON Block**.  Please see below for :ref:`196_firewall` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ai/firewall <ai_firewall>`

    **router**

        **Description:** router is a **JSON Block**.  Please see below for :ref:`196_router` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ai/router <ai_router>`

.. _196_firewall:

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 :ref:`196_firewall_status` 

        **Type:** Object

        **Reference Object:** :doc:`/axapi/v3/ai/firewall/status <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

.. _196_firewall_sampling-enable:

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

.. _196_firewall_status:

firewall_status
^^^^^^^^^^^^^^^
	=============================== ===================================================
	**Specification**                 **Value**
	=============================== ===================================================
	 **Type**                        *object*

	=============================== ===================================================

    **uuid**

        **Description** uuid of the object

        **Type:** string

        **Maximum Length:** 64 characters

        **Maximum Length:** 1 characters

.. _196_router:

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

.. _196_router_sampling-enable:

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