Skip to content

Commit 4bb4356

Browse files
rbiseck3rbiseck3
authored
feat/kdbai dest connector (#21)
* Start migrating KDBAI PR from legacy repo * Update script names * Add encrypted licence to use with docker compose setup * Flush out CI test script * test kdbai in CI * Add kdbai secrets * Pull docker image from private registry * test kdbai in CI * Add test step * Isolate test step * support csv and json files from stager * Add more logging * fix file extension * embedding -> embeddings * Add back in all e2e tests * bump changelog
1 parent 7af5d11 commit 4bb4356

36 files changed

+667
-5
lines changed

‎.github/workflows/e2e.yml‎

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,7 @@ jobs:
129129
UNS_API_KEY: ${{ secrets.UNS_API_KEY }}
130130
run: |
131131
./test_e2e/src/against-api.sh
132-
132+
133133
134134
135135
test_dest:
@@ -183,6 +183,9 @@ jobs:
183183
DATABRICKS_CATALOG: ${{secrets.DATABRICKS_CATALOG}}
184184
SHAREPOINT_CLIENT_ID: ${{secrets.SHAREPOINT_CLIENT_ID}}
185185
SHAREPOINT_CRED: ${{secrets.SHAREPOINT_CRED}}
186+
KDBAI_BEARER_TOKEN: ${{ secrets.KDBAI_BEARER_TOKEN }}
187+
KDBAI_USERNAME: ${{ secrets.KDBAI_USERNAME }}
188+
KDBAI_CIPHER_KEY: ${{ secrets.KDBAI_CIPHER_KEY }}
186189
TABLE_OCR: "tesseract"
187190
OCR_AGENT: "unstructured.partition.utils.ocr_models.tesseract_ocr.OCRAgentTesseract"
188191
CI: "true"

‎.gitignore‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -206,4 +206,4 @@ metricsdiff.txt
206206
# analysis
207207
annotated/
208208

209-
/tmp_ingest
209+
tmp_ingest/

‎CHANGELOG.md‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
1-
## 0.0.5-dev3
1+
## 0.0.5-dev4
22

33
### Enhancements
44

55
* **Add Couchbase Source Connector** Adds support for reading artifacts from Couchbase DB for processing in unstructured
66
* **Drop environment from pinecone as part of v2 migration** environment is no longer required by the pinecone SDK, so that field has been removed from the ingest CLI/SDK/
7+
* **Add KDBAI Destination Connector** Adds support for writing elements and their embeddings to KDBAI DB.
78

89
### Fixes
910

‎LICENSE.md‎

Lines changed: 201 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,201 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship, whether in Source or
36+
Object form, made available under the License, as indicated by a
37+
copyright notice that is included in or attached to the work
38+
(an example is provided in the Appendix below).
39+
40+
"Derivative Works" shall mean any work, whether in Source or Object
41+
form, that is based on (or derived from) the Work and for which the
42+
editorial revisions, annotations, elaborations, or other modifications
43+
represent, as a whole, an original work of authorship. For the purposes
44+
of this License, Derivative Works shall not include works that remain
45+
separable from, or merely link (or bind by name) to the interfaces of,
46+
the Work and Derivative Works thereof.
47+
48+
"Contribution" shall mean any work of authorship, including
49+
the original version of the Work and any modifications or additions
50+
to that Work or Derivative Works thereof, that is intentionally
51+
submitted to Licensor for inclusion in the Work by the copyright owner
52+
or by an individual or Legal Entity authorized to submit on behalf of
53+
the copyright owner. For the purposes of this definition, "submitted"
54+
means any form of electronic, verbal, or written communication sent
55+
to the Licensor or its representatives, including but not limited to
56+
communication on electronic mailing lists, source code control systems,
57+
and issue tracking systems that are managed by, or on behalf of, the
58+
Licensor for the purpose of discussing and improving the Work, but
59+
excluding communication that is conspicuously marked or otherwise
60+
designated in writing by the copyright owner as "Not a Contribution."
61+
62+
"Contributor" shall mean Licensor and any individual or Legal Entity
63+
on behalf of whom a Contribution has been received by Licensor and
64+
subsequently incorporated within the Work.
65+
66+
2. Grant of Copyright License. Subject to the terms and conditions of
67+
this License, each Contributor hereby grants to You a perpetual,
68+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69+
copyright license to reproduce, prepare Derivative Works of,
70+
publicly display, publicly perform, sublicense, and distribute the
71+
Work and such Derivative Works in Source or Object form.
72+
73+
3. Grant of Patent License. Subject to the terms and conditions of
74+
this License, each Contributor hereby grants to You a perpetual,
75+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76+
(except as stated in this section) patent license to make, have made,
77+
use, offer to sell, sell, import, and otherwise transfer the Work,
78+
where such license applies only to those patent claims licensable
79+
by such Contributor that are necessarily infringed by their
80+
Contribution(s) alone or by combination of their Contribution(s)
81+
with the Work to which such Contribution(s) was submitted. If You
82+
institute patent litigation against any entity (including a
83+
cross-claim or counterclaim in a lawsuit) alleging that the Work
84+
or a Contribution incorporated within the Work constitutes direct
85+
or contributory patent infringement, then any patent licenses
86+
granted to You under this License for that Work shall terminate
87+
as of the date such litigation is filed.
88+
89+
4. Redistribution. You may reproduce and distribute copies of the
90+
Work or Derivative Works thereof in any medium, with or without
91+
modifications, and in Source or Object form, provided that You
92+
meet the following conditions:
93+
94+
(a) You must give any other recipients of the Work or
95+
Derivative Works a copy of this License; and
96+
97+
(b) You must cause any modified files to carry prominent notices
98+
stating that You changed the files; and
99+
100+
(c) You must retain, in the Source form of any Derivative Works
101+
that You distribute, all copyright, patent, trademark, and
102+
attribution notices from the Source form of the Work,
103+
excluding those notices that do not pertain to any part of
104+
the Derivative Works; and
105+
106+
(d) If the Work includes a "NOTICE" text file as part of its
107+
distribution, then any Derivative Works that You distribute must
108+
include a readable copy of the attribution notices contained
109+
within such NOTICE file, excluding those notices that do not
110+
pertain to any part of the Derivative Works, in at least one
111+
of the following places: within a NOTICE text file distributed
112+
as part of the Derivative Works; within the Source form or
113+
documentation, if provided along with the Derivative Works; or,
114+
within a display generated by the Derivative Works, if and
115+
wherever such third-party notices normally appear. The contents
116+
of the NOTICE file are for informational purposes only and
117+
do not modify the License. You may add Your own attribution
118+
notices within Derivative Works that You distribute, alongside
119+
or as an addendum to the NOTICE text from the Work, provided
120+
that such additional attribution notices cannot be construed
121+
as modifying the License.
122+
123+
You may add Your own copyright statement to Your modifications and
124+
may provide additional or different license terms and conditions
125+
for use, reproduction, or distribution of Your modifications, or
126+
for any such Derivative Works as a whole, provided Your use,
127+
reproduction, and distribution of the Work otherwise complies with
128+
the conditions stated in this License.
129+
130+
5. Submission of Contributions. Unless You explicitly state otherwise,
131+
any Contribution intentionally submitted for inclusion in the Work
132+
by You to the Licensor shall be under the terms and conditions of
133+
this License, without any additional terms or conditions.
134+
Notwithstanding the above, nothing herein shall supersede or modify
135+
the terms of any separate license agreement you may have executed
136+
with Licensor regarding such Contributions.
137+
138+
6. Trademarks. This License does not grant permission to use the trade
139+
names, trademarks, service marks, or product names of the Licensor,
140+
except as required for reasonable and customary use in describing the
141+
origin of the Work and reproducing the content of the NOTICE file.
142+
143+
7. Disclaimer of Warranty. Unless required by applicable law or
144+
agreed to in writing, Licensor provides the Work (and each
145+
Contributor provides its Contributions) on an "AS IS" BASIS,
146+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147+
implied, including, without limitation, any warranties or conditions
148+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149+
PARTICULAR PURPOSE. You are solely responsible for determining the
150+
appropriateness of using or redistributing the Work and assume any
151+
risks associated with Your exercise of permissions under this License.
152+
153+
8. Limitation of Liability. In no event and under no legal theory,
154+
whether in tort (including negligence), contract, or otherwise,
155+
unless required by applicable law (such as deliberate and grossly
156+
negligent acts) or agreed to in writing, shall any Contributor be
157+
liable to You for damages, including any direct, indirect, special,
158+
incidental, or consequential damages of any character arising as a
159+
result of this License or out of the use or inability to use the
160+
Work (including but not limited to damages for loss of goodwill,
161+
work stoppage, computer failure or malfunction, or any and all
162+
other commercial damages or losses), even if such Contributor
163+
has been advised of the possibility of such damages.
164+
165+
9. Accepting Warranty or Additional Liability. While redistributing
166+
the Work or Derivative Works thereof, You may choose to offer,
167+
and charge a fee for, acceptance of support, warranty, indemnity,
168+
or other liability obligations and/or rights consistent with this
169+
License. However, in accepting such obligations, You may act only
170+
on Your own behalf and on Your sole responsibility, not on behalf
171+
of any other Contributor, and only if You agree to indemnify,
172+
defend, and hold each Contributor harmless for any liability
173+
incurred by, or claims asserted against, such Contributor by reason
174+
of your accepting any such warranty or additional liability.
175+
176+
END OF TERMS AND CONDITIONS
177+
178+
APPENDIX: How to apply the Apache License to your work.
179+
180+
To apply the Apache License to your work, attach the following
181+
boilerplate notice, with the fields enclosed by brackets "[]"
182+
replaced with your own identifying information. (Don't include
183+
the brackets!) The text should be enclosed in the appropriate
184+
comment syntax for the file format. We also recommend that a
185+
file or class name and description of purpose be included on the
186+
same "printed page" as the copyright notice for easier
187+
identification within third-party archives.
188+
189+
Copyright 2022 Unstructured Technologies, Inc
190+
191+
Licensed under the Apache License, Version 2.0 (the "License");
192+
you may not use this file except in compliance with the License.
193+
You may obtain a copy of the License at
194+
195+
http://www.apache.org/licenses/LICENSE-2.0
196+
197+
Unless required by applicable law or agreed to in writing, software
198+
distributed under the License is distributed on an "AS IS" BASIS,
199+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200+
See the License for the specific language governing permissions and
201+
limitations under the License.

‎requirements/connectors/kdbai.in‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
-c ../common/constraints.txt
2+
-c ../common/base.txt
3+
4+
kdbai-client

‎requirements/connectors/kdbai.txt‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
#
2+
# This file is autogenerated by pip-compile with Python 3.9
3+
# by the following command:
4+
#
5+
# pip-compile kdbai.in
6+
#
7+
certifi==2024.7.4
8+
# via
9+
# -c ../common/base.txt
10+
# -c ../common/constraints.txt
11+
# requests
12+
charset-normalizer==3.3.2
13+
# via
14+
# -c ../common/base.txt
15+
# requests
16+
idna==3.7
17+
# via
18+
# -c ../common/base.txt
19+
# requests
20+
kdbai-client==1.2.4
21+
# via -r kdbai.in
22+
numpy==1.26.4
23+
# via
24+
# -c ../common/base.txt
25+
# pandas
26+
# pykx
27+
pandas==2.2.2
28+
# via
29+
# -c ../common/base.txt
30+
# kdbai-client
31+
# pykx
32+
pykx==2.3.0
33+
# via kdbai-client
34+
python-dateutil==2.9.0.post0
35+
# via
36+
# -c ../common/base.txt
37+
# pandas
38+
pytz==2024.1
39+
# via
40+
# -c ../common/base.txt
41+
# pandas
42+
# pykx
43+
requests==2.32.3
44+
# via
45+
# -c ../common/base.txt
46+
# kdbai-client
47+
six==1.16.0
48+
# via
49+
# -c ../common/base.txt
50+
# python-dateutil
51+
toml==0.10.2
52+
# via pykx
53+
tzdata==2024.1
54+
# via
55+
# -c ../common/base.txt
56+
# pandas
57+
urllib3==1.26.19
58+
# via
59+
# -c ../common/base.txt
60+
# -c ../common/constraints.txt
61+
# requests

‎setup.py‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -103,6 +103,7 @@ def load_requirements(file: Union[str, Path]) -> List[str]:
103103
"hubspot": load_requirements("requirements/connectors/hubspot.in"),
104104
"jira": load_requirements("requirements/connectors/jira.in"),
105105
"kafka": load_requirements("requirements/connectors/kafka.in"),
106+
"kdbai": load_requirements("requirements/connectors/kdbai.in"),
106107
"milvus": load_requirements("requirements/connectors/milvus.in"),
107108
"mongodb": load_requirements("requirements/connectors/mongodb.in"),
108109
"notion": load_requirements("requirements/connectors/notion.in"),

‎test_e2e/dest/kdbai.sh‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
#!/usr/bin/env bash
2+
3+
set -e
4+
5+
DEST_PATH=$(dirname "$(realpath "$0")")
6+
SCRIPT_DIR=$(dirname "$DEST_PATH")
7+
cd "$SCRIPT_DIR"/.. || exit 1
8+
OUTPUT_FOLDER_NAME=kdbai-dest
9+
OUTPUT_ROOT=${OUTPUT_ROOT:-$SCRIPT_DIR}
10+
OUTPUT_DIR=$OUTPUT_ROOT/structured-output/$OUTPUT_FOLDER_NAME
11+
WORK_DIR=$OUTPUT_ROOT/workdir/$OUTPUT_FOLDER_NAME
12+
CI=${CI:-"false"}
13+
max_processes=${MAX_PROCESSES:=$(python3 -c "import os; print(os.cpu_count())")}
14+
15+
if [ -z "$KDBAI_CIPHER_KEY" ] || [ -z "$KDBAI_USERNAME" ] || [ -z "$KDBAI_BEARER_TOKEN" ]; then
16+
echo "Skipping KDBAI ingest test because KDBAI_CIPHER_KEY, KDBAI_USERNAME or KDBAI_BEARER_TOKEN env vars is not set."
17+
exit 8
18+
fi
19+
20+
# shellcheck disable=SC1091
21+
source "$SCRIPT_DIR"/cleanup.sh
22+
function cleanup {
23+
24+
echo "Stopping KDBAI Docker container"
25+
docker compose -f "$SCRIPT_DIR"/env_setup/kdbai/docker-compose.yml down --remove-orphans -v
26+
27+
# Local file cleanup
28+
cleanup_dir "$WORK_DIR"
29+
cleanup_dir "$OUTPUT_DIR"
30+
31+
}
32+
33+
trap cleanup EXIT
34+
35+
# Fetch docker image from kdbai private registry
36+
docker login portal.dl.kx.com -u "$KDBAI_USERNAME" -p "$KDBAI_BEARER_TOKEN"
37+
docker pull portal.dl.kx.com/kdbai-db:latest
38+
docker logout
39+
40+
"$SCRIPT_DIR"/env_setup/kdbai/provision.sh
41+
42+
PYTHONPATH=. ./unstructured_ingest/main.py \
43+
local \
44+
--num-processes "$max_processes" \
45+
--output-dir "$OUTPUT_DIR" \
46+
--strategy fast \
47+
--verbose \
48+
--reprocess \
49+
--input-path example-docs/pdf/fake-memo.pdf \
50+
--work-dir "$WORK_DIR" \
51+
--embedding-provider "langchain-huggingface" \
52+
kdbai \
53+
--table-name "unstructured_test" \
54+
--batch-size 100
55+
56+
python "$SCRIPT_DIR"/env_setup/kdbai/test_output.py

‎test_e2e/env_setup/kdbai/.gitignore‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
k4.lic

‎test_e2e/env_setup/kdbai/docker-compose.yml‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
services:
2+
kdbai:
3+
image: "portal.dl.kx.com/kdbai-db:latest"
4+
container_name: "kdbai-db"
5+
volumes:
6+
- ./k4.lic:/opt/kx/lic/k4.lic
7+
ports:
8+
- "8082:8082"
9+
10+

0 commit comments

Comments
 (0)