simple-pinecone-php

simple-pinecone-php

Access the Pinecone APIs thorugh PHP.

:cloud: Installation

composer require IonicaBizau/simple-pinecone-php

If you do not use composer, you can simply download the file lib/pinecone.php and include it in your project:

<?php
  require "pinecone.php";
  $pinecone = new Pinecone("your api key", "https://your-host-url");

Example

<?php
  require "pinecone.php";

  $pinecone = new Pinecone(PINECONE_API_KEY, PINECONE_HOST);
  $indexes = $pinecone->getRequest("https://api.pinecone.io/indexes");

  header("Content-Type: application/json");

  // List the vector IDs
  $vectorIds = $pinecone->getRequest("/vectors/list", [
    "namespace" => "example-namespace"
  ]);
  echo json_encode($vectorIds);

  // Upsert vector
  $text = "Hello World";

  // Define the function to compute the embedding (via OpenAI etc)
  $embedding = getEmbedding($text);
  $vector = [
      'id' => md5($text),
      'values' => $embedding,
      'metadata' => [
          'title' => "Example"
      ]
  ];

  // Upsert the vector
  $res = $pinecone->postRequest("/vectors/upsert", [
      "vectors" => [$vector]
  ]);

:memo: Documentation

Pinecone($apiKey, $hostUrl, $apiVersion)

Constructor to initialize the Pinecone API client.

Params

• String $apiKey: The API key for authentication.
• String $hostUrl: The base URL of the Pinecone API.
• String $apiVersion: The API version, default is '2025-01'.

pinecone.request($method, $pathname, $data)

Makes an HTTP request to the Pinecone API.

Params

• String $method: HTTP method (GET or POST).
• String $pathname: The API endpoint path.
• Array $data: The data to send with the request.

Return

• Array The API response as an associative array.

pinecone.getRequest($pathname, $queryStringParamsAsArray)

Sends a GET request to the Pinecone API.

Params

• String $pathname: The API endpoint path.
• Array $queryStringParamsAsArray: Query parameters as an associative array.

Return

• Array The API response as an associative array.

pinecone.postRequest($pathname, $bodyAsArray)

Sends a POST request to the Pinecone API.

Params

• String $pathname: The API endpoint path.
• Array $bodyAsArray: The request body as an associative array.

Return

• Array The API response as an associative array.

:question: Get Help

There are few ways to get help:

• Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
• For bug reports and feature requests, open issues. :bug:
• For direct and quick help, you can use Codementor. :rocket:

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

• Starring and sharing the projects you like :rocket:

• —I love books! I will remember you after years if you buy me one. :grin: :book:

• —You can make one-time donations via PayPal. I'll probably buy a coffee tea. :tea:

• —Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).

• Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

  

Thanks! :heart:

:scroll: License

MIT © Ionică Bizău