diff --git a/snippets/general-shared-text/astradb-platform.mdx b/snippets/general-shared-text/astradb-platform.mdx index 8a539fb3..2221ae9c 100644 --- a/snippets/general-shared-text/astradb-platform.mdx +++ b/snippets/general-shared-text/astradb-platform.mdx @@ -1,6 +1,8 @@ Fill in the following fields: - **Name** (_required_): A unique name for this connector. -- **Token** (_required_): The application token for the database. +- **Collection Name** (_required_): The name of the collection in the namespace. +- **Keyspace** (_required_): The name of the keyspace in the collection. +- **Batch Size**: The maximum number of records per batch. The default is `20` if not otherwise specified. - **API Endpoint** (_required_): The database's associated API endpoint. -- **Collection Name** (_required_): The name of the collection in the namespace. \ No newline at end of file +- **Token** (_required_): The application token for the database. diff --git a/snippets/general-shared-text/azure-ai-search-platform.mdx b/snippets/general-shared-text/azure-ai-search-platform.mdx index 2f5404c2..d017ab16 100644 --- a/snippets/general-shared-text/azure-ai-search-platform.mdx +++ b/snippets/general-shared-text/azure-ai-search-platform.mdx @@ -2,5 +2,5 @@ Fill in the following fields: - **Name** (_required_): A unique name for this connector. - **Endpoint** (_required_): The endpoint URL for Azure AI Search. +- **Index Name** (_required_): The name of the index for Azure AI Search. - **API Key** (_required_): The API key for Azure AI Search. -- **Index Name** (_required_): The name of the index for Azure AI Search. \ No newline at end of file diff --git a/snippets/general-shared-text/azure-platform.mdx b/snippets/general-shared-text/azure-platform.mdx index 4843da59..4f8b8e86 100644 --- a/snippets/general-shared-text/azure-platform.mdx +++ b/snippets/general-shared-text/azure-platform.mdx @@ -1,13 +1,13 @@ Fill in the following fields: - **Name** (_required_): A unique name for this connector. +- **Recursive**: Check this box to recursively access files from subfolders within the container. - **Remote URL** (_required_): The Azure Storage remote URL, with the format `az:///` For example, if your container is named `my-container`, and there is a folder in the container named `my-folder`, the Azure Storage remote URL would be `az://my-container/my-folder/`. -- **Azure Account Name**: The Azure Storage account name. -- **Azure Account Key**: The key for the Azure Storage account, or... -- **Azure Connection String**: The connection string for the Azure Storage account, or... -- **SAS Token**: The SAS token for the Azure Storage account. -- **Recursive**: Check this box to recursively access files from subfolders within the container. \ No newline at end of file +- **Account Name**: For SAS token authentication and account key authentication, the Azure Storage account name. +- **SAS Token**: For SAS token authentication, the SAS token for the Azure Storage account. +- **Account Key**: For account key authentication, the key for the Azure Storage account. +- **Connection String**: For connection string authentication, the connection string for the Azure Storage account. diff --git a/snippets/general-shared-text/databricks-volumes-platform.mdx b/snippets/general-shared-text/databricks-volumes-platform.mdx index b6b44fa7..a3d7e603 100644 --- a/snippets/general-shared-text/databricks-volumes-platform.mdx +++ b/snippets/general-shared-text/databricks-volumes-platform.mdx @@ -6,8 +6,8 @@ Fill in the following fields: - **Schema** : The name of the associated schema. If not specified, **default** is used. - **Volume** (_required_): The name of the associated volume. - **Volume Path** : Any optional path to access within the volume. -- **Client ID** (_required_): The application ID value for the Databricks-managed service principal that has access to the volume. - **Client Secret** (_required_): The associated OAuth secret value for the Databricks-managed service principal that has access to the volume. +- **Client ID** (_required_): The application ID value for the Databricks-managed service principal that has access to the volume. To learn how to create a Databricks-managed service principal, get its application ID, and generate an associated OAuth secret, see the documentation for diff --git a/snippets/general-shared-text/gcs-platform.mdx b/snippets/general-shared-text/gcs-platform.mdx index 020d4e39..9a133f02 100644 --- a/snippets/general-shared-text/gcs-platform.mdx +++ b/snippets/general-shared-text/gcs-platform.mdx @@ -2,5 +2,5 @@ Fill in the following fields: - **Name** (_required_): A unique name for this connector. - **Bucket URI** (_required_): The URI for the Google Cloud Storage bucket and any target folder path within the bucket. This URI takes the format `gs://[/folder-name]`. +- **Recursive** (source connector only): Check this box to ingest data recursively from any subfolders, starting from the path specified by **Bucket URI**. - **Service Account Key** (_required_): The contents of a service account key file, expressed as a single string without line breaks, for a Google Cloud service account that has the required access permissions to the bucket. -- **Recursive**: Check this box to ingest data recursively from any subfolders, starting from the path specified by **Bucket URI**. \ No newline at end of file diff --git a/snippets/general-shared-text/milvus-platform.mdx b/snippets/general-shared-text/milvus-platform.mdx index e219a15a..d95f1aeb 100644 --- a/snippets/general-shared-text/milvus-platform.mdx +++ b/snippets/general-shared-text/milvus-platform.mdx @@ -1,8 +1,8 @@ Fill in the following fields: - **Name** (_required_): A unique name for this connector. +- **URI** (_required_): The URI of the Milvus instance, for example: `https://12345.serverless.gcp-us-west1.cloud.zilliz.com`. +- **DB Name** (_required_): The name of the database in the instance. +- **Collection Name** (_required_): The name of the collection in the database. - **Username** (_required_): The username to access the Milvus instance. -- **Password** (_required_): The password corresponding to the username to access the instance. -- **Uri** (_required_): The URI of the instance, for example: `https://12345.serverless.gcp-us-west1.cloud.zilliz.com`. -- **Database Name** (_required_): The name of the database in the instance. -- **Collection Name** (_required_): The name of the collection in the database. \ No newline at end of file +- **Password** (_required_): The password corresponding to the username to access the instance. \ No newline at end of file diff --git a/snippets/general-shared-text/pinecone-platform.mdx b/snippets/general-shared-text/pinecone-platform.mdx index 7fb3329b..2a7852de 100644 --- a/snippets/general-shared-text/pinecone-platform.mdx +++ b/snippets/general-shared-text/pinecone-platform.mdx @@ -2,6 +2,5 @@ Fill in the following fields: - **Name** (_required_): A unique name for this connector. - **Index Name** (_required_): The name of the index in the Pinecone database. -- **Environment** (_required_): The name of the Pinecone environment for the index instance. -- **Batch Size** (_required_): The number of records to use in a single batch. +- **Batch Size**: The number of records to use in a single batch. The default is `50` if not otherwise specified. - **API Key** (_required_): The Pinecone API key. \ No newline at end of file diff --git a/snippets/general-shared-text/s3-platform.mdx b/snippets/general-shared-text/s3-platform.mdx index 263f7acd..33461791 100644 --- a/snippets/general-shared-text/s3-platform.mdx +++ b/snippets/general-shared-text/s3-platform.mdx @@ -1,10 +1,9 @@ Fill in the following fields: - **Name** (_required_): A unique name for this connector. -- **Bucket Name** (_required_): The path to the bucket or folder, formatted as `s3://my-bucket/` (if the files are in the bucket's root) or `s3://my-bucket/my-folder/`. -- **AWS Access Key**: The AWS access key ID for the authenticated AWS IAM user, if the bucket has authenticated access enabled. -- **AWS Secret Key**: The AWS secret access key corresponding to the preceding AWS access key ID, if the bucket has authenticated access enabled -- **Token**: If required, the AWS STS session token for temporary access. -- **Endpoint URL**: A custom URL, if connecting to a non-AWS S3 bucket. -- **Recursive**: Check this box to access subfolders within the bucket. -- **Connect Anonymously** (_source connectors only_): Check this box if reading from a bucket with anonymous access enabled. \ No newline at end of file +- **Bucket URI** (_required_): The URI for the bucket or folder, formatted as `s3://my-bucket/` (if the files are in the bucket's root) or `s3://my-bucket/my-folder/`. +- **Recursive** (source connector only): Check this box to access subfolders within the bucket. +- **AWS Key**: For secret authentication, the AWS access key ID for the authenticated AWS IAM user. +- **AWS Secret Key**: For secret authentication, the AWS secret access key corresponding to the preceding AWS access key ID. +- **Token**: For token authentication, the AWS STS session token for temporary access. +- **Custom URL**: A custom URL, if connecting to a non-AWS S3 bucket. \ No newline at end of file diff --git a/snippets/general-shared-text/sharepoint-platform.mdx b/snippets/general-shared-text/sharepoint-platform.mdx index 502a963f..db06e506 100644 --- a/snippets/general-shared-text/sharepoint-platform.mdx +++ b/snippets/general-shared-text/sharepoint-platform.mdx @@ -1,9 +1,8 @@ Fill in the following fields: - **Name** (_required_): A unique name for this connector. -- **Client ID** (_required_): The client ID provided by SharePoint for the app registration. -- **Client Credential** (_required_): The client secret associated with the client ID. - **Site URL** (_required_): The base URL of the SharePoint site to connect to. - **Path** (_required_): The path from which to start parsing files, for example `Shared Documents`. -- **Recursive**: Check this box to recursively process data from subfolders within the specified path. -- **Files Only**: Check this box to disregard the folder structure. \ No newline at end of file +- **Recursive** (source connector only): Check this box to recursively process data from subfolders within the specified path. +- **Client ID** (_required_): The client ID provided by SharePoint for the app registration. +- **Client Credentials** (_required_): The client secret associated with the client ID. \ 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 fb0d792f..d0bf5fb2 100644 --- a/snippets/general-shared-text/weaviate-platform.mdx +++ b/snippets/general-shared-text/weaviate-platform.mdx @@ -1,7 +1,6 @@ Fill in the following fields: - **Name** (_required_): A unique name for the connector. -- **Host URL** (_required_): The URL of the Weaviate database cluster. +- **Cluster URL** (_required_): The URL of the Weaviate database cluster. - **Collection Name** (_required_): The name of the target collection within the cluster. -- **Batch Size**: The maximum number of records to be transmitted in a single batch. - **API Key** (_required_): The API key provided by Weaviate to access the cluster. \ No newline at end of file