/zdoc-demos

Primary LanguageJupyter Notebook

Demos in Zilliz Cloud Documents

This repository provides all executable demos in Zilliz Cloud documents, including those in Python, Java, Golang, Node.js, and RESTful API.

Before you start

Running any demo in this repository requires the installation of corresponding SDKs, and you are advised to keep these SDKs update to date.

Roadmaps

PyMilvus: Python SDK

Before running the demos in the python folder, ensure that you have run the following code snippets.

> cd python
> pip install -r requirements.txt

To run the demos, do as following in the python folder:

  • Fill in the necessary parameters, such as YOUR_CLUSTER_ENDPOINT and YOUR_CLUSTER_TOKEN in the file.

  • Run the following command in the terminal.

    # replace this with the one you are interested in.
> python 00_quick_start.py

Doc content

Case Code File Status
Quick start python/00_quick_start.py Ready
python/00_quick_start.ipynb Ready
Use Customized Schema python/01_use_customized_schema.py Ready
python/01_use_customized_schema.ipynb Ready
Enable Dynamic Schema python/02_enable_dynamic_schema.py Ready
python/02_enable_dynamic_schema.ipynb Ready
Use Partition Key python/03_use_partition_key.py Ready
python/03_use_partition_key.ipynb Ready
Use JSON Fields python/04_use_json_field.py Ready
python/04_use_json_field.ipynb Ready
Use BulkWriter for Data Import python/05_use_local-bulk-writer.py Ready
python/05_use_local-bulk-writer.ipynb Ready
python/06_use_remote-bulk-writer.py Ready
python/06_use_remote-bulk-writer.ipynb Ready
python/07_use_bulk_import.py Ready
python/07_use_bulk_import.ipynb Ready
Upsert Entities python/08_upsert_entities.py Ready
python/08_upsert_entities.ipynb Ready
Search & Query with Iterators python/09_search_query_iterators.py Ready
python/09_search_query_iterators.ipynb Ready
Search & Query with Advanced Ops python/10_search_query_advanced_ops.py Ready
python/10_search_query_advanced_ops.ipynb Ready
Conduct a Range Search python/11_conduct_a_range_search.py Ready
python/11_conduct_a_range_search.ipynb Ready

Integrations

Case Code File Status
Integartions with OpenAI python/80_integrations_openai.py Ready
python/80_integrations_openai.ipynb Ready
Integartions with HuggingFace python/81_integrations_huggingface.py Ready
python/81_integrations_huggingface.ipynb Ready
Integartions with Cohere python/82_integrations_cohere.py Ready
python/82_integrations_cohere.ipynb Ready
Integartions with Langchain python/83_integrations_langchain.py Ready
python/83_integrations_langchain.ipynb Ready
Integartions with PyTorch python/84_integrations_pytorch.py Ready
python/84_integrations_pytorch.ipynb Ready
Integartions with LLamaIndex python/85_integrations_llamaindex.py Ready
python/85_integrations_llamaindex.ipynb Ready
Integartions with SentenceTransformers python/86_integrations_sentencetransformers.py Ready
python/86_integrations_sentencetransformers.ipynb Ready

Java SDK

To run the demos in the java folder, run the following commands:

  • Fill in necessary parameters, such as YOUR_CLUSTER_ENDPOINT and YOUR_CLUSTER_TOKEN in the file.

  • Run the following commands in the terminal.

    # replace the folder with the one you are interested in.
> cd java/quick_start 
> mvn clean compile exec:java
Case Code File Status
Quick start java/QuickStartDemo Ready
Use Customized Schema java/use_customized_schema Ready
Enable Dynamic Schema java/EnableDynamicSchemaDemo Ready
Use Partition Key java/UsePartitionKeyDemo Ready
Use JSON Fields java/UseJsonFieldDemo Ready
Upsert Entities java/UpsertEntities Ready
Search & Query with Advanced Ops java/SearchQueryWithAdvancedOpsDemo Ready
Conduct a Range Search java/ConductaRangeSearchDemo Ready

Node.js SDK

Before running the demos in the node folder, ensure that you have run the following code snippets.

> cd node
> npm install

To run the demos, do the following in the node folder:

  • Fill in necessary parameters, such as YOUR_CLUSTER_ENDPOINT and YOUR_CLUSTER_TOKEN in the file.

  • Run the following commands in the terminal.

    # replace this with the one you are interested in.
> node 00_quick_start.js
Case Code File Status
Quick start node/00_quick_start.js Ready
Use Customized Schema node/01_use_customized_schema.js Ready
Enable Dynamic Schema node/02_enable_dynamic_schema.js Ready
Use Partition Key node/03_use_partition_key.js Ready
Use JSON Fields node/04_use_json_field.js Ready
Upsert Entities node/08_upsert_entities.js Ready
Search & Query with Advanced Ops node/10_search_query_advanced_ops.js Ready
Conduct a Range Search node/11_conduct_a_range_search.js Ready

Go SDK

Before running the demos in the go folder, ensure that you have run the following code snippets.

# replace the folder with the one you are interested in.
> cd go/use_customized_schema
> go mod tidy

To run the demos, do the following in the go project folder:

  • Fill in necessary parameters, such as YOUR_CLUSTER_ENDPOINT and YOUR_CLUSTER_TOKEN in the file.

  • Run the following commands in the terminal.

    # replace the folder and file with the one you are interested in.
> cd go/use_customized_schema
> go run use_customized_schema.go
Case Code File Status
Use Customized Schema go/use_customized_schema/main.go Ready
Enable Dynamic Schema go/enable_dynamic_schema/main.go Ready
Use Partition Key go/use_partition_key/main.go Ready
Use JSON Fields go/use_json_field/main.go Ready

RESTful API

To run the demos, do the following in the curl folder:

  • Fill in necessary parameters, such as YOUR_CLUSTER_ENDPOINT and YOUR_CLUSTER_TOKEN in the file.

  • Run the following commands in the terminal.

    > cd curl
# replace this with the one you are interested.
> sh ./00_quick_start.sh
Case Code File Status
Quick start curl/00_quick_start.sh Ready
curl/00_quick_start.ipynb Ready