Skip to content

Commit 4498354

Browse files
authored
Platform: Sync names and orders of all fields with UI (#374)
1 parent d80baa2 commit 4498354

File tree

10 files changed

+27
-29
lines changed

10 files changed

+27
-29
lines changed
Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
Fill in the following fields:
22

33
- **Name** (_required_): A unique name for this connector.
4-
- **Token** (_required_): The application token for the database.
4+
- **Collection Name** (_required_): The name of the collection in the namespace.
5+
- **Keyspace** (_required_): The name of the keyspace in the collection.
6+
- **Batch Size**: The maximum number of records per batch. The default is `20` if not otherwise specified.
57
- **API Endpoint** (_required_): The database's associated API endpoint.
6-
- **Collection Name** (_required_): The name of the collection in the namespace.
8+
- **Token** (_required_): The application token for the database.

snippets/general-shared-text/azure-ai-search-platform.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ Fill in the following fields:
22

33
- **Name** (_required_): A unique name for this connector.
44
- **Endpoint** (_required_): The endpoint URL for Azure AI Search.
5+
- **Index Name** (_required_): The name of the index for Azure AI Search.
56
- **API Key** (_required_): The API key for Azure AI Search.
6-
- **Index Name** (_required_): The name of the index for Azure AI Search.
Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
Fill in the following fields:
22

33
- **Name** (_required_): A unique name for this connector.
4+
- **Recursive**: Check this box to recursively access files from subfolders within the container.
45
- **Remote URL** (_required_): The Azure Storage remote URL, with the format `az://<container-name>/<path/to/file/or/folder/in/container/as/needed>`
56

67
For example, if your container is named `my-container`, and there is a folder in the container named `my-folder`, the
78
Azure Storage remote URL would be `az://my-container/my-folder/`.
89

9-
- **Azure Account Name**: The Azure Storage account name.
10-
- **Azure Account Key**: The key for the Azure Storage account, or...
11-
- **Azure Connection String**: The connection string for the Azure Storage account, or...
12-
- **SAS Token**: The SAS token for the Azure Storage account.
13-
- **Recursive**: Check this box to recursively access files from subfolders within the container.
10+
- **Account Name**: For SAS token authentication and account key authentication, the Azure Storage account name.
11+
- **SAS Token**: For SAS token authentication, the SAS token for the Azure Storage account.
12+
- **Account Key**: For account key authentication, the key for the Azure Storage account.
13+
- **Connection String**: For connection string authentication, the connection string for the Azure Storage account.

snippets/general-shared-text/databricks-volumes-platform.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ Fill in the following fields:
66
- **Schema** : The name of the associated schema. If not specified, **default** is used.
77
- **Volume** (_required_): The name of the associated volume.
88
- **Volume Path** : Any optional path to access within the volume.
9-
- **Client ID** (_required_): The application ID value for the Databricks-managed service principal that has access to the volume.
109
- **Client Secret** (_required_): The associated OAuth secret value for the Databricks-managed service principal that has access to the volume.
10+
- **Client ID** (_required_): The application ID value for the Databricks-managed service principal that has access to the volume.
1111

1212
To learn how to create a Databricks-managed service principal, get its application ID, and generate an associated OAuth secret,
1313
see the documentation for

snippets/general-shared-text/gcs-platform.mdx

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,5 @@ Fill in the following fields:
22

33
- **Name** (_required_): A unique name for this connector.
44
- **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://<bucket-name>[/folder-name]`.
5+
- **Recursive** (source connector only): Check this box to ingest data recursively from any subfolders, starting from the path specified by **Bucket URI**.
56
- **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.
6-
- **Recursive**: Check this box to ingest data recursively from any subfolders, starting from the path specified by **Bucket URI**.
Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
Fill in the following fields:
22

33
- **Name** (_required_): A unique name for this connector.
4+
- **URI** (_required_): The URI of the Milvus instance, for example: `https://12345.serverless.gcp-us-west1.cloud.zilliz.com`.
5+
- **DB Name** (_required_): The name of the database in the instance.
6+
- **Collection Name** (_required_): The name of the collection in the database.
47
- **Username** (_required_): The username to access the Milvus instance.
5-
- **Password** (_required_): The password corresponding to the username to access the instance.
6-
- **Uri** (_required_): The URI of the instance, for example: `https://12345.serverless.gcp-us-west1.cloud.zilliz.com`.
7-
- **Database Name** (_required_): The name of the database in the instance.
8-
- **Collection Name** (_required_): The name of the collection in the database.
8+
- **Password** (_required_): The password corresponding to the username to access the instance.

snippets/general-shared-text/pinecone-platform.mdx

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,5 @@ Fill in the following fields:
22

33
- **Name** (_required_): A unique name for this connector.
44
- **Index Name** (_required_): The name of the index in the Pinecone database.
5-
- **Environment** (_required_): The name of the Pinecone environment for the index instance.
6-
- **Batch Size** (_required_): The number of records to use in a single batch.
5+
- **Batch Size**: The number of records to use in a single batch. The default is `50` if not otherwise specified.
76
- **API Key** (_required_): The Pinecone API key.
Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,9 @@
11
Fill in the following fields:
22

33
- **Name** (_required_): A unique name for this connector.
4-
- **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/`.
5-
- **AWS Access Key**: The AWS access key ID for the authenticated AWS IAM user, if the bucket has authenticated access enabled.
6-
- **AWS Secret Key**: The AWS secret access key corresponding to the preceding AWS access key ID, if the bucket has authenticated access enabled
7-
- **Token**: If required, the AWS STS session token for temporary access.
8-
- **Endpoint URL**: A custom URL, if connecting to a non-AWS S3 bucket.
9-
- **Recursive**: Check this box to access subfolders within the bucket.
10-
- **Connect Anonymously** (_source connectors only_): Check this box if reading from a bucket with anonymous access enabled.
4+
- **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/`.
5+
- **Recursive** (source connector only): Check this box to access subfolders within the bucket.
6+
- **AWS Key**: For secret authentication, the AWS access key ID for the authenticated AWS IAM user.
7+
- **AWS Secret Key**: For secret authentication, the AWS secret access key corresponding to the preceding AWS access key ID.
8+
- **Token**: For token authentication, the AWS STS session token for temporary access.
9+
- **Custom URL**: A custom URL, if connecting to a non-AWS S3 bucket.
Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
Fill in the following fields:
22

33
- **Name** (_required_): A unique name for this connector.
4-
- **Client ID** (_required_): The client ID provided by SharePoint for the app registration.
5-
- **Client Credential** (_required_): The client secret associated with the client ID.
64
- **Site URL** (_required_): The base URL of the SharePoint site to connect to.
75
- **Path** (_required_): The path from which to start parsing files, for example `Shared Documents`.
8-
- **Recursive**: Check this box to recursively process data from subfolders within the specified path.
9-
- **Files Only**: Check this box to disregard the folder structure.
6+
- **Recursive** (source connector only): Check this box to recursively process data from subfolders within the specified path.
7+
- **Client ID** (_required_): The client ID provided by SharePoint for the app registration.
8+
- **Client Credentials** (_required_): The client secret associated with the client ID.
Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,6 @@
11
Fill in the following fields:
22

33
- **Name** (_required_): A unique name for the connector.
4-
- **Host URL** (_required_): The URL of the Weaviate database cluster.
4+
- **Cluster URL** (_required_): The URL of the Weaviate database cluster.
55
- **Collection Name** (_required_): The name of the target collection within the cluster.
6-
- **Batch Size**: The maximum number of records to be transmitted in a single batch.
76
- **API Key** (_required_): The API key provided by Weaviate to access the cluster.

0 commit comments

Comments
 (0)