Skip to content

Commit a278bf0

Browse files
Paul-CornellPaul-Cornell
authored
Platform API ref follow-on updates, part 2 (#407)
1 parent 5815c88 commit a278bf0

33 files changed

+595
-0
lines changed

‎mint.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -518,12 +518,17 @@
518518
"platform/api/sources/overview",
519519
"platform/api/sources/azure-blob-storage",
520520
"platform/api/sources/confluence",
521+
"platform/api/sources/couchbase",
521522
"platform/api/sources/databricks-volumes",
523+
"platform/api/sources/dropbox",
524+
"platform/api/sources/elasticsearch",
522525
"platform/api/sources/google-cloud",
526+
"platform/api/sources/google-drive",
523527
"platform/api/sources/mongodb",
524528
"platform/api/sources/onedrive",
525529
"platform/api/sources/outlook",
526530
"platform/api/sources/s3",
531+
"platform/api/sources/salesforce",
527532
"platform/api/sources/sharepoint"
528533
]
529534
},
@@ -533,6 +538,7 @@
533538
"platform/api/destinations/overview",
534539
"platform/api/destinations/astradb",
535540
"platform/api/destinations/azure-ai-search",
541+
"platform/api/destinations/couchbase",
536542
"platform/api/destinations/databricks-volumes",
537543
"platform/api/destinations/delta-table",
538544
"platform/api/destinations/elasticsearch",
@@ -541,6 +547,8 @@
541547
"platform/api/destinations/mongodb",
542548
"platform/api/destinations/onedrive",
543549
"platform/api/destinations/pinecone",
550+
"platform/api/destinations/postgresql",
551+
"platform/api/destinations/qdrant",
544552
"platform/api/destinations/s3",
545553
"platform/api/destinations/weaviate"
546554
]

‎platform/api/destinations/couchbase.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Couchbase
3+
---
4+
5+
Send processed data from Unstructured to Couchbase.
6+
7+
The requirements are as follows.
8+
9+
import CouchbasePrerequisites from '/snippets/general-shared-text/couchbase.mdx';
10+
11+
<CouchbasePrerequisites />
12+
13+
To create or change a Couchbase destination connector, see the following examples.
14+
15+
import CouchbaseAPIRESTCreate from '/snippets/destination_connectors/couchbase_rest_create.mdx';
16+
import CouchbaseAPIRESTChange from '/snippets/destination_connectors/couchbase_rest_change.mdx';
17+
18+
<CodeGroup>
19+
<CouchbaseAPIRESTCreate />
20+
<CouchbaseAPIRESTChange />
21+
</CodeGroup>
22+
23+
Replace the preceding placeholders as follows:
24+
25+
import CouchbaseAPIPlaceholders from '/snippets/general-shared-text/couchbase-api-placeholders.mdx';
26+
27+
<CouchbaseAPIPlaceholders />
28+
29+
To change a connector, replace `<connector-id>` with the source connector's unique ID.
30+
To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors).

‎platform/api/destinations/overview.mdx‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,7 @@ For the list of specific settings, see:
1515

1616
- [Astra DB](/platform/api/destinations/astradb) (`destination_type=astradb`)
1717
- [Azure AI Search](/platform/api/destinations/azure-ai-search) (`destination_type=azure_ai_search`)
18+
- [Couchbase](/platform/api/destinations/couchbase) (`destination_type=couchbase`)
1819
- [Databricks Volumes](/platform/api/destinations/databricks-volumes) (`destination_type=databricks_volumes`)
1920
- [Delta Table](/platform/api/destinations/delta-table) (`destination_type=delta_table`)
2021
- [Elasticsearch](/platform/api/destinations/elasticsearch) (`destination_type=elasticsearch`)
@@ -23,6 +24,8 @@ For the list of specific settings, see:
2324
- [MongoDB](/platform/api/destinations/mongodb) (`destination_type=mongodb`)
2425
- [OneDrive](/platform/api/destinations/onedrive) (`destination_type=onedrive`)
2526
- [Pinecone](/platform/api/destinations/pinecone) (`destination_type=pinecone`)
27+
- [PostgreSQL](/platform/api/destinations/postgresql) (`destination_type=postgres`)
28+
- [Qdrant](/platform/api/destinations/qdrant) (`destination_type=qdrant`)
2629
- [S3](/platform/api/destinations/s3) (`destination_type=s3`)
2730
- [Weaviate](/platform/api/destinations/weaviate) (`destination_type=weaviate`)
2831

