Skip to content

Analyze Indexes

POST
/api/v1/indexes/analyze

Analyze indexes and provide improvement recommendations.

Args: service: Index management service (injected)

Returns: List of recommendations for index improvements

Raises: HTTPException: 500 for server errors

Successful Response

IndexAnalyzeResponseModel

API response model for index analysis.

object
recommendations
required
Recommendations
Array<object>
IndexRecommendationModel

API model for index improvement recommendation.

object
model_name
required
Model Name
string
current_state
required
Current State
string
Allowed values: no_index ivfflat hnsw
recommendation
required
Recommendation
string
reason
required
Reason
string
suggested_parameters
Any of:
object
key
additional properties
integer
total_count
required
Total Count
integer