File size: 32,891 Bytes
99fef8e | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 | #!/usr/bin/env python3
# encoding: utf-8
# pylint: disable=line-too-long,too-many-arguments,invalid-name,no-member,missing-function-docstring,missing-module-docstring
import logging
import hashlib
import itertools
import os
import sys
from ast import literal_eval
from time import sleep
import requests
import click
import pandas as pd
import matplotlib.pyplot as plt
import numpy as np
import openai
import nltk.data
import pinecone
from bs4 import BeautifulSoup
from bs4.element import Comment
from numpy import random
from sklearn.manifold import TSNE
from sklearn.cluster import KMeans
from rich.console import Console
from rich.table import Table
from tqdm.auto import tqdm
default_region = 'us-west1-gcp'
openai_embed_model = "text-embedding-ada-002"
REGION_HELP = 'Pinecone cluster region'
def tag_visible(element):
""" Strip out undesirables """
if element.parent.name in ['style', 'script', 'head', 'title', 'meta', '[document]']:
return False
if isinstance(element, Comment):
return False
return True
def text_from_html(body):
""" Obv pull text from doc with tag_visible filters """
soup = BeautifulSoup(body, 'html.parser')
texts = soup.findAll(string=True)
visible_texts = filter(tag_visible, texts)
return " ".join(t.strip() for t in visible_texts)
def get_openai_embedding(apikey, data):
""" Fetch an embedding w/ given data """
openai.api_key = apikey
try:
res = openai.Embedding.create(input=data, engine=openai_embed_model)
except:
done = False
while not done:
sleep(5)
try:
res = openai.Embedding.create(
input=data, engine=openai_embed_model)
done = True
except Exception as e:
click.echo(e)
return res
@click.group()
def cli():
"""
A command line interface for working with Pinecone.
"""
pass
def exception_handler(exception_type, exception, traceback):
# All your trace are belong to us!
click.echo(f"Got exception: {exception_type.__name__} {exception}")
click.echo("Make sure PINECONE_API_KEY is correct.")
# sys.excepthook = exception_handler
def _pinecone_init(apikey, environment, indexname=''):
apikey = os.environ.get('PINECONE_API_KEY', apikey)
if apikey == "":
sys.exit(
"No Pinecone API key set through PINECONE_API_KEY environment variable or --apikey\nExample: export PINECONE_API_KEY=1234-abc-9876")
environment = os.environ.get('PINECONE_ENVIRONMENT', environment)
pinecone.init(api_key=apikey, environment=environment)
index = None
if indexname:
try:
# index = pinecone.Index(indexname)
index = pinecone.GRPCIndex(indexname)
except Exception:
logging.exception("Unable to connect. Caught exception:")
sys.exit()
else:
return index
def _format_values(vals):
return ",".join(str(x) for x in vals)[:30]
def _print_table(res, pinecone_index_name, namespace, include_meta, include_values, expand_meta):
table = Table(
title=f"π² {pinecone_index_name} ns=({namespace}) Index Results")
table.add_column("ID", justify="right", style="cyan", no_wrap=True)
table.add_column("NS", justify="left", style="red", no_wrap=True)
if include_values:
table.add_column("Values", style="magenta")
if include_meta:
table.add_column("Meta", justify="right", style="green")
table.add_column("Score", justify="right", style="green")
ns = res['namespace'] if 'namespace' in res else ''
for row in res.matches:
metadata = ''
score = str(row['score'])
vecid = row['id']
if include_meta and 'metadata' in row:
metadata = str(row['metadata'])
metadata = metadata[:100] if not expand_meta else metadata
if include_values and include_meta:
table.add_row(vecid, ns, _format_values(
row['values']), metadata, score)
elif include_values and not include_meta:
table.add_row(vecid, ns, _format_values(
row['values']), score)
elif not include_values and include_meta:
table.add_row(vecid, ns, metadata, score)
elif not include_values and not include_meta:
table.add_row(vecid, ns, score)
console = Console()
console.print(table)
@click.command(short_help='Prints version number.')
def version():
if sys.version_info >= (3, 8):
from importlib import metadata
else:
import importlib_metadata as metadata
click.echo(metadata.version('pinecone_cli'))
@click.command(short_help='Queries Pinecone with a given vector.')
@click.option('--apikey', help='Pinecone API Key')
@click.option('--region', help='Pinecone Index Region', show_default=True, default=default_region)
@click.option('--include_values', help='Should we return the vectors', show_default=True, default=True)
@click.option('--topk', '--numrows', 'topk', type=click.INT, show_default=True, default=10, help='Top K number to return')
@click.option('--namespace', default="", help='Namespace to select results from')
@click.option('--include-meta', help='Whether to include the metadata values', default=False, show_default=True)
@click.option('--expand-meta', help='Whether to fully expand the metadata returned.', is_flag=True, show_default=True, default=False)
@click.option('--meta_filter', help='Filter out metadata w/ the Pinecone filter syntax which is really JSON. Default is no filter.', default="{}")
@click.option('--print-table', help='Display the output as a pretty table.', is_flag=True, show_default=True, default=False)
@click.option('--num-clusters', help='Number of clusters in TSNE plot if --show-tsne is used.', type=click.INT, show_default=True, default=4)
@click.option('--perplexity', '--perp', help='The perplexity of the TSNE plot, if --show-tsne is used.', type=click.INT, default=15, show_default=True)
@click.option('--tsne-random-state', type=click.INT, default=42, show_default=True)
@click.option('--show-tsne', default=False)
@click.argument('pinecone_index_name')
@click.argument('query_vector')
def query(pinecone_index_name, apikey, query_vector, region, topk, include_values, include_meta, expand_meta, num_clusters, perplexity, tsne_random_state, namespace, show_tsne, meta_filter, print_table):
""" Queries Pinecone index named <PINECONE_INDEX_NAME> with the given <QUERY_VECTOR> and optional namespace.
\b
Example:
% ./pinecli.py query lpfactset "[0,0]"
\b
Example 2:
% ./pinecli.py query upsertfile "[1.2, 1.0, 3.0]" --print-table --include-meta=true --filter="{'genre':'drama'}"
\b
Example 3 [Query randomly]:
% ./pinecli.py query lpfactset random
For filter syntax see: https://docs.pinecone.io/docs/metadata-filtering
"""
pinecone_index = _pinecone_init(apikey, region, pinecone_index_name)
if query_vector.lower() == "random":
res = pinecone_index.describe_index_stats()
num_vector_dims = res['dimension']
query_vector = [i for i in range(num_vector_dims)]
else:
query_vector = literal_eval(query_vector)
res = pinecone_index.query(vector=query_vector, top_k=topk, include_metadata=True,
include_values=include_values, namespace=namespace, filter=literal_eval(meta_filter))
if print_table:
_print_table(res, pinecone_index_name, namespace,
include_meta, include_values, expand_meta)
else:
click.echo(res)
if show_tsne:
show_tsne_plot(pinecone_index_name, res.matches,
num_clusters, perplexity, tsne_random_state)
def show_tsne_plot(pinecone_index_name, results, num_clusters, perplexity, random_state):
res2 = np.asarray([np.array(v['values']) for v in results])
df = pd.DataFrame(data=res2)
kmeans = KMeans(n_clusters=num_clusters, init="k-means++",
random_state=random_state, n_init='auto')
kmeans.fit(res2)
labels = kmeans.labels_
df["Cluster"] = labels
tsne = TSNE(n_components=2, perplexity=perplexity,
random_state=42, init='random', learning_rate=200)
embeddings2d = tsne.fit_transform(res2)
x = [x for x, y in embeddings2d]
y = [y for x, y in embeddings2d]
(_, ax) = plt.subplots(figsize=(9, 6)) # inches
plt.style.use('seaborn-whitegrid')
plt.grid(color='#EAEAEB', linewidth=0.5)
ax.spines['top'].set_color(None)
ax.spines['right'].set_color(None)
ax.spines['left'].set_color('#2B2F30')
ax.spines['bottom'].set_color('#2B2F30')
for category, color in enumerate(["purple", "green", "red", "blue", "brown", "gray", "olive", "cyan", "orange", "pink"]):
xs = np.array(x)[df.Cluster == category]
ys = np.array(y)[df.Cluster == category]
plt.scatter(xs, ys, color=color, alpha=0.3)
avg_x = xs.mean()
avg_y = ys.mean()
plt.scatter(avg_x, avg_y, marker="x", color=color, s=100)
plt.title(
f"Clustering of Pinecone Index {pinecone_index_name}", fontsize=16, fontweight='bold', pad=20)
plt.suptitle(
f't-SNE (perplexity={perplexity} clusters={num_clusters})', y=0.92, fontsize=13)
plt.legend(loc='best', frameon=True)
plt.show()
@click.command(short_help='Fetches vectors from Pinecone specified by the vectors\' ids.')
@click.option('--apikey', help='Pinecone API Key')
@click.option('--region', help='Pinecone Index Region', default=default_region)
@click.option('--vector_ids', help='Vector ids to fetch')
@click.option('--pretty', is_flag=True, help='Pretty print output.')
@click.option('--namespace', help='Namespace within the index to search.')
@click.argument('pinecone_index_name')
def fetch(pinecone_index_name, apikey, region, vector_ids, namespace, pretty):
""" Fetch queries from Pinecone by vector_ids
\b
Example:
% ./pinecli.py fetch lpfactset --vector_ids="05b4509ee655aacb10bfbb6ba212c65c"
"""
index = _pinecone_init(apikey, region, pinecone_index_name)
parsed_ids = [x.strip() for x in vector_ids.split(",")]
fetch_response = index.fetch(ids=parsed_ids, namespace=namespace)
if pretty:
click.echo(fetch_response)
else:
click.echo(fetch_response)
@click.command(short_help='Extracts text from url arg, vectorizes w/ openai embedding api, and upserts to Pinecone.')
@click.option('--apikey', help='Pinecone API Key')
@click.option('--region', help='Pinecone Index Region', show_default=True, default=default_region)
@click.option('--namespace', help='Pinecone index namespace', default='', show_default=True)
@click.option("--debug", is_flag=True, show_default=True, default=False, help="Output debug to stdout.")
@click.argument('pinecone_index_name')
@click.argument('vector_literal')
def upsert(pinecone_index_name, apikey, region, vector_literal, namespace, debug):
"""
Upserts vectors into the index <PINECONE_INDEX_NAME> by using the <VECTOR_LITERAL> which is a string representation of a list of tuples.
Note the literal is quoted.
\b
Example:
% ./pinecli.py upsert upsertfile "[('vec1', [0.1, 0.2, 0.3], {'genre': 'drama'}), ('vec2', [0.2, 0.3, 0.4], {'genre': 'action'}),]" --debug
"""
index = _pinecone_init(apikey, region, pinecone_index_name)
if debug:
click.echo(f"Will upload vectors as {literal_eval(vector_literal)}")
resp = index.upsert(vectors=literal_eval(
vector_literal), namespace=namespace)
if debug:
click.echo(resp)
@click.command(short_help='Updates the index based on the given id passed in.')
@click.option('--apikey', help='Pinecone API Key')
@click.option('--region', help='Pinecone Index Region', show_default=True, default=default_region)
@click.option('--namespace', help='Pinecone index namespace', default='', show_default=True)
@click.option("--debug", is_flag=True, show_default=True, default=False, help="Output debug to stdout.")
@click.option("--metadata", help="The update to the metadata values.", default='', show_default=True)
@click.argument("id")
@click.argument('pinecone_index_name')
@click.argument('vector_literal')
def update(pinecone_index_name, apikey, region, id, vector_literal, metadata, namespace, debug):
""" Updates the index <PINECONE_INDEX_NAME> with id <ID> and vector values <VECTOR_LITERAL> """
index = _pinecone_init(apikey, region, pinecone_index_name)
if metadata:
resp = index.update(id=id, values=literal_eval(
vector_literal), set_metadata=literal_eval(metadata), namespace=namespace)
else:
resp = index.update(id=id, values=literal_eval(
vector_literal), namespace=namespace)
if debug:
click.echo(resp)
@click.command(short_help='Extracts text from url arg, vectorizes w/ openai embedding api, and upserts to Pinecone.')
@click.option('--apikey', help='Pinecone API Key')
@click.option('--openaiapikey', required=True, help='OpenAI API Key')
@click.option('--region', help='Pinecone Index Region', show_default=True, default=default_region)
@click.option("--debug", is_flag=True, show_default=True, default=False, help="Output debug to stdout.")
@click.option("--namespace", help='Namespace to store the generated vectors', default='', show_default=True)
@click.option("--metadata_content_key", help="The key used to store the page content in the metadata with.", show_default=True, default="content")
@click.option("--window", help='Number of sentences to combine in one embedding (vector).', show_default=True, default=10)
@click.option("--stride", help='Number of sentences to stride over to create overlap', show_default=True, default=4)
@click.option('--url')
@click.option('--pinecone_index_name')
def upsert_webpage(pinecone_index_name, apikey, namespace, openaiapikey, metadata_content_key, region, url, window, stride, debug):
""" Upserts vectors into the index <PINECONE_INDEX_NAME> using the openai embeddings api. You will need your api key for openai and specify it using --openapikey """
pinecone_index = _pinecone_init(apikey, region, pinecone_index_name)
# req = Request(url, headers={'User-Agent': 'Mozilla/5.0'})
# html = urllib.request.urlopen(req).read()
html = requests.get(url).text
html = text_from_html(html)
nltk.download('punkt')
tokenizer = nltk.data.load('tokenizers/punkt/english.pickle')
sentences = tokenizer.tokenize(html)
sentences = list(filter(None, sentences))
new_data = []
text = ''
for i in tqdm(range(0, len(sentences), stride)): # TODO: Use trange
i_end = min(len(sentences)-1, i+window)
if sentences[i] == sentences[i_end]:
continue
text = ' '.join(sentences[i:i_end]).strip()
# create the new merged dataset
if debug:
click.echo(f"Text is: {text}")
if text != "":
new_data.append(text)
new_data.append(sentences[-1])
new_data = list(filter(None, new_data))
if debug:
click.echo(*new_data, sep="\n")
batch_size = 10 # how many embeddings we create and insert at once
for i in tqdm(range(0, len(new_data), batch_size)):
i_end = min(len(new_data), i+batch_size)
meta_batch = new_data[i:i_end]
ids_batch = [hashlib.md5(x.encode('utf-8')).hexdigest()
for x in meta_batch]
res = get_openai_embedding(openaiapikey, meta_batch)
embeds = [record['embedding'] for record in res['data']]
meta_batch = [{metadata_content_key: x} for x in meta_batch]
to_upsert = list(zip(ids_batch, embeds, meta_batch))
rv = pinecone_index.upsert(vectors=to_upsert, namespace=namespace)
if debug:
click.echo(rv)
@click.command(short_help='Shows a preview of vectors in the <PINECONE_INDEX_NAME>')
@click.option('--apikey', help='Pinecone API Key')
@click.option('--region', help='Pinecone Index Region', default=default_region)
@click.option('--topk', '--numrows', 'topk', default=10, help='The number of rows to show')
@click.option('--random_dims', is_flag=True, help='Flag to have query vector dims be random. Default will be 0.0')
@click.option('--include-values', help='Should we return the vectors', show_default=True, default=True)
@click.option('--namespace', default="", help='Namespace to select results from')
@click.option('--include-meta', help='Whether to include the metadata values', default=False, show_default=True)
@click.option('--expand-meta', help='Whether to fully expand the metadata returned.', is_flag=True, show_default=True, default=False)
@click.option('--print-table', help='Display the output as a pretty table.', is_flag=True, show_default=True, default=False)
@click.argument('pinecone_index_name')
def head(pinecone_index_name, apikey, region, topk, random_dims, namespace, include_meta, expand_meta, include_values, print_table):
""" Shows a preview of vectors in the <PINECONE_INDEX_NAME> with optional numrows (default 10)
\b
Example 1:
% ./pinecli.py head lpfactset --include-meta=true --include-values=true
{'matches': [{'id': 'ae23d7574c19cea0b3479c93858a3ee3',
'metadata': {'content': 'Oded K. R&D Group Lead Why '
'Pinecone Fast, fresh, and filtered '
'Python client. Scalable Scale from zero '
'to billions of items, with no downtime '
'and minimal latency impact.'},
'score': 0.0,
'sparseValues': {},
'values': [0.010676071,
\b
Example 2: (printing results with a table)
% tim@yoda pinecone-cli % ./pinecli.py head pageuploadtest --include-values=True --include-meta=True --namespace=test --print-table --topk=3
π² pageuploadtest ns=(test) Index Results
ββββββββββββββββββββββββββββββββββββ³βββββββ³βββββββββββββββββββββββββββββββββ³βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ³ββββββββ
β ID β NS β Values β Meta β Score β
β‘ββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ©
β 25d4d1444f9b2942440ce22e026c2a06 β test β -0.00443430152,-0.0156992543,0 β {'content': 'Sign Up for Free or contact us Use Cases What can you do with vector search ? Once you β 0.0 β
β d0bdfbee942fadf531b1feea5b909217 β test β 0.0214423928,-0.0283056349,0.0 β {'content': "Easy to use Get started on the free plan with an easy-to-use API or the Python client. β 0.0 β
β ae23d7574c19cea0b3479c93858a3ee3 β test β 0.0106426,-0.000842177891,-0.0 β {'content': "Oded K. R&D Group Lead Why Pinecone Fast, fresh, and filtered vector search. F β 0.0 β
ββββββββββββββββββββββββββββββββββββ΄βββββββ΄βββββββββββββββββββββββββββββββββ΄βββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββββ΄ββββββββ
"""
index = _pinecone_init(apikey, region, pinecone_index_name)
res = index.describe_index_stats()
dims = res['dimension']
if random_dims:
dims = [random.random() for _ in range(dims)]
else:
dims = [0.0 for _ in range(dims)]
resp = index.query(vector=dims, top_k=topk, namespace=namespace,
include_metadata=include_meta, include_values=include_values)
if print_table:
_print_table(resp, pinecone_index_name, namespace,
include_meta, include_values, expand_meta)
else:
click.echo(resp)
@click.command(short_help='Creates a Pinecone Index.')
@click.option('--apikey', help='Pinecone API Key')
@click.option('--region', help='Pinecone Index Region', default=default_region)
@click.option('--dims', help='Number of dimensions for this index', type=click.INT, required=True)
@click.option('--metric', help='Distance metric to use.', required=True, default='cosine')
@click.option('--pods', help='Number of pods', default=1, show_default=True, type=click.INT)
@click.option('--replicas', help='Number of replicas', default=1, show_default=True, type=click.INT)
@click.option('--shards', help='Number of shards', default=1, show_default=True, type=click.INT)
@click.option('--pod-type', help='Type of pods to create.', required=True)
@click.option('--source_collection', help='Source collection to create index from')
@click.argument('pinecone_index_name')
def create_index(pinecone_index_name, apikey, region, dims, metric, pods, replicas, shards, pod_type, source_collection):
""" Creates the Pinecone index named <PINECONE_INDEX_NAME> """
_pinecone_init(apikey, region)
resp = pinecone.create_index(pinecone_index_name, dimension=dims, metric=metric,
pods=pods, replicas=replicas, shards=shards, pod_type=pod_type)
click.echo(resp)
def chunks(iterable, batch_size=100):
it = iter(iterable)
chunk = tuple(itertools.islice(it, batch_size))
while chunk:
yield chunk
chunk = tuple(itertools.islice(it, batch_size))
def chunks_df(df):
for row in df.itertuples(index=False):
yield row
@click.command(short_help='Upserts a vector(s) with random dimensions into the specified vector.')
@click.option('--apikey', help='Pinecone API Key')
@click.option('--region', help='Pinecone Index Region', default=default_region)
@click.argument('pinecone_index_name')
@click.option('--num_vectors', '--num_rows', '--numrows', type=click.INT)
@click.option('--debug', is_flag=True, default=False, show_default=True)
@click.option('--num_vector_dims', type=click.INT)
def upsert_random(pinecone_index_name, apikey, region, num_vectors, num_vector_dims, debug):
""" Upserts random vectors and dimension values using num_vectors (rows) and num_vector_dims (number of dims per vector). IDs for the example vectors will be of the form \'id-{rownum}\' """
index = _pinecone_init(apikey, region, pinecone_index_name)
# Example generator that generates many (id, vector) pairs
example_data_generator = map(lambda i: (
f'id-{i}', [random.random() for _ in range(num_vector_dims)]), range(num_vectors))
# Upsert data with 100 vectors per upsert request
batch_size = 100
for ids_vectors_chunk in tqdm(chunks(example_data_generator, batch_size=batch_size), total=num_vectors/batch_size):
rv = index.upsert(vectors=ids_vectors_chunk)
if debug:
click.echo(rv)
@click.command(short_help='Upserts a file (csv) into the specified index.')
@click.option('--apikey', help='Pinecone API Key')
@click.option('--region', help='Pinecone Index Region', default=default_region)
@click.option('--batch_size', help='Number vectors to upload per batch', default=100, type=click.INT)
@click.option('--namespace', default='')
@click.option("--debug", is_flag=True, show_default=True, default=False, help="Output debug to stdout.")
@click.argument('vector-file', )
@click.argument('pinecone_index_name')
@click.argument('colmap')
def upsert_file(pinecone_index_name, apikey, region, vector_file, batch_size, colmap, namespace, debug):
colmap = literal_eval(colmap)
if (('id' not in colmap) or ('vectors' not in colmap)):
click.echo(
"Missing 'id' or 'vectors' keys in mapping of CSV file. Check header definitions.")
sys.exit(-1)
reverse_col_map = dict(reversed(list(colmap.items())))
index = _pinecone_init(apikey, region, pinecone_index_name)
def convert(item):
item = item.strip() # remove spaces at the end
item = item[1:-1] # remove `[ ]`
return list(map(float, item.split(',')))
usecols = [reverse_col_map['id'], reverse_col_map['vectors']]
converters = {reverse_col_map['vectors']: convert}
if 'metadata' in colmap:
csv_meta_col_name = reverse_col_map['metadata']
usecols.append(reverse_col_map['metadata'])
converters[csv_meta_col_name] = literal_eval
for chunk in pd.read_csv(vector_file, chunksize=batch_size, index_col=False, usecols=usecols, converters=converters):
v = chunk.to_records(index=False).tolist()
rv = index.upsert(vectors=v, namespace=namespace)
if debug:
click.echo(rv)
@click.command(short_help='Lists the indexes for your api key.')
@click.option('--apikey', help='API Key')
@click.argument('region', default=default_region)
def list_indexes(apikey, region):
""" List all Pinecone indexes for the given api key. """
_pinecone_init(apikey, region)
res = pinecone.list_indexes()
click.echo('\n'.join(res))
@click.command(short_help='Describes an index.')
@click.option('--apikey')
@click.argument('pinecone_index_name', required=True)
@click.option('--region', help='Pinecone Index Region', show_default=True, default=default_region)
def describe_index(apikey, pinecone_index_name, region):
""" Describe a Pinecone index with given index_name. """
_pinecone_init(apikey, region, pinecone_index_name)
desc = pinecone.describe_index(pinecone_index_name)
click.echo("\n".join([f"Name: {desc.name}", f"Dimensions: {int(desc.dimension)}",
f"Metric: {desc.metric}", f"Pods: {desc.pods}", f"PodType: {desc.pod_type}", f"Shards: {desc.shards}",
f"Replicas: {desc.replicas}", f"Ready: {desc.status['ready']}", f"State: {desc.status['state']}",
f"Metaconfig: {desc.metadata_config}", f"Sourcecollection: {desc.source_collection}"]))
@click.command(short_help='Configures the given index to have a pod type.')
@click.option('--apikey', help='Pinecone API Key')
@click.argument('pinecone_index_name', required=True)
@click.option('--region', help='Pinecone Index Region', show_default=True, default=default_region)
@click.option('--pod_type', required=True, help='Type of pod to use')
def configure_index_pod_type(apikey, pinecone_index_name, region, pod_type):
""" Configure the pod type for a given index_name. """
_pinecone_init(apikey, region)
pinecone.configure_index(pinecone_index_name, pod_type=pod_type)
@click.command(short_help='Configures the number of replicas for a given index.')
@click.option('--apikey')
@click.argument('pinecone_index_name', required=True)
@click.option('--region', help='Pinecone Index Region', show_default=True, default=default_region)
@click.option('--num_replicas', required=True, help='Number of replicas to use.')
def configure_index_replicas(apikey, pinecone_index_name, region, num_replicas):
""" Configure the number of replicas for an index. """
_pinecone_init(apikey, region)
pinecone.configure_index(pinecone_index_name, replicas=num_replicas)
@click.command(short_help='Creates a Pinecone collection from the argument \'source_index\'')
@click.option('--apikey')
@click.option('--region', help='Pinecone Index Region', show_default=True, default=default_region)
@click.option('--collection_name', help='The name of the collection to create.', required=True)
@click.option('--source_index', help='The name index to create collection from.', required=True)
def create_collection(apikey, region, collection_name, source_index):
""" Create a Pinecone collection with the given collection_name and source_index. """
_pinecone_init(apikey, region)
pinecone.create_collection(collection_name, source_index)
@click.command(short_help='Prints out index stats to stdout.')
@click.option('--apikey')
@click.option('--region', help='Pinecone Index Region', show_default=True, default=default_region)
@click.argument('pinecone_index_name', required=True)
def describe_index_stats(apikey, region, pinecone_index_name):
""" Show the stats for index with name <PINECONE_INDEX_NAME>. Note that if the index has several namespaces, those will be broken out.
\b
Example:
% ./pinecli.py describe-index-stats lpfactset
"""
index = _pinecone_init(apikey, region, pinecone_index_name)
res = index.describe_index_stats()
console = Console()
click.echo(f"Dimensions: {res['dimension']}")
click.echo(f"Vectors: {res['total_vector_count']}")
click.echo(f"Index_Fullness: {res['index_fullness']}")
ns_data = res['namespaces']
console.print("Namespace data:", style="b")
for ns in ns_data.keys():
click.echo(f"\t{ns}: {ns_data[ns]['vector_count']}")
@click.command(short_help='Lists collections for the given apikey.')
@click.option('--apikey')
@click.option('--region', help='Pinecone Index Region', show_default=True, default=default_region)
def list_collections(apikey, region):
""" List Pinecone collections with the given api key """
_pinecone_init(apikey, region)
res = pinecone.list_collections()
click.echo(*res, sep='\n')
@click.command(short_help='Describes a collection.')
@click.option('--apikey')
@click.option('--region', help='Pinecone Index Region', show_default=True, default=default_region)
@click.argument('collection_name', required=True)
def describe_collection(apikey, region, collection_name):
""" Describe the collection described by <COLLECTION_NAME> """
_pinecone_init(apikey, region)
desc = pinecone.describe_collection(collection_name)
click.echo("\n".join([f"Name: {desc.name}", f"Dimensions: {int(desc.dimension)}",
f"Vectors: {int(desc.vector_count)}", f"Status: {desc.status}", f"Size: {desc.size}"]))
@click.command(short_help="Deletes a collection.")
@click.option('--apikey')
@click.option('--region', help='Pinecone Index Region', show_default=True, default=default_region)
@click.option('--collection_name', help='The name of the collection to create.', required=True)
def delete_collection(apikey, region, collection_name):
""" Delete a collection with the given collection_name """
_pinecone_init(apikey, region)
pinecone.delete_collection(collection_name)
@click.command(short_help='Deletes an index. You will be prompted to confirm.')
@click.option('--apikey')
@click.option('--region', help='Pinecone Index Region', show_default=True, default=default_region)
@click.argument('pinecone_index', required=True)
def delete_index(apikey, region, pinecone_index):
""" Delete an index with the given pinecone_index name """
_pinecone_init(apikey, region)
value = click.prompt('Type name of index backwards to confirm: ')
if value == pinecone_index[::-1]:
pinecone.delete_index(pinecone_index)
else:
click.echo("Index not deleted: reversed index name does not match.")
cli.add_command(query)
cli.add_command(upsert)
cli.add_command(upsert_file)
cli.add_command(upsert_random)
cli.add_command(update)
cli.add_command(list_indexes)
cli.add_command(delete_index)
cli.add_command(create_index)
cli.add_command(describe_index)
cli.add_command(upsert_webpage)
cli.add_command(configure_index_pod_type)
cli.add_command(configure_index_replicas)
cli.add_command(create_collection)
cli.add_command(list_collections)
cli.add_command(describe_collection)
cli.add_command(delete_collection)
cli.add_command(describe_index_stats)
cli.add_command(fetch)
cli.add_command(head)
cli.add_command(version)
if __name__ == "__main__":
cli()
|