Skip to content

Commit

Permalink
Various source/destination connectors: added how-to video links (#245)
Browse files Browse the repository at this point in the history
  • Loading branch information
Paul-Cornell authored Sep 20, 2024
1 parent f6be9f4 commit 00db30f
Show file tree
Hide file tree
Showing 6 changed files with 93 additions and 3 deletions.
13 changes: 11 additions & 2 deletions snippets/general-shared-text/azure-cognitive-search.mdx
Original file line number Diff line number Diff line change
@@ -1,9 +1,18 @@
The Azure AI Search (formerly Azure Cognitive Search) prerequisites:

- The endpoint for Azure AI Search. [Get a search service endpoint](https://learn.microsoft.com/azure/search/search-get-started-vector#get-a-search-service-endpoint).
- The API key for Azure AI Search. [Get an admin API key](https://learn.microsoft.com/azure/search/search-get-started-vector#option-1-use-keys).
- The endpoint and API key for Azure AI Search. [Create an endpoint and API key](https://learn.microsoft.com/azure/search/search-create-service-portal).
- The name of the index in Azure AI Search. [Create an index](https://learn.microsoft.com/rest/api/searchservice/create-index).

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/WY8h8Gtyo7o"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>

The Azure AI Search index that you use must have an index schema that is compatible with the schema of the documents
that Unstructured produces for you. Unstructured cannot provide a schema that is guaranteed to work in all
circumstances. This is because these schemas will vary based on your source files' types; how you
Expand Down
13 changes: 13 additions & 0 deletions snippets/general-shared-text/chroma.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
The Chroma prerequisites:

- A Chroma server. See [Deployment](https://docs.trychroma.com/deployment).

For example, here is a video about how to deploy a Chroma server to AWS:

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/4ApW6ZwqW20"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>

- The Chroma server's hostname or IP address, and the server's port number.
- If you are not connecting to the server through HTTP, the path to the server instance.
- The name of the tenant that you want to access on the server.
Expand Down
10 changes: 10 additions & 0 deletions snippets/general-shared-text/mongodb.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,16 @@ The MongoDB prerequisites for a MongoDB Atlas deployment:

- A MongoDB Atlas cluster. [Create a cluster](https://www.mongodb.com/docs/atlas/tutorial/deploy-free-tier-cluster).

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/VkXvVOb99g0"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>

- The cluster must be reachable from your application environment. [Learn how](https://www.mongodb.com/docs/atlas/setup-cluster-security/#network-and-firewall-requirements).

- The cluster must be configured to use your IP address. [Learn how](https://www.mongodb.com/docs/atlas/setup-cluster-security/#ip-access-list).
Expand Down
11 changes: 11 additions & 0 deletions snippets/general-shared-text/pinecone.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
The Pinecone prerequisites:

- A Pinecone account. [Get an account](https://app.pinecone.io/).

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/uPoa7PLcuZ4"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>

- A Pinecone API key. [Get an API key](https://docs.pinecone.io/guides/get-started/authentication#find-your-pinecone-api-key).
- A Pinecone serverless index. [Create a serverless index](https://docs.pinecone.io/guides/indexes/create-an-index).
36 changes: 35 additions & 1 deletion snippets/general-shared-text/salesforce.mdx
Original file line number Diff line number Diff line change
@@ -1,5 +1,39 @@
The Salesforce prerequisites:

- A Salesforce account. [Create an account](https://www.salesforce.com/form/signup/freetrial-salesforce-starter/?d=pb).
- A Salesforce account. [Create an account](https://developer.salesforce.com/signup).

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/PIVPq2J1OMA"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>

- The Salesforce categories (objects) that you want to access, specified as a comma-separated list. Available categories include `Account`, `Case`, `Campaign`, `EmailMessage`, and `Lead`.
- The OAuth consumer key (client ID) and private key (PEM) for the Salesforce connected app. The PEM is a string that begins with `—–BEGIN RSA PRIVATE KEY—–` and ends with `—–END RSA PRIVATE KEY—–`. [Create a connected app](https://help.salesforce.com/s/articleView?id=sf.connected_app_create.htm&type=5). [Get the consumer key](https://help.salesforce.com/s/articleView?id=sf.connected_app_rotate_consumer_details.htm&type=5). [Get the private key](https://help.salesforce.com/s/articleView?id=sf.task_create_a_certificate_and_private_key.htm&type=5).

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/GcbcMsMV4oY"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/hFV2Ao4aXAY"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>



13 changes: 13 additions & 0 deletions snippets/general-shared-text/sftp.mdx
Original file line number Diff line number Diff line change
@@ -1,6 +1,19 @@
The SFTP prerequisites:

- The SFTP server hostname, port, username, and password.

SFTP servers are offered by several vendors. For example, the following video shows how to create and set up an SFTP server by using AWS Transfer Family:

<iframe
width="560"
height="315"
src="https://www.youtube.com/embed/3_HHSnoFsoM"
title="YouTube video player"
frameborder="0"
allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture"
allowfullscreen
></iframe>

- The directory path to start accessing data from, specified as `sftp://<path>/<to>/<directory>`.

See the [SFTP documentation](https://en.wikipedia.org/wiki/SSH_File_Transfer_Protocol).

0 comments on commit 00db30f

Please sign in to comment.