docs: vector sdk for php #373

heyjorgedev · 2025-01-22T18:29:42Z

No description provided.

linear · 2025-01-22T18:29:45Z

yunusemreozdemir · 2025-01-29T17:23:30Z

vector/sdks/php/getting-started.mdx

+## Install
+
+```shell composer
+composer require upstash/vector


I think we should also mention the upstash/vector-laravel and its setup here. One way could be turning the code examples in this page to code groups and having PHP and Laravel tabs. For reference you can check out Code Groups Documentation.

vector/sdks/php/commands/upsert-data.mdx

yunusemreozdemir · 2025-01-29T17:28:50Z

Just making sure, Resumable Query and Range operations are not yet available in the SDK right?

yunusemreozdemir · 2025-01-29T17:33:40Z

Can we add PHP to the code examples in Vector->Overall->Getting Started

yunusemreozdemir · 2025-01-29T17:35:54Z

Can we mention the PHP and Laravel SDKs in the Vector->Overall->Changelog.

yunusemreozdemir · 2025-01-29T17:40:43Z

Can we add PHP to the code examples in the following pages under Vector->Features:

Hybrid Indexes
Sparse Indexes
Metadata and Data
Metadata Filtering
Embedding Models
Namespaces
Resumable Query (If implemented in the SDK)

yunusemreozdemir · 2025-01-29T17:45:03Z

This can be done in the future in another PR: I think we should add at least one example and one tutorial with PHP under Vector->Examples and Vector->Tutorials respectively.

yunusemreozdemir · 2025-01-29T17:47:59Z

Just making sure, we don't have something similar to Index level types and Command level types stated under TypeScript Usage as PHP doesn't have generics right?

yunusemreozdemir · 2025-01-29T17:52:52Z

Can we add PHP to the code examples in the following pages under Vector->Features:

Hybrid Indexes

Sparse Indexes

Metadata and Data

Metadata Filtering

Embedding Models

Namespaces

Resumable Query (If implemented in the SDK)

There are references to these pages in the new guides, if for some reason we decide to merge this PR with these pages to be implemented in the future, we need to make sure guides present an understandable flow even with these references missing code examples.

yunusemreozdemir · 2025-01-29T18:04:20Z

vector/sdks/php/commands/upsert-vectors.mdx

+]);
+```
+
+Upserting multiple records simultaneously improves performance by allowing you to batch your imports efficiently.


Can we revisit this sentence? We can use something else instead of imports. Maybe we can also provide a better explanation of why batch requests improve the performance, such as reducing network overheads. I would think someone from the core team may provide a better explanation.

vector/sdks/php/commands/upsert-vectors.mdx

yunusemreozdemir · 2025-01-29T18:08:31Z

vector/sdks/php/commands/upsert-vectors.mdx

+
+## Hybrid Indexes
+
+If your vector index is configured to use hybrid indexes, you need to provide both sparse vectors and dense vectors.


Suggested change

If your vector index is configured to use hybrid indexes, you need to provide both sparse vectors and dense vectors.

If you are using a hybrid index, you need to provide both sparse vectors and dense vectors.

yunusemreozdemir · 2025-01-29T18:09:57Z

vector/sdks/php/commands/upsert-vectors.mdx

+
+With Upstash Vector, you can upsert one or more vectors. For now, let’s focus on upserting a single vector.
+
+We’ll use the `upsert()` method to instruct the SDK to upsert vectors into an index, as shown below:


Suggested change

We’ll use the `upsert()` method to instruct the SDK to upsert vectors into an index, as shown below:

We’ll use the `upsert()` method to instruct the SDK to upsert or update vectors into an index, as shown below:

I think we can have an Update section after the Upsert Many that explains you can update your vectors simply with these operations.

yunusemreozdemir · 2025-01-29T18:14:42Z

vector/sdks/php/commands/upsert-data.mdx

