Skip to content

Commit 30de899

Browse files
update docs
Signed-off-by: AnthonyTsu1984 <[email protected]>
1 parent c2dcbc3 commit 30de899

File tree

196 files changed

+916
-471
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

196 files changed

+916
-471
lines changed

API_Reference/pymilvus/v2.4.x/About.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,14 +18,14 @@ In this release, you have the flexibility to choose MilvusClient or the original
1818
| 2.1.x | 2.1.3 |
1919
| 2.2.x | 2.2.3 |
2020
| 2.3.x | 2.3.7 |
21-
| 2.4.x | 2.4.10 |
21+
| 2.4.x | 2.4.15 |
2222

2323
## Install & Update
2424

2525
You can run the following command to install the latest PyMilvus or update your PyMilvus to this version.
2626

2727
```shell
28-
pip install --upgrade pymilvus==v2.4.10
28+
pip install --upgrade pymilvus==v2.4.15
2929
```
3030

3131
After the installation, you can check the PyMilvus version by running the following

API_Reference/pymilvus/v2.4.x/DataImport/BulkImport/bulk_import.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ This operation imports the prepared data files to Milvus. To learn how to prepar
88
bulk_import(
99
url: str,
1010
collection_name: str,
11+
db_name: str = "default"
1112
files: list
1213
)
1314
```
@@ -16,19 +17,21 @@ bulk_import(
1617

1718
- **url** (*string*) -
1819

19-
**[REQUIRED]**
20+
**&#91;REQUIRED&#93;**
2021

2122
The URI of your Milvus instance.
2223

2324
- **collection_name** (*string*) -
2425

25-
**[REQUIRED]**
26+
**&#91;REQUIRED&#93;**
2627

2728
The name of a collection in the target cluster of this operation.
2829

29-
- **files** (*list*) -
30+
- **db_name** (*string*) -
31+
32+
The name of the target database. The value of this parameter defaults to `default`.
3033

31-
**[REQUIRED]**
34+
- **files** (*list*) -
3235

3336
The list of string lists, each string list contains a singular row-based file path or multiple column-based file paths.
3437

API_Reference/pymilvus/v2.4.x/DataImport/BulkImport/get_import_progress.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,13 +8,13 @@ This operation gets the progress of the specified bulk-import job.
88

99
- **url** (*string*) -
1010

11-
**[REQUIRED]**
11+
**&#91;REQUIRED&#93;**
1212

1313
The URI of your Milvus instance.
1414

1515
- **job_id** (*string*) -
1616

17-
**[REQUIRED]**
17+
**&#91;REQUIRED&#93;**
1818

1919
The ID of the bulk-import job of your interest.
2020

API_Reference/pymilvus/v2.4.x/DataImport/BulkImport/list_import_jobs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ list_import_jobs(
1515

1616
- **url** (*string*) -
1717

18-
**[REQUIRED]**
18+
**&#91;REQUIRED&#93;**
1919

2020
The URI of your Milvus instance.
2121

API_Reference/pymilvus/v2.4.x/DataImport/LocalBulkWriter/LocalBulkWriter.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,13 @@ writer = LocalBulkWriter(
3434

3535
- **schema** (*[CollectionSchema](../../ORM/CollectionSchema/CollectionSchema.md)*) -
3636

37-
**[REQUIRED]**
37+
**&#91;REQUIRED&#93;**
3838

3939
The schema of a target collection to which the rewritten data is to be imported.
4040

4141
- **local_path** (*str*) -
4242

43-
**[REQUIRED]**
43+
**&#91;REQUIRED&#93;**
4444

4545
The path to the directory that is to hold the rewritten data.
4646

API_Reference/pymilvus/v2.4.x/DataImport/RemoteBulkWriter/AzureConnectParam.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ connect_param = RemoteBulkWriter.AzureConnectParam(
4444

4545
- **account_url** (*str*)
4646

47-
A string in format like `https://<storage-account>.blob.core.windows.net`.
47+
A string in format like `<i>http</i>s://<storage-account>.blob.core.windows.net`.
4848

4949
Read [this link](https://learn.microsoft.com/en-us/azure/storage/common/storage-account-overview) for more info.
5050

API_Reference/pymilvus/v2.4.x/DataImport/RemoteBulkWriter/RemoteBulkWriter.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ Constructs a **RemoteBulkWriter** object with a set of parameters, such as **sch
1414

1515
<p><b>notes</b></p>
1616

17-
<p>A <strong>RemoteBulkWriter</strong> object intends to rewrite your raw data in a format that Milvus understands into an AWS-S3-compatible bucket.</p>
17+
<p>A <strong>RemoteBulkWriter</strong> object intends to rewrite your raw data in a format that Milvus understands into an AWS-S3-compatible or a Microsoft Azure Blob Storage bucket.</p>
1818

1919
</div>
2020

@@ -35,13 +35,13 @@ writer = RemoteBulkWriter(
3535

3636
- **schema** (*[CollectionSchema](../../ORM/CollectionSchema/CollectionSchema.md)*) -
3737

38-
**[REQUIRED]**
38+
**&#91;REQUIRED&#93;**
3939

4040
The schema of a target collection to which the rewritten data is to be imported.
4141

4242
- **remote_path** (*str*) -
4343

44-
**[REQUIRED]**
44+
**&#91;REQUIRED&#93;**
4545

4646
The path to the directory that is to hold the rewritten data.
4747

API_Reference/pymilvus/v2.4.x/EmbeddingModels/BM25EmbeddingFunction/encode_documents.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ encode_documents(
1414

1515
**PARAMETERS:**
1616

17-
- **documents** (*List[str]*)
17+
- **documents** (*List&#91;str&#93;*)
1818

1919
A list of string values, where each string represents a document that will be passed to the embedding model for encoding. The model will generate an embedding vector for each string in the list.
2020

API_Reference/pymilvus/v2.4.x/EmbeddingModels/BM25EmbeddingFunction/encode_queries.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ encode_queries(
1414

1515
**PARAMETERS:**
1616

17-
- **queries** (*List[str]*)
17+
- **queries** (*List&#91;str&#93;*)
1818

1919
A list of string values, where each string represents a query that will be passed to the embedding model for encoding. The model will generate an embedding vector for each string in the list.
2020

API_Reference/pymilvus/v2.4.x/EmbeddingModels/CohereEmbeddingFunction/CohereEmbeddingFunction.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ CohereEmbeddingFunction(
4343

4444
- `"clustering"`: Used for the embeddings run through a clustering algorithm.
4545

46-
- **embedding_types** (*List[str]*)
46+
- **embedding_types** (*List&#91;str&#93;*)
4747

4848
The type of embeddings you want to get back. Not required and default is None, which returns the Embed Floats response type. Currently, you can only specify a single value for this parameter. Possible values:
4949

0 commit comments

Comments
 (0)