list_indexes
operation to get a complete description of all indexes in a project:
.names()
helper function to iterate over the index names in the list_indexes()
response, for example:
describe_index
endpoint to get a complete description of a specific index:
upsert
and query
, the SDK gets the unique DNS host for the index using the describe_index
operation. This is convenient for testing but should be avoided in production because describe_index
uses a different API than data operations and therefore adds an additional network call and point of failure. Instead, you should get an index host once and cache it for reuse or specify the host directly.delete_index
operation to delete an index and all of its associated resources.
403 - FORBIDDEN
status with the following error:
configure_index
operation as follows:
embed.model
to one of Pinecone’s hosted embedding models.embed.field_map
to the name of the field in your source document that contains the data for embedding.vector_type
, metric
, and dimension
of the index must be supported by the specified embedding model.2024-07
, Python SDK v5.0.0, Node.js SDK v3.0.0, Java SDK v2.0.0, or Go SDK v1.0.0 or later.deletion_protection
parameter to enabled
.
403 - FORBIDDEN
status with the following error:
tags
parameter when creating a new index or when configuring an existing index.
To add tags when creating a new index:
tags
parameter to send the tag key with an empty value (""
).
The following example removes the example: tag
tag from docs-example
: