describeIndexStats method

Future<IndexStats> describeIndexStats({ required String indexName, required String projectId, required String environment, IndexStatsRequest? request, })

Describe index stats

This operation returns statistics about the index's contents

indexName: The name of your index. See Pinecone console.

projectId: The id of your project. See Pinecone console.

environment: The region for your project. See Pinecone console

request: No description

POST https://{index_name}-{project_id}.svc.{environment}.pinecone.io/describe_index_stats

Implementation

Future<IndexStats> describeIndexStats({
  required String indexName,
  required String projectId,
  required String environment,
  IndexStatsRequest? request,
}) async {
  final r = await makeRequest(
    baseUrl:
        'https://${indexName}-${projectId}.svc.${environment}.pinecone.io',
    path: '/describe_index_stats',
    method: HttpMethod.post,
    isMultipart: false,
    requestType: 'application/json',
    responseType: 'application/json',
    body: request,
    headerParams: {
      if (apiKey.isNotEmpty) 'Api-Key': apiKey,
    },
  );
  return IndexStats.fromJson(_jsonDecode(r));
}