Skip to content

Commit

Permalink
docs: Options update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Anush008 authored Nov 4, 2023
1 parent 6196ea8 commit f43e610
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -64,17 +64,17 @@ Qdrant supports all the Spark data types, and the appropriate types are mapped b

## Options and Spark types πŸ› οΈ

| Option | Description | DataType | Required |
| :---------------- | :----------------------------------------------------- | :--------------------- | :------- |
| `qdrant_url` | REST URL of the Qdrant instance | `StringType` | βœ… |
| `collection_name` | Name of the collection to write data into | `StringType` | βœ… |
| `embedding_field` | Name of the field holding the embeddings | `ArrayType(FloatType)` | βœ… |
| `id_field` | Name of the field holding the point IDs | `StringType` | βœ… |
| `schema` | JSON string of the dataframe schema | `StringType` | βœ… |
| `mode` | Write mode of the dataframe. Supports "append". | `StringType` | βœ… |
| `batch_size` | Max size of the upload batch. Default: 100 | `IntType` | ❌ |
| `retries` | Number of upload retries. Default: 3 | `IntType` | ❌ |
| `api_key` | Qdrant API key to be sent in the header. Default: null | `StringType` | ❌ |
| Option | Description | DataType | Required |
| :---------------- | :------------------------------------------------------------------------ | :--------------------- | :------- |
| `qdrant_url` | REST URL of the Qdrant instance | `StringType` | βœ… |
| `collection_name` | Name of the collection to write data into | `StringType` | βœ… |
| `embedding_field` | Name of the field holding the embeddings | `ArrayType(FloatType)` | βœ… |
| `schema` | JSON string of the dataframe schema | `StringType` | βœ… |
| `mode` | Write mode of the dataframe. Supports "append". | `StringType` | βœ… |
| `id_field` | Name of the field holding the point IDs. Default: Generates a random UUId | `StringType` | ❌ |
| `batch_size` | Max size of the upload batch. Default: 100 | `IntType` | ❌ |
| `retries` | Number of upload retries. Default: 3 | `IntType` | ❌ |
| `api_key` | Qdrant API key to be sent in the header. Default: null | `StringType` | ❌ |

## LICENSE πŸ“œ

Expand Down

0 comments on commit f43e610

Please sign in to comment.