‎platform/api/destinations/postgresql.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: PostgreSQL
3+
---
4+
5+
Send processed data from Unstructured to PostgreSQL.
6+
7+
The requirements are as follows.
8+
9+
import PostgreSQLPrerequisites from '/snippets/general-shared-text/postgresql.mdx';
10+
11+
<PostgreSQLPrerequisites />
12+
13+
To create or change a PostgreSQL destination connector, see the following examples.
14+
15+
import PostgreSQLAPIRESTCreate from '/snippets/destination_connectors/postgresql_rest_create.mdx';
16+
import PostgreSQLAPIRESTChange from '/snippets/destination_connectors/postgresql_rest_change.mdx';
17+
18+
<CodeGroup>
19+
<PostgreSQLAPIRESTCreate />
20+
<PostgreSQLAPIRESTChange />
21+
</CodeGroup>
22+
23+
Replace the preceding placeholders as follows:
24+
25+
import PostgreSQLAPIPlaceholders from '/snippets/general-shared-text/postgresql-api-placeholders.mdx';
26+
27+
<PostgreSQLAPIPlaceholders />
28+
29+
To change a connector, replace `<connector-id>` with the source connector's unique ID.
30+
To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors).

‎platform/api/destinations/qdrant.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Qdrant
3+
---
4+
5+
Send processed data from Unstructured to Qdrant.
6+
7+
The requirements are as follows.
8+
9+
import QdrantPrerequisites from '/snippets/general-shared-text/qdrant.mdx';
10+
11+
<QdrantPrerequisites />
12+
13+
To create or change a Qdrant destination connector, see the following examples.
14+
15+
import QdrantAPIRESTCreate from '/snippets/destination_connectors/qdrant_rest_create.mdx';
16+
import QdrantAPIRESTChange from '/snippets/destination_connectors/qdrant_rest_change.mdx';
17+
18+
<CodeGroup>
19+
<QdrantAPIRESTCreate />
20+
<QdrantAPIRESTChange />
21+
</CodeGroup>
22+
23+
Replace the preceding placeholders as follows:
24+
25+
import QdrantAPIPlaceholders from '/snippets/general-shared-text/qdrant-api-placeholders.mdx';
26+
27+
<QdrantAPIPlaceholders />
28+
29+
To change a connector, replace `<connector-id>` with the source connector's unique ID.
30+
To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors).

‎platform/api/sources/couchbase.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Couchbase
3+
---
4+
5+
Ingest your files into Unstructured from Couchbase.
6+
7+
The requirements are as follows.
8+
9+
import CouchbasePrerequisites from '/snippets/general-shared-text/couchbase.mdx';
10+
11+
<CouchbasePrerequisites />
12+
13+
To create or change a Couchbase source connector, see the following examples.
14+
15+
import CouchbaseAPIRESTCreate from '/snippets/source_connectors/couchbase_rest_create.mdx';
16+
import CouchbaseAPIRESTChange from '/snippets/source_connectors/couchbase_rest_change.mdx';
17+
18+
<CodeGroup>
19+
<CouchbaseAPIRESTCreate />
20+
<CouchbaseAPIRESTChange />
21+
</CodeGroup>
22+
23+
Replace the preceding placeholders as follows:
24+
25+
import CouchbaseAPIPlaceholders from '/snippets/general-shared-text/couchbase-api-placeholders.mdx';
26+
27+
<CouchbaseAPIPlaceholders />
28+
29+
To change a connector, replace `<connector-id>` with the source connector's unique ID.
30+
To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors).

‎platform/api/sources/dropbox.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Dropbox
3+
---
4+
5+
Ingest your files into Unstructured from Dropbox.
6+
7+
The requirements are as follows.
8+
9+
import DropboxPrerequisites from '/snippets/general-shared-text/dropbox.mdx';
10+
11+
<DropboxPrerequisites />
12+
13+
To create or change a Dropbox source connector, see the following examples.
14+
15+
import DropboxAPIRESTCreate from '/snippets/source_connectors/dropbox_rest_create.mdx';
16+
import DropboxAPIRESTChange from '/snippets/source_connectors/dropbox_rest_change.mdx';
17+
18+
<CodeGroup>
19+
<DropboxAPIRESTCreate />
20+
<DropboxAPIRESTChange />
21+
</CodeGroup>
22+
23+
Replace the preceding placeholders as follows:
24+
25+
import DropboxAPIPlaceholders from '/snippets/general-shared-text/dropbox-api-placeholders.mdx';
26+
27+
<DropboxAPIPlaceholders />
28+
29+
To change a connector, replace `<connector-id>` with the source connector's unique ID.
30+
To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors).

