Skip to content

Update docs with the latest changes #12

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Nuvindu merged 1 commit into from
Sep 2, 2025
Merged

Update docs with the latest changes #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,9 +71,7 @@ ai:VectorStore vectorStore = check new weaviate:VectorStore(
config = {
collectionName: "add-collection-name"
},
auth = {
token: "add-access-token"
}
apiKey = "mock-token"
);
```

Expand All @@ -83,7 +81,7 @@ ai:VectorStore vectorStore = check new weaviate:VectorStore(
ai:Error? result = vectorStore.add(
[
{
id: uuid:createRandomUuid(),
id: "1",
embedding: [1.0, 2.0, 3.0],
chunk: {
'type: "text",
Expand All @@ -98,7 +96,7 @@ ai:Error? result = vectorStore.add(

The Ballerina Weaviate vector store module provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-ai.weaviate/tree/main/examples).

1. [Book Recommendation System](https://github.com/ballerina-platform/module-ballerinax-ai.weaviate/tree/main/examples/book-recommendation-system)
1. [Book recommendation system](https://github.com/ballerina-platform/module-ballerinax-ai.weaviate/tree/main/examples/book-recommendation-system)
This example shows how to use Weaviate vector store APIs to implement a book recommendation system that stores book embeddings and queries them to find similar books based on vector similarity and metadata filtering.

## Issues and projects
Expand Down
8 changes: 3 additions & 5 deletions ballerina/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,9 +66,7 @@ ai:VectorStore vectorStore = check new weaviate:VectorStore(
config = {
collectionName: "add-collection-name"
},
auth = {
token: "add-access-token"
}
apiKey = "mock-token"
);
```

Expand All @@ -78,7 +76,7 @@ ai:VectorStore vectorStore = check new weaviate:VectorStore(
ai:Error? result = vectorStore.add(
[
{
id: uuid:createRandomUuid(),
id: "1",
embedding: [1.0, 2.0, 3.0],
chunk: {
'type: "text",
Expand All @@ -93,5 +91,5 @@ ai:Error? result = vectorStore.add(

The Ballerina Weaviate vector store module provides practical examples illustrating usage in various scenarios. Explore these [examples](https://github.com/ballerina-platform/module-ballerinax-ai.weaviate/tree/main/examples).

1. [Book Recommendation System](https://github.com/ballerina-platform/module-ballerinax-ai.weaviate/tree/main/examples/book-recommendation-system)
1. [Book recommendation system](https://github.com/ballerina-platform/module-ballerinax-ai.weaviate/tree/main/examples/book-recommendation-system)
This example shows how to use Weaviate vector store APIs to implement a book recommendation system that stores book embeddings and queries them to find similar books based on vector similarity and metadata filtering.
1 change: 1 addition & 0 deletions ballerina/vector_store.bal
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ public isolated class VectorStore {
# Initializes the Weaviate vector store with the given configuration.
#
# + serviceUrl - The URL of the Weaviate service
# + apiKey - The API key for the Weaviate service
# + config - The configurations containing collection name, topK, and chunk field name
# + httpConfig - The HTTP configuration for the Weaviate client connection
# + return - An `ai:Error` if the initialization fails, otherwise returns `()`
Expand Down
Loading