Describe Index — describe_index • pineconer

Returns configuration information and deployment status of an index.

Usage

describe_index(index_name)

Arguments

index_name: Name of the index to describe

Value

List with http response, content (index configuration including host), and status_code

The content includes: - name: Index name - dimension: Vector dimension - metric: Distance metric - host: Data plane host URL for vector operations - status: Index status (ready, etc.) - spec: Index specification (serverless or pod config)

Examples

if (FALSE) { # \dontrun{
describe_index("my-index")
} # }