+  data: 'The capital of Japan is Tokyo',
+));
+// or within a namespace
+$index->namespace('my-namespace')->upsertData(new DataUpsert(


Not sure about this being here, maybe we can turn this into a Code Group and have a separate tab for the namespace example.

yunusemreozdemir · 2025-01-29T18:20:45Z

vector/sdks/php/commands/upsert-data.mdx

+title: Upserting Vectors with Embedded Models
+---
+
+Upstash Vector includes embedded models that can automatically generate vector embeddings for you.


Suggested change

Upstash Vector includes embedded models that can automatically generate vector embeddings for you.

Upstash Vector provides embedding models that can automatically generate vector embeddings for you.

yunusemreozdemir · 2025-01-29T18:21:35Z

vector/sdks/php/commands/upsert-data.mdx

+
+## Upsert Data
+
+We’ll use the `upsertData()` method to instruct the SDK to upsert data that generates vectors from one of our embedding models, as demonstrated below:


Suggested change

We’ll use the `upsertData()` method to instruct the SDK to upsert data that generates vectors from one of our embedding models, as demonstrated below:

We’ll use the `upsertData()` method to instruct the SDK to upsert or update data that generates vectors from one of our embedding models, as demonstrated below:

yunusemreozdemir · 2025-01-29T18:22:36Z

vector/sdks/php/commands/upsert-vectors.mdx

+  vector: [0.1, 0.2, ...], // "..." represents the dimension size of your vector index.
+));
+// or within a namespace
+$index->namespace('my-namespace')->upsert(new VectorUpsert(


As mentioned before, maybe we can turn this into a Code Group and have a separate tab for namespace.

yunusemreozdemir · 2025-01-29T18:34:59Z

vector/sdks/php/commands/query.mdx

+  topK: 15, // topK is the limit number of records we want to be returned.
+  includeMetadata: true, // (optional) if true the query results will contain metadata.
+  includeVectors: true, // (optional) if true the query results will contain the indexed vectors.
+  includeData: true, // (optional) if true the query results will contain the string data.


I think we should have a Response section in this page that is detailing the response that will be returned with an example preferably from a Hybrid index. Since looking at all the includeMetadata, includeData, includeVectors options can be confusing without a concrete response to understand them.

yunusemreozdemir · 2025-01-29T18:36:23Z

vector/sdks/php/commands/query.mdx

Just to be sure, we can't implement something similar to Improved Typechecking example in the TypeScript since PHP doesn't have generics right?

yunusemreozdemir · 2025-01-29T18:37:03Z

vector/sdks/php/commands/query.mdx

+  includeData: true, // (optional) if true the query results will contain the string data.
+  filter: '', // (optional) if set, the query results will be filtered by the given filter.
+));
+// or within a namespace


Maybe we can move this to a Code Group tab called Namespace.

yunusemreozdemir · 2025-01-29T18:39:27Z

vector/sdks/php/commands/query.mdx

Let's also add the following information boxes to this page:

The dimension of the query vector must match the dimension of your index.

The score returned from query requests is a normalized value between 0 and 1, where 1 indicates the highest similarity and 0 the lowest regardless of the similarity function used.

yunusemreozdemir · 2025-01-29T18:42:35Z

vector/sdks/php/commands/fetch.mdx

