Analyze For Tuning

Analyze retriever and generate tuning recommendations.

Performs comprehensive analysis and generates actionable recommendations:

• Parameter tuning suggestions
• Cache optimization opportunities
• Performance improvement estimates

Recommendations Include:

• Increase/decrease k value
• Adjust reranking thresholds
• Enable/optimize caching
• Stage reordering suggestions

Use Cases:

• Initial retriever configuration
• Periodic performance optimization
• A/B testing parameter changes
• Cost optimization

Example:

curl -X POST "https://api.mixpeek.com/v1/analytics/retrievers/ret_abc123/analyze-tuning?days=7" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "X-Namespace: your-namespace"

POST /v1/analytics/retrievers/{retriever_id}/analyze-tuning

Analyze For Tuning

cURL

curl --request POST \
  --url https://api.mixpeek.com/v1/analytics/retrievers/{retriever_id}/analyze-tuning \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Namespace: <api-key>'

200

{
  "retriever_id": "<string>",
  "analysis_period": {
    "start": "2023-11-07T05:31:56Z",
    "end": "2023-11-07T05:31:56Z"
  },
  "recommendations": [
    {
      "recommendation_type": "<string>",
      "recommended_value": "<unknown>",
      "expected_impact": "<string>",
      "confidence": 0.5,
      "reasoning": "<string>",
      "current_value": "<unknown>"
    }
  ],
  "current_performance": {}
}

Authorizations

Authorization · string · header · required

Mixpeek API key, sent as Authorization: Bearer mxp_sk_.... Create one in Studio under Settings → API Keys, or with an admin key via POST /v1/organizations/users/{user_email}/api-keys. A missing header returns 403; an invalid or revoked key returns 401.

X-Namespace · string · header · required

Namespace id (ns_...), not the namespace name. This scopes the request rather than authenticating it, and it is required on every operation marked x-mixpeek-namespace-scoped.

Path Parameters

retriever_id · string · required

Query Parameters

days · integer · default: 7

Days of history to analyze

Required range: 1 <= x <= 90

Response

200

application/json

Successful Response

Response for interaction tuning analysis.

retriever_id · string · required

Retriever identifier

analysis_period · TimeRange · object · required

Analysis period

Show child attributes

recommendations · InteractionTuningRecommendation · object[] · required

Tuning recommendations

Show child attributes

current_performance · Current Performance · object · required

Current performance baseline