RoutingRules
List RoutingRules
Returns a paginated list of routing rules for the current project, ordered by priority ascending.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.routing_rules.list(limit=10)
# Handle response
print(res)
Show Parameters
Show Parameters
{
"limit": Optional[int],
"starting_after": Optional[str],
"ending_before": Optional[str],
"project_id": Optional[str],
}
Show Response
Show Response
{
"data": {
"id": str,
"created_at": date,
"created_by_id": str,
"description": Optional[str],
"display_name": str,
"enabled": bool,
"expression": { # optional
"cel": str,
"config": Dict[str, Any],
},
"models_config": { # optional
"mode": Literal["fallback", "weighted", "round_robin"],
"models": {
"display_name": Optional[str],
"integration_id": Optional[str],
"model": str,
"weight": Optional[float],
},
},
"priority": int,
"project_id": str,
"updated_at": date,
"updated_by_id": str,
},
"has_more": bool,
"object": str,
}
Create a RoutingRule
Creates a new routing rule with expression, models configuration, and priority settings.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.routing_rules.create(display_name="Freeda_Beahan")
# Handle response
print(res)
Show Parameters
Show Parameters
{
"display_name": str, # required
"description": Optional[str],
"enabled": Optional[bool],
"expression": { # optional
"cel": str, # required
},
"models_config": { # optional
"mode": Literal["fallback", "weighted", "round_robin"], # required
"models": { # required
"display_name": Optional[str],
"integration_id": Optional[str],
"model": str, # required
"weight": Optional[float],
},
},
"priority": Optional[int],
"project_id": Optional[str],
}
Show Response
Show Response
{
"id": str,
"created_at": date,
"created_by_id": str,
"description": Optional[str],
"display_name": str,
"enabled": bool,
"expression": { # optional
"cel": str,
"config": Dict[str, Any],
},
"models_config": { # optional
"mode": Literal["fallback", "weighted", "round_robin"],
"models": {
"display_name": Optional[str],
"integration_id": Optional[str],
"model": str,
"weight": Optional[float],
},
},
"priority": int,
"project_id": str,
"updated_at": date,
"updated_by_id": str,
}
Delete a RoutingRule
Deletes an existing routing rule by ID.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
orq.routing_rules.delete(routing_rule_id="<id>")
# Use the SDK ...
Show Parameters
Show Parameters
{
"routing_rule_id": str, # required
}
Retrieve a RoutingRule
Retrieves the details of an existing routing rule by ID.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.routing_rules.retrieve(routing_rule_id="<id>")
# Handle response
print(res)
Show Parameters
Show Parameters
{
"routing_rule_id": str, # required
}
Show Response
Show Response
{
"id": str,
"created_at": date,
"created_by_id": str,
"description": Optional[str],
"display_name": str,
"enabled": bool,
"expression": { # optional
"cel": str,
"config": Dict[str, Any],
},
"models_config": { # optional
"mode": Literal["fallback", "weighted", "round_robin"],
"models": {
"display_name": Optional[str],
"integration_id": Optional[str],
"model": str,
"weight": Optional[float],
},
},
"priority": int,
"project_id": str,
"updated_at": date,
"updated_by_id": str,
}
Update a RoutingRule
Partially updates an existing routing rule. Only provided fields are updated.from orq_ai_sdk import Orq
import os
with Orq(
api_key=os.getenv("ORQ_API_KEY", ""),
) as orq:
res = orq.routing_rules.update(routing_rule_id="<id>")
# Handle response
print(res)
Show Parameters
Show Parameters
{
"routing_rule_id": str, # required
"description": Optional[str],
"display_name": Optional[str],
"enabled": Optional[bool],
"expression": { # optional
"cel": str, # required
},
"models_config": { # optional
"mode": Literal["fallback", "weighted", "round_robin"], # required
"models": { # required
"display_name": Optional[str],
"integration_id": Optional[str],
"model": str, # required
"weight": Optional[float],
},
},
"priority": Optional[int],
}
Show Response
Show Response
{
"id": str,
"created_at": date,
"created_by_id": str,
"description": Optional[str],
"display_name": str,
"enabled": bool,
"expression": { # optional
"cel": str,
"config": Dict[str, Any],
},
"models_config": { # optional
"mode": Literal["fallback", "weighted", "round_robin"],
"models": {
"display_name": Optional[str],
"integration_id": Optional[str],
"model": str,
"weight": Optional[float],
},
},
"priority": int,
"project_id": str,
"updated_at": date,
"updated_by_id": str,
}