pinecone.enums

 5class CloudProvider(Enum):
 6    """Cloud providers available for use with Pinecone serverless indexes
 7    
 8    This list could expand or change over time as more cloud providers are supported.
 9    Check the Pinecone documentation for the most up-to-date list of supported cloud 
10    providers. If you want to use a cloud provider that is not listed here, you can 
11    pass a string value directly without using this enum.
12    """
13
14    AWS = "aws"
15    GCP = "gcp"
16    AZURE = "azure"

19class AwsRegion(Enum):
20    """AWS (Amazon Web Services) regions available for use with Pinecone serverless indexes
21    
22    This list could expand or change over time as more regions are supported.
23    Check the Pinecone documentation for the most up-to-date list of supported 
24    regions. If you want to use a region that is not listed here, you can 
25    pass a string value directly without using this enum.
26    """
27
28    US_EAST_1 = "us-east-1"
29    US_WEST_2 = "us-west-2"
30    EU_WEST_1 = "eu-west-1"

33class GcpRegion(Enum):
34    """GCP (Google Cloud Platform) regions available for use with Pinecone serverless indexes
35    
36    This list could expand or change over time as more regions are supported.
37    Check the Pinecone documentation for the most up-to-date list of supported 
38    regions. If you want to use a region that is not listed here, you can 
39    pass a string value directly without using this enum.
40    """
41
42    US_CENTRAL1 = "us-central1"
43    EUROPE_WEST4 = "europe-west4"

46class AzureRegion(Enum):
47    """Azure regions available for use with Pinecone serverless indexes
48    
49    This list could expand or change over time as more regions are supported.
50    Check the Pinecone documentation for the most up-to-date list of supported 
51    regions. If you want to use a region that is not listed here, you can 
52    pass a string value directly without using this enum.
53    """
54
55    EASTUS2 = "eastus2"

 5class DeletionProtection(Enum):
 6    """The DeletionProtection setting of an index indicates whether the index
 7    can be  the index cannot be deleted using the delete_index() method.
 8
 9    If disabled, the index can be deleted. If enabled, calling delete_index()
10    will raise an error.
11
12    This setting can be changed using the configure_index() method.
13    """
14
15    ENABLED = "enabled"
16    DISABLED = "disabled"

 5class Metric(Enum):
 6    """
 7    The metric specifies how Pinecone should calculate the distance between vectors when querying an index.
 8    """
 9
10    COSINE = "cosine"
11    EUCLIDEAN = "euclidean"
12    DOTPRODUCT = "dotproduct"

 5class PodIndexEnvironment(Enum):
 6    """
 7    These environment strings are used to specify where a pod index should be deployed.
 8    """
 9
10    US_WEST1_GCP = "us-west1-gcp"
11    US_CENTRAL1_GCP = "us-central1-gcp"
12    US_WEST4_GCP = "us-west4-gcp"
13    US_EAST4_GCP = "us-east4-gcp"
14    NORTHAMERICA_NORTHEAST1_GCP = "northamerica-northeast1-gcp"
15    ASIA_NORTHEAST1_GCP = "asia-northeast1-gcp"
16    ASIA_SOUTHEAST1_GCP = "asia-southeast1-gcp"
17    US_EAST1_GCP = "us-east1-gcp"
18    EU_WEST1_GCP = "eu-west1-gcp"
19    EU_WEST4_GCP = "eu-west4-gcp"
20    US_EAST1_AWS = "us-east-1-aws"
21    EASTUS_AZURE = "eastus-azure"

 5class PodType(Enum):
 6    """
 7    PodType represents the available pod types for a pod index.
 8    """
 9
10    P1_X1 = "p1.x1"
11    P1_X2 = "p1.x2"
12    P1_X4 = "p1.x4"
13    P1_X8 = "p1.x8"
14    S1_X1 = "s1.x1"
15    S1_X2 = "s1.x2"
16    S1_X4 = "s1.x4"
17    S1_X8 = "s1.x8"
18    P2_X1 = "p2.x1"
19    P2_X2 = "p2.x2"
20    P2_X4 = "p2.x4"
21    P2_X8 = "p2.x8"

 5class VectorType(Enum):
 6    """
 7    VectorType is used to specifiy the type of vector you will store in the index.
 8
 9    Dense vectors are used to store dense embeddings, which are vectors with non-zero values in most of the dimensions.
10
11    Sparse vectors are used to store sparse embeddings, which allow vectors with zero values in most of the dimensions to be represented concisely.
12    """
13
14    DENSE = "dense"
15    SPARSE = "sparse"