Analyze For Tuning

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

{
  "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": {}
}

Retrievers

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

analytics

retrievers

{retriever_id}

analyze-tuning

Analyze For Tuning

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

{
  "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

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

retriever_id

string

required

Query Parameters

days

integer

default:7

Days of history to analyze

Required range: 1 <= x <= 90

Response

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

Get Cache Performance Get Engine Performance