.. _ai_router:

ai router
=========

AI Router related configuration


router Specification
--------------------

	===================================== ==================================================
	 **Parameter**                         **Value** 

	===================================== ==================================================
	 **Type**                              *Configuration Resource*

	 **Element Name**                      router

	 **Element URI**                       /axapi/v3/ai/router

	 **Element Attributes**                router_attributes

	 **Partition Visibility**              shared

	 **Statistics Data URI**               /axapi/v3/ai/router/stats

	 **Operational Data URI**              /axapi/v3/ai/router/oper

	 **Schema**                             :download:`router schema <ai-router/ai-router.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'>


Create Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/ai/router



.. raw:: html

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


:ref:`195_router_attributes`



.. raw:: html

   </td><td></td></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/router



.. raw:: html

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


:ref:`195_router_attributes`



.. raw:: html

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




.. raw:: html

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


Modify Object



.. raw:: html

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


POST



.. raw:: html

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


/axapi/v3/ai/router



.. raw:: html

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


:ref:`195_router_attributes`



.. raw:: html

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




.. raw:: html

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


Replace Object



.. raw:: html

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


PUT



.. raw:: html

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


/axapi/v3/ai/router



.. raw:: html

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


:ref:`195_router_attributes`



.. raw:: html

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




.. raw:: html

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


Delete Object



.. raw:: html

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


DELETE



.. raw:: html

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


/axapi/v3/ai/router



.. raw:: html

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


:ref:`195_router_attributes`



.. raw:: html

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




.. raw:: html

   </table>

.. _195_router_attributes:

router attributes
-----------------

    **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

.. _195_sampling-enable:

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