diff --git a/snippets/general-shared-text/weaviate-api-placeholders.mdx b/snippets/general-shared-text/weaviate-api-placeholders.mdx index 6646c5d6..63ecaefc 100644 --- a/snippets/general-shared-text/weaviate-api-placeholders.mdx +++ b/snippets/general-shared-text/weaviate-api-placeholders.mdx @@ -1,4 +1,5 @@ - `` (_required_) - A unique name for this connector. - `` (_required_) - The URL of the Weaviate database cluster. -- `` (_required_) - The name of the target collection within the cluster. +- `` - The name of the target collection within the cluster. If no value is provided, see the beginning of this article + for the behavior at run time. - `` (_required_) - The API key provided by Weaviate to access the cluster. \ No newline at end of file diff --git a/snippets/general-shared-text/weaviate-cli-api.mdx b/snippets/general-shared-text/weaviate-cli-api.mdx index 19121429..46e413e0 100644 --- a/snippets/general-shared-text/weaviate-cli-api.mdx +++ b/snippets/general-shared-text/weaviate-cli-api.mdx @@ -14,7 +14,8 @@ The following environment variables: - For Embedded Weaviate: - `WEAVIATE_HOST` - The connection URL to the instance, represented by `--hostname` (CLI) or `hostname` (Python). - - `WEAVIATE_COLLECTION` - The name of the target collection in the instance, represented by `--collection` (CLI) or `collection` (Python). + - `WEAVIATE_COLLECTION` - The name of the target collection in the instance, represented by `--collection` (CLI) or `collection` (Python). + If no value is provided, see the beginning of this article for the behavior at run time. - For Weaviate Cloud: @@ -23,4 +24,5 @@ The following environment variables: For the CLI, the `--api-key` option here is part of the `weaviate-cloud` command. For Python, the `api_key` parameter here is part of the `CloudWeaviateAccessConfig` object. - - `WEAVIATE_COLLECTION` - The name of the target collection in the database, represented by `--collection` (CLI) or `collection` (Python). \ No newline at end of file + - `WEAVIATE_COLLECTION` - The name of the target collection in the database, represented by `--collection` (CLI) or `collection` (Python). + If no value is provided, see the beginning of this article for the behavior at run time. \ No newline at end of file diff --git a/snippets/general-shared-text/weaviate-platform.mdx b/snippets/general-shared-text/weaviate-platform.mdx index d0bf5fb2..4137365b 100644 --- a/snippets/general-shared-text/weaviate-platform.mdx +++ b/snippets/general-shared-text/weaviate-platform.mdx @@ -2,5 +2,6 @@ Fill in the following fields: - **Name** (_required_): A unique name for the connector. - **Cluster URL** (_required_): The URL of the Weaviate database cluster. -- **Collection Name** (_required_): The name of the target collection within the cluster. +- **Collection Name**: The name of the target collection within the cluster. If no value is provided, see the beginning of this article + for the behavior at run time. - **API Key** (_required_): The API key provided by Weaviate to access the cluster. \ No newline at end of file diff --git a/snippets/general-shared-text/weaviate.mdx b/snippets/general-shared-text/weaviate.mdx index ab6e4e67..6783fe68 100644 --- a/snippets/general-shared-text/weaviate.mdx +++ b/snippets/general-shared-text/weaviate.mdx @@ -19,9 +19,47 @@ - A Weaviate database instance. The following information assumes that you have a Weaviate Cloud (WCD) account with a Weaviate database cluster in that account. [Create a WCD account](https://weaviate.io/developers/wcs/quickstart#create-a-wcd-account). [Create a database cluster](https://weaviate.io/developers/wcs/quickstart#create-a-weaviate-cluster). For other database options, [learn more](https://weaviate.io/developers/weaviate/installation). - The URL and API key for the database cluster. [Get the URL and API key](https://weaviate.io/developers/wcs/quickstart#explore-the-details-panel). - - The name of the target collection in the database. [Create a collection](https://weaviate.io/developers/wcs/tools/collections-tool). + - The name of the target collection in the database. [Create a collection](https://weaviate.io/developers/wcs/tools/collections-tool). + + An existing collection is not required. At runtime, the collection behavior is as follows: -Weaviate requires the collection to have a data schema before you add data. At minimum, this schema must contain the `record_id` property, as follows: + For the [Unstructured Platform](/platform/overview): + + - If an existing collection name is specified, and Unstructured generates embeddings, + but the number of dimensions that are generated does not match the existing collection's embedding settings, the run will fail. + You must change your Unstructured embedding settings or your existing collection's embedding settings to match, and try the run again. + - If a collection name is not specified, Unstructured creates a new collection in your Weaviate cluster. If Unstructured generates embeddings, + the new collection's name will be `U__`. + If Unstructured does not generate embeddings, the new collection's name will be `U` with + the name of the new collection, and replace `` with the name of each additional available property that + you want to return results for, such as `text`, `type`, `element_id`, `record_id`, and so on. The embeddings will be + returned in the `vector` property. + + ```text + { + Get { + { + _additional { + vector + } + + + } + } + } + ``` + +Weaviate requires an existing collection to have a data schema before you add data. At minimum, this schema must contain the `record_id` property, as follows: ```json {