+  includeData: true, // (optional) if true the fetch results will contain the string data.
+));
+// or within a namespace
+$results = $index->namespace('my-namespace')->fetch(new VectorFetch(


As mentioned before:

Maybe we can move this to a Code Group tab called Namespace.

yunusemreozdemir · 2025-01-29T18:43:23Z

vector/sdks/php/commands/fetch.mdx

+  ids: ['1', '2'],
+  includeMetadata: true, // (optional) if true the fetch results will contain metadata.
+  includeVectors: true, // (optional) if true the fetch results will contain the indexed vectors.
+  includeData: true, // (optional) if true the fetch results will contain the string data.


As mentioned before:

I think we should have a Response section in this page that is detailing the response that will be returned with an example preferably from a Hybrid index. Since looking at all the includeMetadata, includeData, includeVectors options can be confusing without a concrete response to understand them.

yunusemreozdemir · 2025-01-29T18:49:07Z

vector/sdks/php/commands/delete-vectors.mdx

+
+$index->delete(['1', '2', '3']);
+// or within a namespace
+$index->namespace('my-namespace')->delete(['1', '2', '3']);


As mentioned before:

Maybe we can move this to a Code Group tab called Namespace.

yunusemreozdemir · 2025-01-29T18:51:23Z

vector/sdks/php/commands/reset.mdx

+
+You can reset a namespace by calling the `reset()` method on the index or namespace.
+
+If the `reset()` method is called on the index, only the default namespace will be reseted, not the whole index.


Suggested change

If the `reset()` method is called on the index, only the default namespace will be reseted, not the whole index.

If the `reset()` method is called on the index, only the default namespace will be reset, not the whole index.

yunusemreozdemir · 2025-01-29T18:55:14Z

vector/sdks/php/commands/info.mdx

+// To know the number of vectors ready to query.
+$info->vectorCount;
+
+// To know the number of vector that are getting indexed.


Suggested change

// To know the number of vector that are getting indexed.

// To know the number of vectors that are getting indexed.

yunusemreozdemir · 2025-01-29T18:55:36Z

vector/sdks/php/commands/info.mdx

+// To know the number of vectors ready to query.
+$myNamespaceInfo->vectorCount;
+
+// To know the number of vector that are getting indexed.


Suggested change

// To know the number of vector that are getting indexed.

// To know the number of vectors that are getting indexed.

yunusemreozdemir · 2025-01-29T18:57:28Z

vector/sdks/php/commands/info.mdx

+$info->similarityFunction;
+
+// List of namespaces.
+$namespaces = $info->namespaces;


I think this is not a list of namespaces but a mapping of namespaces to their information that contains vectorCount and pendingVectorCount.

yunusemreozdemir · 2025-01-29T18:58:50Z

vector/sdks/php/commands/info.mdx

I think we should have example responses for index info and namespace info.

yunusemreozdemir · 2025-01-29T19:02:23Z

We have a Contributing page in TypeScript. You can add one to PHP if you want, though it is more important to have this in the repositories.

heyjorgedev · 2025-01-30T08:12:23Z

Just making sure, Resumable Query and Range operations are not yet available in the SDK right?

That's right

heyjorgedev · 2025-01-30T08:48:49Z

Can we add PHP to the code examples in Vector->Overall->Getting Started

Great suggestion! Done

Co-authored-by: Yunus Emre Özdemir <[email protected]>

yunusemreozdemir · 2025-01-30T10:04:15Z

vector/sdks/php/commands/query.mdx

+
+$results = $index->queryData(new DataQuery(
+  data: 'What is the capital of France?',
+  topK: 1, // to only return 1 result.


One small detail, let's set includeData to true here so someone trying this example can see the results right away!

wip

07f6afc

heyjorgedev changed the title ~~wip~~ PHP - Vector SDK Docs Jan 22, 2025

heyjorgedev changed the title ~~PHP - Vector SDK Docs~~ docs: vector sdk for php Jan 22, 2025

mintlify bot deployed to staging January 22, 2025 18:33 View deployment

heyjorgedev added 2 commits January 23, 2025 16:07

wip

ecda9b9

add info page

a490d4e

mintlify bot deployed to staging January 23, 2025 09:49 View deployment

add reset docs

057f1c8

mintlify bot deployed to staging January 23, 2025 11:08 View deployment

add delete vectors docs

e746f73

mintlify bot deployed to staging January 24, 2025 11:11 View deployment

add upsert command

a11740a

mintlify bot deployed to staging January 24, 2025 12:23 View deployment

wip

d950d84

mintlify bot deployed to staging January 24, 2025 12:25 View deployment

refactor section & add upsert data

c9a4aa1

mintlify bot deployed to staging January 24, 2025 13:35 View deployment

add query docs

28618fc

mintlify bot deployed to staging January 24, 2025 14:01 View deployment

fix: update screenshots in vector gettingstarted

2f70081

mintlify bot deployed to staging January 27, 2025 08:45 View deployment

docs: fetch

7ea9f3a

mintlify bot deployed to staging January 28, 2025 10:37 View deployment

heyjorgedev added 2 commits January 28, 2025 17:47

wip

9e89bdf

wip

7ea194a

mintlify bot deployed to staging January 28, 2025 10:48 View deployment

heyjorgedev marked this pull request as ready for review January 28, 2025 12:33

yunusemreozdemir reviewed Jan 29, 2025

View reviewed changes

vector/sdks/php/commands/upsert-data.mdx Outdated Show resolved Hide resolved

yunusemreozdemir reviewed Jan 29, 2025

View reviewed changes

wip

23fc10b

mintlify bot deployed to staging January 30, 2025 08:12 View deployment

wip

b82d84a

mintlify bot deployed to staging January 30, 2025 08:48 View deployment

apply suggestion

bf64dbd

Co-authored-by: Yunus Emre Özdemir <[email protected]>

mintlify bot deployed to staging January 30, 2025 08:50 View deployment

yunusemreozdemir reviewed Jan 30, 2025

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: vector sdk for php #373

docs: vector sdk for php #373

heyjorgedev commented Jan 22, 2025

linear bot commented Jan 22, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir commented Jan 29, 2025

yunusemreozdemir commented Jan 29, 2025

yunusemreozdemir commented Jan 29, 2025

yunusemreozdemir commented Jan 29, 2025

yunusemreozdemir commented Jan 29, 2025

yunusemreozdemir commented Jan 29, 2025

yunusemreozdemir commented Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir Jan 29, 2025

yunusemreozdemir commented Jan 29, 2025

heyjorgedev commented Jan 30, 2025

heyjorgedev commented Jan 30, 2025

yunusemreozdemir Jan 30, 2025


		## Hybrid Indexes

		If your vector index is configured to use hybrid indexes, you need to provide both sparse vectors and dense vectors.

	If your vector index is configured to use hybrid indexes, you need to provide both sparse vectors and dense vectors.
	If you are using a hybrid index, you need to provide both sparse vectors and dense vectors.


		With Upstash Vector, you can upsert one or more vectors. For now, let’s focus on upserting a single vector.

		We’ll use the `upsert()` method to instruct the SDK to upsert vectors into an index, as shown below:

	Upstash Vector includes embedded models that can automatically generate vector embeddings for you.
	Upstash Vector provides embedding models that can automatically generate vector embeddings for you.


		## Upsert Data

		We’ll use the `upsertData()` method to instruct the SDK to upsert data that generates vectors from one of our embedding models, as demonstrated below:


		You can reset a namespace by calling the `reset()` method on the index or namespace.

		If the `reset()` method is called on the index, only the default namespace will be reseted, not the whole index.

	// To know the number of vector that are getting indexed.
	// To know the number of vectors that are getting indexed.

docs: vector sdk for php #373

Are you sure you want to change the base?

docs: vector sdk for php #373

Conversation

heyjorgedev commented Jan 22, 2025

linear bot commented Jan 22, 2025

Choose a reason for hiding this comment

yunusemreozdemir commented Jan 29, 2025

yunusemreozdemir commented Jan 29, 2025

yunusemreozdemir commented Jan 29, 2025

yunusemreozdemir commented Jan 29, 2025

yunusemreozdemir commented Jan 29, 2025

yunusemreozdemir commented Jan 29, 2025

yunusemreozdemir commented Jan 29, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

yunusemreozdemir commented Jan 29, 2025

heyjorgedev commented Jan 30, 2025

heyjorgedev commented Jan 30, 2025

Choose a reason for hiding this comment