Analyze For Tuning

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

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

Retriever

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: <authorization>' \
  --header 'X-Namespace: <x-namespace>'

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

Headers

Authorization

string

required

REQUIRED: Bearer token authentication using your API key. Format: 'Bearer sk_xxxxxxxxxxxxx'. You can create API keys in the Mixpeek dashboard under Organization Settings.

X-Namespace

string

required

REQUIRED: Namespace identifier for scoping this request. All resources (collections, buckets, taxonomies, etc.) are scoped to a namespace. You can provide either the namespace name or namespace ID. Format: ns_xxxxxxxxxxxxx (ID) or a custom name like 'my-namespace'

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

analysis_period.start

string<date-time>

required

Start time (UTC)

analysis_period.end

string<date-time>

required

End time (UTC)

recommendations

InteractionTuningRecommendation · object[]

required

Tuning recommendations

Show child attributes

recommendations.recommendation_type

string

required

Type of recommendation

recommendations.recommended_value

any

required

Recommended value

recommendations.expected_impact

string

required

Expected performance impact

recommendations.confidence

number

required

Confidence score

Required range: 0 <= x <= 1

recommendations.reasoning

string

required

Explanation of recommendation

recommendations.current_value

any | null

Current setting value

current_performance

Current Performance · object

required

Current performance baseline

Get Cache Performance Get Slowest Queries

⌘I

Health

Organizations

Namespaces

Buckets

Feature Extractors

Collections

Retrievers

Taxonomies

Clusters

Templates

Analytics

Resource Search

Inference

Agent Sessions

Tasks

Webhooks

Notifications

Triggers

Analyze For Tuning

Headers

Path Parameters

Query Parameters

Response