‎platform/api/sources/elasticsearch.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Elasticsearch
3+
---
4+
5+
Ingest your files into Unstructured from Elasticsearch.
6+
7+
The requirements are as follows.
8+
9+
import ElasticsearchPrerequisites from '/snippets/general-shared-text/elasticsearch.mdx';
10+
11+
<ElasticsearchPrerequisites />
12+
13+
To create or change a Elasticsearch source connector, see the following examples.
14+
15+
import ElasticsearchAPIRESTCreate from '/snippets/source_connectors/elasticsearch_rest_create.mdx';
16+
import ElasticsearchAPIRESTChange from '/snippets/source_connectors/elasticsearch_rest_change.mdx';
17+
18+
<CodeGroup>
19+
<ElasticsearchAPIRESTCreate />
20+
<ElasticsearchAPIRESTChange />
21+
</CodeGroup>
22+
23+
Replace the preceding placeholders as follows:
24+
25+
import ElasticsearchAPIPlaceholders from '/snippets/general-shared-text/elasticsearch-api-placeholders.mdx';
26+
27+
<ElasticsearchAPIPlaceholders />
28+
29+
To change a connector, replace `<connector-id>` with the source connector's unique ID.
30+
To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors).

‎platform/api/sources/google-drive.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Google Drive
3+
---
4+
5+
Ingest your files into Unstructured from Google Drive.
6+
7+
The requirements are as follows.
8+
9+
import GoogleDrivePrerequisites from '/snippets/general-shared-text/google-drive.mdx';
10+
11+
<GoogleDrivePrerequisites />
12+
13+
To create or change a Google Drive source connector, see the following examples.
14+
15+
import GoogleDriveAPIRESTCreate from '/snippets/source_connectors/google_drive_rest_create.mdx';
16+
import GoogleDriveAPIRESTChange from '/snippets/source_connectors/google_drive_rest_change.mdx';
17+
18+
<CodeGroup>
19+
<GoogleDriveAPIRESTCreate />
20+
<GoogleDriveAPIRESTChange />
21+
</CodeGroup>
22+
23+
Replace the preceding placeholders as follows:
24+
25+
import GoogleDriveAPIPlaceholders from '/snippets/general-shared-text/google-drive-api-placeholders.mdx';
26+
27+
<GoogleDriveAPIPlaceholders />
28+
29+
To change a connector, replace `<connector-id>` with the source connector's unique ID.
30+
To get this ID, see [List source connectors](/platform/api/overview#list-source-connectors).

‎platform/api/sources/overview.mdx‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,17 @@ To create a source connector, you must also provide a request body that contains
1414
For the list of specific settings, see:
1515

1616
- [Azure](/platform/api/sources/azure-blob-storage) (`source_type=azure`)
17+
- [Couchbase](/platform/api/sources/couchbase) (`source_type=couchbase`)
1718
- [Confluence](/platform/api/sources/confluence) (`source_type=confluence`)
1819
- [Databricks Volumes](/platform/api/sources/databricks-volumes) (`source_type=databricks_volumes`)
20+
- [Dropbox](/platform/api/sources/dropbox) (`source_type=dropbox`)
21+
- [Elasticsearch](/platform/api/sources/elasticsearch) (`source_type=elasticsearch`)
1922
- [Google Cloud Storage](/platform/api/sources/google-cloud) (`source_type=gcs`)
23+
- [Google Drive](/platform/api/sources/google-drive) (`source_type=google_drive`)
2024
- [MongoDB](/platform/api/sources/mongodb) (`source_type=mongodb`)
2125
- [OneDrive](/platform/api/sources/onedrive) (`source_type=onedrive`)
2226
- [Outlook](/platform/api/sources/outlook) (`source_type=outlook`)
2327
- [S3](/platform/api/sources/s3) (`source_type=s3`)
28+
- [Salesforce](/platform/api/sources/salesforce) (`source_type=salesforce`)
2429
- [SharePoint](/platform/api/sources/sharepoint) (`source_type=sharepoint`)
2530

0 commit comments

Comments
 (0)