Intent Classification API

API References

Intent Classification API — core service of Intenus that classifies user intents and generates scoring strategies using ML models

For details on strategy ranking, refer to the related documentation Ranking Strategies

Predict

post

Predict ground truth labels, strategy, and weights for a given intent

Args: intent: Intent object containing all required features

Returns: Predictions for all tasks with confidence scores

Body
solver_window_msintegerRequired
user_decision_timeout_msintegerRequired
time_to_deadline_msintegerRequired
max_slippage_bpsintegerRequired
max_gas_cost_usdnumberRequired
max_hopsintegerRequired
surplus_weightintegerRequired
gas_cost_weightintegerRequired
execution_speed_weightintegerRequired
reputation_weightintegerRequired
input_countintegerRequired
output_countintegerRequired
input_value_usdnumberRequired
expected_output_value_usdnumberRequired
benchmark_confidencenumberRequired
expected_gas_usdnumberRequired
expected_slippage_bpsintegerRequired
nlp_confidencenumberRequired
tag_countintegerRequired
time_in_forcestring · enumRequiredPossible values:
optimization_goalstring · enumRequiredPossible values:
benchmark_sourcestringRequired
client_platformstringRequired
has_whitelistbooleanRequired
has_blacklistbooleanRequired
has_limit_pricebooleanRequired
require_simulationbooleanRequired
has_nlp_inputbooleanRequired
Responses
200

Successful Response

application/json
post
/predict
POST /predict HTTP/1.1
Host: 
Content-Type: application/json
Accept: */*
Content-Length: 698

{
  "solver_window_ms": 1,
  "user_decision_timeout_ms": 1,
  "time_to_deadline_ms": 1,
  "max_slippage_bps": 1,
  "max_gas_cost_usd": 1,
  "max_hops": 1,
  "surplus_weight": 1,
  "gas_cost_weight": 1,
  "execution_speed_weight": 1,
  "reputation_weight": 1,
  "input_count": 1,
  "output_count": 1,
  "input_value_usd": 1,
  "expected_output_value_usd": 1,
  "benchmark_confidence": 1,
  "expected_gas_usd": 1,
  "expected_slippage_bps": 1,
  "nlp_confidence": 1,
  "tag_count": 1,
  "time_in_force": "immediate",
  "optimization_goal": "maximize_output",
  "benchmark_source": "text",
  "client_platform": "text",
  "input_asset_types": [
    "native"
  ],
  "output_asset_types": [
    "native"
  ],
  "has_whitelist": true,
  "has_blacklist": true,
  "has_limit_price": true,
  "require_simulation": true,
  "has_nlp_input": true
}
{
  "primary_category": "text",
  "primary_category_confidence": 1,
  "detected_priority": "text",
  "detected_priority_confidence": 1,
  "complexity_level": "text",
  "complexity_level_confidence": 1,
  "risk_level": "text",
  "risk_level_confidence": 1,
  "strategy": "text",
  "strategy_confidence": 1,
  "weights": {}
}

Last updated