pinecone.deprecation_warnings

  1def _build_class_migration_message(method_name: str, example: str):
  2    return f"""{method_name} is no longer a top-level attribute of the pinecone package.
  3
  4To use {method_name}, please create a client instance and call the method there instead.
  5
  6Example:
  7{example}
  8"""
  9
 10
 11def init(*args, **kwargs):
 12    example = """
 13    import os
 14    from pinecone import Pinecone, ServerlessSpec
 15
 16    pc = Pinecone(
 17        api_key=os.environ.get("PINECONE_API_KEY")
 18    )
 19
 20    # Now do stuff
 21    if 'my_index' not in pc.list_indexes().names():
 22        pc.create_index(
 23            name='my_index', 
 24            dimension=1536, 
 25            metric='euclidean',
 26            spec=ServerlessSpec(
 27                cloud='aws',
 28                region='us-west-2'
 29            )
 30        )
 31"""
 32    msg = f"""init is no longer a top-level attribute of the pinecone package.
 33
 34Please create an instance of the Pinecone class instead.
 35
 36Example:
 37{example}
 38"""
 39    raise AttributeError(msg)
 40
 41
 42def list_indexes(*args, **kwargs):
 43    example = """
 44    from pinecone import Pinecone
 45    
 46    pc = Pinecone(api_key='YOUR_API_KEY')
 47
 48    index_name = "quickstart" # or your index name
 49
 50    if index_name not in pc.list_indexes().names():
 51        # do something
 52"""
 53    raise AttributeError(_build_class_migration_message("list_indexes", example))
 54
 55
 56def describe_index(*args, **kwargs):
 57    example = """
 58    from pinecone import Pinecone
 59    
 60    pc = Pinecone(api_key='YOUR_API_KEY')
 61    pc.describe_index('my_index')
 62"""
 63    raise AttributeError(_build_class_migration_message("describe_index", example))
 64
 65
 66def create_index(*args, **kwargs):
 67    example = """
 68    from pinecone import Pinecone, ServerlessSpec
 69
 70    pc = Pinecone(api_key='YOUR_API_KEY')
 71    pc.create_index(
 72        name='my-index',
 73        dimension=1536,
 74        metric='euclidean',
 75        spec=ServerlessSpec(
 76            cloud='aws',
 77            region='us-west-2'
 78        )
 79    )
 80"""
 81    raise AttributeError(_build_class_migration_message("create_index", example))
 82
 83
 84def delete_index(*args, **kwargs):
 85    example = """
 86    from pinecone import Pinecone
 87
 88    pc = Pinecone(api_key='YOUR_API_KEY')
 89    pc.delete_index('my_index')
 90"""
 91    raise AttributeError(_build_class_migration_message("delete_index", example))
 92
 93
 94def scale_index(*args, **kwargs):
 95    example = """
 96    from pinecone import Pinecone
 97
 98    pc = Pinecone(api_key='YOUR_API_KEY')
 99    pc.configure_index('my_index', replicas=2)
100"""
101
102    msg = f"""scale_index is no longer a top-level attribute of the pinecone package.
103
104Please create a client instance and call the configure_index method instead.
105
106Example:
107{example}
108"""
109    raise AttributeError(msg)
110
111
112def create_collection(*args, **kwargs):
113    example = """
114    from pinecone import Pinecone
115    
116    pc = Pinecone(api_key='YOUR_API_KEY')
117    pc.create_collection(name='my_collection', source='my_index')
118"""
119    raise AttributeError(_build_class_migration_message("create_collection", example))
120
121
122def list_collections(*args, **kwargs):
123    example = """
124    from pinecone import Pinecone
125
126    pc = Pinecone(api_key='YOUR_API_KEY')
127    pc.list_collections()
128"""
129    raise AttributeError(_build_class_migration_message("list_collections", example))
130
131
132def delete_collection(*args, **kwargs):
133    example = """
134    from pinecone import Pinecone
135    
136    pc = Pinecone(api_key='YOUR_API_KEY')
137    pc.delete_collection('my_collection')
138"""
139    raise AttributeError(_build_class_migration_message("delete_collection", example))
140
141
142def describe_collection(*args, **kwargs):
143    example = """
144    from pinecone import Pinecone
145    
146    pc = Pinecone(api_key='YOUR_API_KEY')
147    pc.describe_collection('my_collection')
148"""
149    raise AttributeError(_build_class_migration_message("describe_collection", example))
150
151
152def configure_index(*args, **kwargs):
153    example = """
154    from pinecone import Pinecone
155    
156    pc = Pinecone(api_key='YOUR_API_KEY')
157    pc.configure_index('my_index', replicas=2)
158"""
159    raise AttributeError(_build_class_migration_message("configure_index", example))