├── .genignore ├── .gitattributes ├── .github ├── ISSUE_TEMPLATE │ ├── bug_report.md │ ├── custom.md │ └── feature_request.md └── workflows │ ├── ci.yaml │ ├── speakeasy_sdk_generation.yml │ └── speakeasy_sdk_publish.yaml ├── .gitignore ├── .speakeasy ├── gen.lock ├── workflow.lock └── workflow.yaml ├── .vscode └── settings.json ├── CHANGELOG.md ├── CONTRIBUTING.md ├── LICENSE.md ├── Makefile ├── README.md ├── RELEASES.md ├── USAGE.md ├── _jupyter └── README_example.ipynb ├── _sample_docs ├── csv-with-long-lines.csv ├── embedded-images-tables.jpg ├── emoji.xlsx ├── fake-power-point.ppt ├── fake.doc ├── ideas-page.html ├── layout-parser-paper-fast.pdf ├── layout-parser-paper.pdf ├── list-item-example-1.pdf └── super_long_pages.pdf ├── _test_contract ├── conftest.py ├── platform_api │ ├── test_destinations.py │ ├── test_jobs.py │ ├── test_sources.py │ └── test_workflows.py └── test_retries.py ├── _test_unstructured_client ├── integration │ ├── test_decorators.py │ └── test_integration.py ├── unit │ ├── test_custom_hooks.py │ ├── test_request_utils.py │ ├── test_server_urls.py │ └── test_split_pdf_hook.py └── unit_utils.py ├── codeSamples.yaml ├── docs ├── models │ ├── errors │ │ ├── detail.md │ │ ├── httpvalidationerror.md │ │ └── servererror.md │ ├── operations │ │ ├── canceljobrequest.md │ │ ├── canceljobresponse.md │ │ ├── createconnectioncheckdestinationsrequest.md │ │ ├── createconnectioncheckdestinationsresponse.md │ │ ├── createconnectionchecksourcesrequest.md │ │ ├── createconnectionchecksourcesresponse.md │ │ ├── createdestinationrequest.md │ │ ├── createdestinationresponse.md │ │ ├── createsourcerequest.md │ │ ├── createsourceresponse.md │ │ ├── createworkflowrequest.md │ │ ├── createworkflowresponse.md │ │ ├── deletedestinationrequest.md │ │ ├── deletedestinationresponse.md │ │ ├── deletesourcerequest.md │ │ ├── deletesourceresponse.md │ │ ├── deleteworkflowrequest.md │ │ ├── deleteworkflowresponse.md │ │ ├── downloadjoboutputrequest.md │ │ ├── downloadjoboutputresponse.md │ │ ├── getconnectioncheckdestinationsrequest.md │ │ ├── getconnectioncheckdestinationsresponse.md │ │ ├── getconnectionchecksourcesrequest.md │ │ ├── getconnectionchecksourcesresponse.md │ │ ├── getdestinationrequest.md │ │ ├── getdestinationresponse.md │ │ ├── getjobrequest.md │ │ ├── getjobresponse.md │ │ ├── getsourcerequest.md │ │ ├── getsourceresponse.md │ │ ├── getworkflowrequest.md │ │ ├── getworkflowresponse.md │ │ ├── listdestinationsrequest.md │ │ ├── listdestinationsresponse.md │ │ ├── listjobsrequest.md │ │ ├── listjobsresponse.md │ │ ├── listsourcesrequest.md │ │ ├── listsourcesresponse.md │ │ ├── listworkflowsrequest.md │ │ ├── listworkflowsresponse.md │ │ ├── partitionrequest.md │ │ ├── partitionresponse.md │ │ ├── runworkflowrequest.md │ │ ├── runworkflowresponse.md │ │ ├── updatedestinationrequest.md │ │ ├── updatedestinationresponse.md │ │ ├── updatesourcerequest.md │ │ ├── updatesourceresponse.md │ │ ├── updateworkflowrequest.md │ │ └── updateworkflowresponse.md │ ├── shared │ │ ├── astradbconnectorconfig.md │ │ ├── astradbconnectorconfiginput.md │ │ ├── azureaisearchconnectorconfig.md │ │ ├── azureaisearchconnectorconfiginput.md │ │ ├── azuredestinationconnectorconfig.md │ │ ├── azuredestinationconnectorconfiginput.md │ │ ├── azuresourceconnectorconfig.md │ │ ├── azuresourceconnectorconfiginput.md │ │ ├── bodyrunworkflow.md │ │ ├── boxsourceconnectorconfig.md │ │ ├── boxsourceconnectorconfiginput.md │ │ ├── config.md │ │ ├── confluencesourceconnectorconfig.md │ │ ├── confluencesourceconnectorconfiginput.md │ │ ├── connectioncheckstatus.md │ │ ├── couchbasedestinationconnectorconfig.md │ │ ├── couchbasedestinationconnectorconfiginput.md │ │ ├── couchbasesourceconnectorconfig.md │ │ ├── couchbasesourceconnectorconfiginput.md │ │ ├── createdestinationconnector.md │ │ ├── createsourceconnector.md │ │ ├── createsourceconnectorconfig.md │ │ ├── createworkflow.md │ │ ├── crontabentry.md │ │ ├── dagnodeconnectioncheck.md │ │ ├── databricksvdtdestinationconnectorconfig.md │ │ ├── databricksvdtdestinationconnectorconfiginput.md │ │ ├── databricksvolumesconnectorconfig.md │ │ ├── databricksvolumesconnectorconfiginput.md │ │ ├── deltatableconnectorconfig.md │ │ ├── deltatableconnectorconfiginput.md │ │ ├── destinationconnectorinformation.md │ │ ├── destinationconnectorinformationconfig.md │ │ ├── destinationconnectortype.md │ │ ├── dropboxsourceconnectorconfig.md │ │ ├── dropboxsourceconnectorconfiginput.md │ │ ├── elasticsearchconnectorconfig.md │ │ ├── elasticsearchconnectorconfiginput.md │ │ ├── files.md │ │ ├── gcsdestinationconnectorconfig.md │ │ ├── gcsdestinationconnectorconfiginput.md │ │ ├── gcssourceconnectorconfig.md │ │ ├── gcssourceconnectorconfiginput.md │ │ ├── googledrivesourceconnectorconfig.md │ │ ├── googledrivesourceconnectorconfiginput.md │ │ ├── ibmwatsonxs3destinationconnectorconfig.md │ │ ├── ibmwatsonxs3destinationconnectorconfiginput.md │ │ ├── inputfiles.md │ │ ├── jirasourceconnectorconfig.md │ │ ├── jirasourceconnectorconfiginput.md │ │ ├── jobinformation.md │ │ ├── jobstatus.md │ │ ├── kafkaclouddestinationconnectorconfig.md │ │ ├── kafkaclouddestinationconnectorconfiginput.md │ │ ├── kafkacloudsourceconnectorconfig.md │ │ ├── kafkacloudsourceconnectorconfiginput.md │ │ ├── loc.md │ │ ├── milvusdestinationconnectorconfig.md │ │ ├── milvusdestinationconnectorconfiginput.md │ │ ├── mongodbconnectorconfig.md │ │ ├── mongodbconnectorconfiginput.md │ │ ├── neo4jdestinationconnectorconfig.md │ │ ├── neo4jdestinationconnectorconfiginput.md │ │ ├── nodefilemetadata.md │ │ ├── onedrivedestinationconnectorconfig.md │ │ ├── onedrivedestinationconnectorconfiginput.md │ │ ├── onedrivesourceconnectorconfig.md │ │ ├── onedrivesourceconnectorconfiginput.md │ │ ├── outlooksourceconnectorconfig.md │ │ ├── outlooksourceconnectorconfiginput.md │ │ ├── outputformat.md │ │ ├── partitionparameters.md │ │ ├── pineconedestinationconnectorconfig.md │ │ ├── pineconedestinationconnectorconfiginput.md │ │ ├── postgresdestinationconnectorconfig.md │ │ ├── postgresdestinationconnectorconfiginput.md │ │ ├── postgressourceconnectorconfig.md │ │ ├── postgressourceconnectorconfiginput.md │ │ ├── qdrantclouddestinationconnectorconfig.md │ │ ├── qdrantclouddestinationconnectorconfiginput.md │ │ ├── redisdestinationconnectorconfig.md │ │ ├── redisdestinationconnectorconfiginput.md │ │ ├── s3destinationconnectorconfig.md │ │ ├── s3destinationconnectorconfiginput.md │ │ ├── s3sourceconnectorconfig.md │ │ ├── s3sourceconnectorconfiginput.md │ │ ├── salesforcesourceconnectorconfig.md │ │ ├── salesforcesourceconnectorconfiginput.md │ │ ├── schedule.md │ │ ├── security.md │ │ ├── sharepointsourceconnectorconfig.md │ │ ├── sharepointsourceconnectorconfiginput.md │ │ ├── snowflakedestinationconnectorconfig.md │ │ ├── snowflakedestinationconnectorconfiginput.md │ │ ├── snowflakesourceconnectorconfig.md │ │ ├── snowflakesourceconnectorconfiginput.md │ │ ├── sourceconnectorinformation.md │ │ ├── sourceconnectorinformationconfig.md │ │ ├── sourceconnectortype.md │ │ ├── strategy.md │ │ ├── updatedestinationconnector.md │ │ ├── updatedestinationconnectorconfig.md │ │ ├── updatesourceconnector.md │ │ ├── updatesourceconnectorconfig.md │ │ ├── updateworkflow.md │ │ ├── updateworkflowschedule.md │ │ ├── validationerror.md │ │ ├── vlmmodel.md │ │ ├── vlmmodelprovider.md │ │ ├── weaviatedestinationconnectorconfig.md │ │ ├── weaviatedestinationconnectorconfiginput.md │ │ ├── workflowinformation.md │ │ ├── workflowjobtype.md │ │ ├── workflownode.md │ │ ├── workflownodetype.md │ │ ├── workflowschedule.md │ │ ├── workflowstate.md │ │ ├── workflowtype.md │ │ ├── zendesksourceconnectorconfig.md │ │ └── zendesksourceconnectorconfiginput.md │ └── utils │ │ └── retryconfig.md └── sdks │ ├── destinations │ └── README.md │ ├── general │ └── README.md │ ├── jobs │ └── README.md │ ├── sources │ └── README.md │ ├── unstructuredclient │ └── README.md │ └── workflows │ └── README.md ├── files.gen ├── gen.yaml ├── overlay_client.yaml ├── poetry.lock ├── poetry.toml ├── py.typed ├── pylintrc ├── pyproject.toml ├── scripts ├── prepare_readme.py └── publish.sh ├── src └── unstructured_client │ ├── __init__.py │ ├── _hooks │ ├── __init__.py │ ├── custom │ │ ├── __init__.py │ │ ├── clean_server_url_hook.py │ │ ├── common.py │ │ ├── form_utils.py │ │ ├── logger_hook.py │ │ ├── pdf_utils.py │ │ ├── request_utils.py │ │ └── split_pdf_hook.py │ ├── registration.py │ ├── sdkhooks.py │ └── types.py │ ├── _version.py │ ├── basesdk.py │ ├── destinations.py │ ├── general.py │ ├── httpclient.py │ ├── jobs.py │ ├── models │ ├── __init__.py │ ├── errors │ │ ├── __init__.py │ │ ├── httpvalidationerror.py │ │ ├── sdkerror.py │ │ └── servererror.py │ ├── operations │ │ ├── __init__.py │ │ ├── cancel_job.py │ │ ├── create_connection_check_destinations.py │ │ ├── create_connection_check_sources.py │ │ ├── create_destination.py │ │ ├── create_source.py │ │ ├── create_workflow.py │ │ ├── delete_destination.py │ │ ├── delete_source.py │ │ ├── delete_workflow.py │ │ ├── download_job_output.py │ │ ├── get_connection_check_destinations.py │ │ ├── get_connection_check_sources.py │ │ ├── get_destination.py │ │ ├── get_job.py │ │ ├── get_source.py │ │ ├── get_workflow.py │ │ ├── list_destinations.py │ │ ├── list_jobs.py │ │ ├── list_sources.py │ │ ├── list_workflows.py │ │ ├── partition.py │ │ ├── run_workflow.py │ │ ├── update_destination.py │ │ ├── update_source.py │ │ └── update_workflow.py │ └── shared │ │ ├── __init__.py │ │ ├── astradbconnectorconfig.py │ │ ├── astradbconnectorconfiginput.py │ │ ├── azureaisearchconnectorconfig.py │ │ ├── azureaisearchconnectorconfiginput.py │ │ ├── azuredestinationconnectorconfig.py │ │ ├── azuredestinationconnectorconfiginput.py │ │ ├── azuresourceconnectorconfig.py │ │ ├── azuresourceconnectorconfiginput.py │ │ ├── body_run_workflow.py │ │ ├── boxsourceconnectorconfig.py │ │ ├── boxsourceconnectorconfiginput.py │ │ ├── confluencesourceconnectorconfig.py │ │ ├── confluencesourceconnectorconfiginput.py │ │ ├── connectioncheckstatus.py │ │ ├── couchbasedestinationconnectorconfig.py │ │ ├── couchbasedestinationconnectorconfiginput.py │ │ ├── couchbasesourceconnectorconfig.py │ │ ├── couchbasesourceconnectorconfiginput.py │ │ ├── createdestinationconnector.py │ │ ├── createsourceconnector.py │ │ ├── createworkflow.py │ │ ├── crontabentry.py │ │ ├── dagnodeconnectioncheck.py │ │ ├── databricksvdtdestinationconnectorconfig.py │ │ ├── databricksvdtdestinationconnectorconfiginput.py │ │ ├── databricksvolumesconnectorconfig.py │ │ ├── databricksvolumesconnectorconfiginput.py │ │ ├── deltatableconnectorconfig.py │ │ ├── deltatableconnectorconfiginput.py │ │ ├── destinationconnectorinformation.py │ │ ├── destinationconnectortype.py │ │ ├── dropboxsourceconnectorconfig.py │ │ ├── dropboxsourceconnectorconfiginput.py │ │ ├── elasticsearchconnectorconfig.py │ │ ├── elasticsearchconnectorconfiginput.py │ │ ├── gcsdestinationconnectorconfig.py │ │ ├── gcsdestinationconnectorconfiginput.py │ │ ├── gcssourceconnectorconfig.py │ │ ├── gcssourceconnectorconfiginput.py │ │ ├── googledrivesourceconnectorconfig.py │ │ ├── googledrivesourceconnectorconfiginput.py │ │ ├── ibmwatsonxs3destinationconnectorconfig.py │ │ ├── ibmwatsonxs3destinationconnectorconfiginput.py │ │ ├── jirasourceconnectorconfig.py │ │ ├── jirasourceconnectorconfiginput.py │ │ ├── jobinformation.py │ │ ├── jobstatus.py │ │ ├── kafkaclouddestinationconnectorconfig.py │ │ ├── kafkaclouddestinationconnectorconfiginput.py │ │ ├── kafkacloudsourceconnectorconfig.py │ │ ├── kafkacloudsourceconnectorconfiginput.py │ │ ├── milvusdestinationconnectorconfig.py │ │ ├── milvusdestinationconnectorconfiginput.py │ │ ├── mongodbconnectorconfig.py │ │ ├── mongodbconnectorconfiginput.py │ │ ├── neo4jdestinationconnectorconfig.py │ │ ├── neo4jdestinationconnectorconfiginput.py │ │ ├── nodefilemetadata.py │ │ ├── onedrivedestinationconnectorconfig.py │ │ ├── onedrivedestinationconnectorconfiginput.py │ │ ├── onedrivesourceconnectorconfig.py │ │ ├── onedrivesourceconnectorconfiginput.py │ │ ├── outlooksourceconnectorconfig.py │ │ ├── outlooksourceconnectorconfiginput.py │ │ ├── partition_parameters.py │ │ ├── pineconedestinationconnectorconfig.py │ │ ├── pineconedestinationconnectorconfiginput.py │ │ ├── postgresdestinationconnectorconfig.py │ │ ├── postgresdestinationconnectorconfiginput.py │ │ ├── postgressourceconnectorconfig.py │ │ ├── postgressourceconnectorconfiginput.py │ │ ├── qdrantclouddestinationconnectorconfig.py │ │ ├── qdrantclouddestinationconnectorconfiginput.py │ │ ├── redisdestinationconnectorconfig.py │ │ ├── redisdestinationconnectorconfiginput.py │ │ ├── s3destinationconnectorconfig.py │ │ ├── s3destinationconnectorconfiginput.py │ │ ├── s3sourceconnectorconfig.py │ │ ├── s3sourceconnectorconfiginput.py │ │ ├── salesforcesourceconnectorconfig.py │ │ ├── salesforcesourceconnectorconfiginput.py │ │ ├── security.py │ │ ├── sharepointsourceconnectorconfig.py │ │ ├── sharepointsourceconnectorconfiginput.py │ │ ├── snowflakedestinationconnectorconfig.py │ │ ├── snowflakedestinationconnectorconfiginput.py │ │ ├── snowflakesourceconnectorconfig.py │ │ ├── snowflakesourceconnectorconfiginput.py │ │ ├── sourceconnectorinformation.py │ │ ├── sourceconnectortype.py │ │ ├── updatedestinationconnector.py │ │ ├── updatesourceconnector.py │ │ ├── updateworkflow.py │ │ ├── validationerror.py │ │ ├── weaviatedestinationconnectorconfig.py │ │ ├── weaviatedestinationconnectorconfiginput.py │ │ ├── workflowinformation.py │ │ ├── workflowjobtype.py │ │ ├── workflownode.py │ │ ├── workflownodetype.py │ │ ├── workflowschedule.py │ │ ├── workflowstate.py │ │ ├── workflowtype.py │ │ ├── zendesksourceconnectorconfig.py │ │ └── zendesksourceconnectorconfiginput.py │ ├── py.typed │ ├── sdk.py │ ├── sdkconfiguration.py │ ├── sources.py │ ├── types │ ├── __init__.py │ └── basemodel.py │ ├── utils │ ├── __init__.py │ ├── annotations.py │ ├── datetimes.py │ ├── enums.py │ ├── eventstreaming.py │ ├── forms.py │ ├── headers.py │ ├── logger.py │ ├── metadata.py │ ├── queryparams.py │ ├── requestbodies.py │ ├── retries.py │ ├── security.py │ ├── serializers.py │ ├── url.py │ └── values.py │ └── workflows.py └── tests └── helpers.py /.genignore: -------------------------------------------------------------------------------- 1 | # https://www.speakeasy.com/docs/customize/code/monkey-patching 2 | 3 | # ignore human-written files and directories 4 | _jupyter 5 | _sample_docs 6 | _test_unstructured_client 7 | 8 | # ignore Makefile 9 | Makefile 10 | 11 | # Ignore the base resource classes while we're patching in our own server url logic 12 | # If we add a new endpoint, we need to: 13 | # - Comment out the ignore for the right file 14 | # - Generate locally, watch the new endpoint appear 15 | # - Bring back the ignore line and commit 16 | src/unstructured_client/destinations.py 17 | src/unstructured_client/general.py 18 | src/unstructured_client/jobs.py 19 | src/unstructured_client/sources.py 20 | src/unstructured_client/workflows.py 21 | -------------------------------------------------------------------------------- /.gitattributes: -------------------------------------------------------------------------------- 1 | # This allows generated code to be indexed correctly 2 | *.py linguist-generated=false -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/bug_report.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Bug report 3 | about: Create a report to help us improve 4 | title: bug/ 5 | labels: bug 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Describe the bug** 11 | A clear and concise description of what the bug is. 12 | 13 | **To Reproduce** 14 | Provide a code snippet that reproduces the issue. 15 | 16 | **Expected behavior** 17 | A clear and concise description of what you expected to happen. 18 | 19 | **Screenshots** 20 | If applicable, add screenshots to help explain your problem. 21 | 22 | **Environment Info** 23 | Please run `python scripts/collect_env.py` and paste the output here. 24 | This will help us understand more about the environment in which the bug occurred. 25 | 26 | **Additional context** 27 | Add any other context about the problem here. 28 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/custom.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Custom issue template 3 | about: Describe this issue template's purpose here. 4 | title: '' 5 | labels: '' 6 | assignees: '' 7 | 8 | --- 9 | -------------------------------------------------------------------------------- /.github/ISSUE_TEMPLATE/feature_request.md: -------------------------------------------------------------------------------- 1 | --- 2 | name: Feature request 3 | about: Suggest an idea for this project 4 | title: feat/ 5 | labels: enhancement 6 | assignees: '' 7 | 8 | --- 9 | 10 | **Is your feature request related to a problem? Please describe.** 11 | A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] 12 | 13 | **Describe the solution you'd like** 14 | A clear and concise description of what you want to happen. 15 | 16 | **Describe alternatives you've considered** 17 | A clear and concise description of any alternative solutions or features you've considered. 18 | 19 | **Additional context** 20 | Add any other context or screenshots about the feature request here. 21 | -------------------------------------------------------------------------------- /.github/workflows/speakeasy_sdk_generation.yml: -------------------------------------------------------------------------------- 1 | name: Generate 2 | permissions: 3 | checks: write 4 | contents: write 5 | pull-requests: write 6 | statuses: write 7 | "on": 8 | workflow_dispatch: 9 | inputs: 10 | force: 11 | description: Force generation of SDKs 12 | type: boolean 13 | default: false 14 | schedule: 15 | - cron: 0 0 * * * 16 | jobs: 17 | generate: 18 | uses: speakeasy-api/sdk-generation-action/.github/workflows/workflow-executor.yaml@v15 19 | with: 20 | force: ${{ github.event.inputs.force }} 21 | mode: pr 22 | speakeasy_version: latest 23 | secrets: 24 | github_access_token: ${{ secrets.GITHUB_TOKEN }} 25 | pypi_token: ${{ secrets.PYPI_TOKEN }} 26 | speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }} 27 | -------------------------------------------------------------------------------- /.github/workflows/speakeasy_sdk_publish.yaml: -------------------------------------------------------------------------------- 1 | name: Publish 2 | permissions: 3 | checks: write 4 | contents: write 5 | pull-requests: write 6 | statuses: write 7 | "on": 8 | push: 9 | branches: 10 | - main 11 | paths: 12 | - RELEASES.md 13 | - '*/RELEASES.md' 14 | jobs: 15 | publish: 16 | uses: speakeasy-api/sdk-generation-action/.github/workflows/sdk-publish.yaml@v15 17 | secrets: 18 | github_access_token: ${{ secrets.GITHUB_TOKEN }} 19 | pypi_token: ${{ secrets.PYPI_TOKEN }} 20 | speakeasy_api_key: ${{ secrets.SPEAKEASY_API_KEY }} 21 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | **/__pycache__/ 2 | **/.speakeasy/temp/ 3 | **/.speakeasy/logs/ 4 | .speakeasy/temp/ 5 | .speakeasy/reports 6 | .venv/ 7 | README-PYPI.md 8 | pyrightconfig.json 9 | venv/ 10 | src/*.egg-info/ 11 | __pycache__/ 12 | .pytest_cache/ 13 | .python-version 14 | .DS_Store 15 | # human-added igore files 16 | .ipynb_checkpoints/ 17 | .idea/ 18 | .local 19 | *.ipynb 20 | openapi.json 21 | openapi_client.json 22 | openapi_serverless.json 23 | openapi_platform_api.json 24 | openapi_merged.yaml 25 | openapi_platform_serverless_client.yaml 26 | # Environments 27 | .env 28 | .envrc 29 | .venv* 30 | venv* 31 | env/ 32 | ENV/ 33 | env.bak/ 34 | -------------------------------------------------------------------------------- /.speakeasy/workflow.lock: -------------------------------------------------------------------------------- 1 | speakeasyVersion: 1.552.0 2 | sources: 3 | my-source: 4 | sourceNamespace: my-source 5 | sourceRevisionDigest: sha256:7ceb514059ca48d6851ea7eacc84aa4177b0299d9fc01e71a891f6bc6244b089 6 | sourceBlobDigest: sha256:20af3cb02fd412795707dc692fcfdb11f412c27d8095ee4197ea318ea31c7bfe 7 | tags: 8 | - latest 9 | - speakeasy-sdk-regen-1748459387 10 | - 1.1.17 11 | targets: 12 | unstructured-python: 13 | source: my-source 14 | sourceNamespace: my-source 15 | sourceRevisionDigest: sha256:7ceb514059ca48d6851ea7eacc84aa4177b0299d9fc01e71a891f6bc6244b089 16 | sourceBlobDigest: sha256:20af3cb02fd412795707dc692fcfdb11f412c27d8095ee4197ea318ea31c7bfe 17 | codeSamplesNamespace: my-source-code-samples 18 | codeSamplesRevisionDigest: sha256:8dd8b645e1112de59bfed16856623f891e44b10d8af11e4f48877b08541e246f 19 | workflow: 20 | workflowVersion: 1.0.0 21 | speakeasyVersion: latest 22 | sources: 23 | my-source: 24 | inputs: 25 | - location: https://platform.unstructuredapp.io/openapi.json 26 | - location: https://api.unstructuredapp.io/general/openapi.json 27 | overlays: 28 | - location: ./overlay_client.yaml 29 | registry: 30 | location: registry.speakeasyapi.dev/unstructured/unstructured5xr/my-source 31 | targets: 32 | unstructured-python: 33 | target: python 34 | source: my-source 35 | publish: 36 | pypi: 37 | token: $PYPI_TOKEN 38 | codeSamples: 39 | output: codeSamples.yaml 40 | registry: 41 | location: registry.speakeasyapi.dev/unstructured/unstructured5xr/my-source-code-samples 42 | -------------------------------------------------------------------------------- /.speakeasy/workflow.yaml: -------------------------------------------------------------------------------- 1 | workflowVersion: 1.0.0 2 | speakeasyVersion: latest 3 | sources: 4 | my-source: 5 | inputs: 6 | - location: https://platform.unstructuredapp.io/openapi.json 7 | - location: https://api.unstructuredapp.io/general/openapi.json 8 | overlays: 9 | - location: ./overlay_client.yaml 10 | registry: 11 | location: registry.speakeasyapi.dev/unstructured/unstructured5xr/my-source 12 | targets: 13 | unstructured-python: 14 | target: python 15 | source: my-source 16 | publish: 17 | pypi: 18 | token: $PYPI_TOKEN 19 | codeSamples: 20 | output: codeSamples.yaml 21 | registry: 22 | location: registry.speakeasyapi.dev/unstructured/unstructured5xr/my-source-code-samples 23 | -------------------------------------------------------------------------------- /.vscode/settings.json: -------------------------------------------------------------------------------- 1 | { 2 | "python.testing.pytestArgs": ["tests", "-vv"], 3 | "python.testing.unittestEnabled": false, 4 | "python.testing.pytestEnabled": true, 5 | "pylint.args": ["--rcfile=pylintrc"] 6 | } 7 | -------------------------------------------------------------------------------- /CHANGELOG.md: -------------------------------------------------------------------------------- 1 | ## 0.30.0 2 | 3 | ### Enhancements 4 | 5 | ### Features 6 | * Add Unstructured Platform APIs to manage source and destination connectors, workflows, and workflow runs 7 | __WARNING__: This is a breaking change for the use of non-default `server_url` settings in the client usage. 8 | To set the custom URL for the client, use the the `server_url` parameter in a given operation: 9 | ```python 10 | elements = client.general.partition( 11 | request=operations.PartitionRequest( 12 | partition_parameters=shared.PartitionParameters( 13 | files=shared.Files( 14 | content=doc_file, 15 | file_name="your_document.pdf", 16 | ), 17 | strategy=shared.Strategy.FAST, 18 | ) 19 | ), 20 | server_url="your_server_url", 21 | ) 22 | ``` 23 | 24 | ### Fixes 25 | 26 | ## 0.26.1 27 | 28 | ### Enhancements 29 | 30 | ### Features 31 | 32 | ### Fixes 33 | * Use the configured server_url for our split page "dummy" request 34 | 35 | ## 0.26.0 36 | 37 | ### Enhancements 38 | * Switch to a httpx based client instead of requests 39 | * Switch to poetry for dependency management 40 | * Add client side parameter checking via Pydantic or TypedDict interfaces 41 | 42 | ### Features 43 | * Add `partition_async` for a non blocking alternative to `partition` 44 | 45 | ### Fixes 46 | * Address some asyncio based errors in pdf splitting logic 47 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Contributing to This Repository 2 | 3 | Thank you for your interest in contributing to this repository. Please note that this repository contains generated code. As such, we do not accept direct changes or pull requests. Instead, we encourage you to follow the guidelines below to report issues and suggest improvements. 4 | 5 | ## How to Report Issues 6 | 7 | If you encounter any bugs or have suggestions for improvements, please open an issue on GitHub. When reporting an issue, please provide as much detail as possible to help us reproduce the problem. This includes: 8 | 9 | - A clear and descriptive title 10 | - Steps to reproduce the issue 11 | - Expected and actual behavior 12 | - Any relevant logs, screenshots, or error messages 13 | - Information about your environment (e.g., operating system, software versions) 14 | - For example can be collected using the `npx envinfo` command from your terminal if you have Node.js installed 15 | 16 | ## Issue Triage and Upstream Fixes 17 | 18 | We will review and triage issues as quickly as possible. Our goal is to address bugs and incorporate improvements in the upstream source code. Fixes will be included in the next generation of the generated code. 19 | 20 | ## Contact 21 | 22 | If you have any questions or need further assistance, please feel free to reach out by opening an issue. 23 | 24 | Thank you for your understanding and cooperation! 25 | 26 | The Maintainers 27 | -------------------------------------------------------------------------------- /LICENSE.md: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) 2023 Unstructured-IO 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. -------------------------------------------------------------------------------- /USAGE.md: -------------------------------------------------------------------------------- 1 | 2 | ```python 3 | # Synchronous Example 4 | from unstructured_client import UnstructuredClient 5 | 6 | 7 | with UnstructuredClient() as uc_client: 8 | 9 | res = uc_client.destinations.create_connection_check_destinations(request={ 10 | "destination_id": "cb9e35c1-0b04-4d98-83fa-fa6241323f96", 11 | }) 12 | 13 | assert res.dag_node_connection_check is not None 14 | 15 | # Handle response 16 | print(res.dag_node_connection_check) 17 | ``` 18 | 19 |
20 | 21 | The same SDK client can also be used to make asychronous requests by importing asyncio. 22 | ```python 23 | # Asynchronous Example 24 | import asyncio 25 | from unstructured_client import UnstructuredClient 26 | 27 | async def main(): 28 | 29 | async with UnstructuredClient() as uc_client: 30 | 31 | res = await uc_client.destinations.create_connection_check_destinations_async(request={ 32 | "destination_id": "cb9e35c1-0b04-4d98-83fa-fa6241323f96", 33 | }) 34 | 35 | assert res.dag_node_connection_check is not None 36 | 37 | # Handle response 38 | print(res.dag_node_connection_check) 39 | 40 | asyncio.run(main()) 41 | ``` 42 | -------------------------------------------------------------------------------- /_sample_docs/embedded-images-tables.jpg: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Unstructured-IO/unstructured-python-client/c3802306ef8c623ef7c1f411dd95069f4ce67383/_sample_docs/embedded-images-tables.jpg -------------------------------------------------------------------------------- /_sample_docs/emoji.xlsx: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Unstructured-IO/unstructured-python-client/c3802306ef8c623ef7c1f411dd95069f4ce67383/_sample_docs/emoji.xlsx -------------------------------------------------------------------------------- /_sample_docs/fake-power-point.ppt: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Unstructured-IO/unstructured-python-client/c3802306ef8c623ef7c1f411dd95069f4ce67383/_sample_docs/fake-power-point.ppt -------------------------------------------------------------------------------- /_sample_docs/fake.doc: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Unstructured-IO/unstructured-python-client/c3802306ef8c623ef7c1f411dd95069f4ce67383/_sample_docs/fake.doc -------------------------------------------------------------------------------- /_sample_docs/layout-parser-paper-fast.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Unstructured-IO/unstructured-python-client/c3802306ef8c623ef7c1f411dd95069f4ce67383/_sample_docs/layout-parser-paper-fast.pdf -------------------------------------------------------------------------------- /_sample_docs/layout-parser-paper.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Unstructured-IO/unstructured-python-client/c3802306ef8c623ef7c1f411dd95069f4ce67383/_sample_docs/layout-parser-paper.pdf -------------------------------------------------------------------------------- /_sample_docs/list-item-example-1.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Unstructured-IO/unstructured-python-client/c3802306ef8c623ef7c1f411dd95069f4ce67383/_sample_docs/list-item-example-1.pdf -------------------------------------------------------------------------------- /_sample_docs/super_long_pages.pdf: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/Unstructured-IO/unstructured-python-client/c3802306ef8c623ef7c1f411dd95069f4ce67383/_sample_docs/super_long_pages.pdf -------------------------------------------------------------------------------- /docs/models/errors/detail.md: -------------------------------------------------------------------------------- 1 | # Detail 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `List[shared.ValidationError]` 7 | 8 | ```python 9 | value: List[shared.ValidationError] = /* values here */ 10 | ``` 11 | 12 | ### `str` 13 | 14 | ```python 15 | value: str = /* values here */ 16 | ``` 17 | 18 | -------------------------------------------------------------------------------- /docs/models/errors/httpvalidationerror.md: -------------------------------------------------------------------------------- 1 | # HTTPValidationError 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | -------------------------------------------------------- | 8 | | `detail` | [Optional[errors.Detail]](../../models/errors/detail.md) | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/errors/servererror.md: -------------------------------------------------------------------------------- 1 | # ServerError 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `detail` | *Optional[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/canceljobrequest.md: -------------------------------------------------------------------------------- 1 | # CancelJobRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `job_id` | *str* | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/canceljobresponse.md: -------------------------------------------------------------------------------- 1 | # CancelJobResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | 8 | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | 9 | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | 10 | | `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | 11 | | `any` | *Optional[Any]* | :heavy_minus_sign: | Successful Response | -------------------------------------------------------------------------------- /docs/models/operations/createconnectioncheckdestinationsrequest.md: -------------------------------------------------------------------------------- 1 | # CreateConnectionCheckDestinationsRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `destination_id` | *str* | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/createconnectionchecksourcesrequest.md: -------------------------------------------------------------------------------- 1 | # CreateConnectionCheckSourcesRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `source_id` | *str* | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/createdestinationrequest.md: -------------------------------------------------------------------------------- 1 | # CreateDestinationRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | 8 | | `create_destination_connector` | [shared.CreateDestinationConnector](../../models/shared/createdestinationconnector.md) | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/createsourcerequest.md: -------------------------------------------------------------------------------- 1 | # CreateSourceRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | 8 | | `create_source_connector` | [shared.CreateSourceConnector](../../models/shared/createsourceconnector.md) | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/createworkflowrequest.md: -------------------------------------------------------------------------------- 1 | # CreateWorkflowRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | 8 | | `create_workflow` | [shared.CreateWorkflow](../../models/shared/createworkflow.md) | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/deletedestinationrequest.md: -------------------------------------------------------------------------------- 1 | # DeleteDestinationRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `destination_id` | *str* | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/deletedestinationresponse.md: -------------------------------------------------------------------------------- 1 | # DeleteDestinationResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | 8 | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | 9 | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | 10 | | `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | 11 | | `any` | *Optional[Any]* | :heavy_minus_sign: | Successful Response | -------------------------------------------------------------------------------- /docs/models/operations/deletesourcerequest.md: -------------------------------------------------------------------------------- 1 | # DeleteSourceRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `source_id` | *str* | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/deletesourceresponse.md: -------------------------------------------------------------------------------- 1 | # DeleteSourceResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | 8 | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | 9 | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | 10 | | `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | 11 | | `any` | *Optional[Any]* | :heavy_minus_sign: | Successful Response | -------------------------------------------------------------------------------- /docs/models/operations/deleteworkflowrequest.md: -------------------------------------------------------------------------------- 1 | # DeleteWorkflowRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 9 | | `workflow_id` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/deleteworkflowresponse.md: -------------------------------------------------------------------------------- 1 | # DeleteWorkflowResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | 8 | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | 9 | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | 10 | | `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | 11 | | `any` | *Optional[Any]* | :heavy_minus_sign: | Successful Response | -------------------------------------------------------------------------------- /docs/models/operations/downloadjoboutputrequest.md: -------------------------------------------------------------------------------- 1 | # DownloadJobOutputRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | ------------------------------------------------- | 8 | | `file_id` | *str* | :heavy_check_mark: | ID of the file to download | 9 | | `job_id` | *str* | :heavy_check_mark: | N/A | 10 | | `node_id` | *str* | :heavy_check_mark: | Node ID to retrieve the corresponding output file | 11 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/downloadjoboutputresponse.md: -------------------------------------------------------------------------------- 1 | # DownloadJobOutputResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | 8 | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | 9 | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | 10 | | `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | 11 | | `any` | *Optional[Any]* | :heavy_minus_sign: | Successful Response | -------------------------------------------------------------------------------- /docs/models/operations/getconnectioncheckdestinationsrequest.md: -------------------------------------------------------------------------------- 1 | # GetConnectionCheckDestinationsRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `destination_id` | *str* | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/getconnectionchecksourcesrequest.md: -------------------------------------------------------------------------------- 1 | # GetConnectionCheckSourcesRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `source_id` | *str* | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/getdestinationrequest.md: -------------------------------------------------------------------------------- 1 | # GetDestinationRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `destination_id` | *str* | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/getjobrequest.md: -------------------------------------------------------------------------------- 1 | # GetJobRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `job_id` | *str* | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/getjobresponse.md: -------------------------------------------------------------------------------- 1 | # GetJobResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | 8 | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | 9 | | `job_information` | [Optional[shared.JobInformation]](../../models/shared/jobinformation.md) | :heavy_minus_sign: | Successful Response | 10 | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | 11 | | `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -------------------------------------------------------------------------------- /docs/models/operations/getsourcerequest.md: -------------------------------------------------------------------------------- 1 | # GetSourceRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `source_id` | *str* | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/getworkflowrequest.md: -------------------------------------------------------------------------------- 1 | # GetWorkflowRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 9 | | `workflow_id` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/listdestinationsrequest.md: -------------------------------------------------------------------------------- 1 | # ListDestinationsRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------- | 8 | | `destination_type` | [OptionalNullable[shared.DestinationConnectorType]](../../models/shared/destinationconnectortype.md) | :heavy_minus_sign: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/listjobsrequest.md: -------------------------------------------------------------------------------- 1 | # ListJobsRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `status` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `workflow_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/listjobsresponse.md: -------------------------------------------------------------------------------- 1 | # ListJobsResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | -------------------------------------------------------------------- | 8 | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | 9 | | `response_list_jobs` | List[[shared.JobInformation](../../models/shared/jobinformation.md)] | :heavy_minus_sign: | Successful Response | 10 | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | 11 | | `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -------------------------------------------------------------------------------- /docs/models/operations/listsourcesrequest.md: -------------------------------------------------------------------------------- 1 | # ListSourcesRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------ | 8 | | `source_type` | [OptionalNullable[shared.SourceConnectorType]](../../models/shared/sourceconnectortype.md) | :heavy_minus_sign: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/partitionrequest.md: -------------------------------------------------------------------------------- 1 | # PartitionRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | 8 | | `partition_parameters` | [shared.PartitionParameters](../../models/shared/partitionparameters.md) | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/partitionresponse.md: -------------------------------------------------------------------------------- 1 | # PartitionResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | 8 | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | 9 | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | 10 | | `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | 11 | | `csv_elements` | *Optional[str]* | :heavy_minus_sign: | Successful Response | 12 | | `elements` | List[Dict[str, *Any*]] | :heavy_minus_sign: | Successful Response | -------------------------------------------------------------------------------- /docs/models/operations/runworkflowrequest.md: -------------------------------------------------------------------------------- 1 | # RunWorkflowRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | -------------------------------------------------------------------------- | 8 | | `body_run_workflow` | [Optional[shared.BodyRunWorkflow]](../../models/shared/bodyrunworkflow.md) | :heavy_minus_sign: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `workflow_id` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/runworkflowresponse.md: -------------------------------------------------------------------------------- 1 | # RunWorkflowResponse 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | ------------------------------------------------------------------------ | 8 | | `content_type` | *str* | :heavy_check_mark: | HTTP response content type for this operation | 9 | | `job_information` | [Optional[shared.JobInformation]](../../models/shared/jobinformation.md) | :heavy_minus_sign: | Successful Response | 10 | | `status_code` | *int* | :heavy_check_mark: | HTTP response status code for this operation | 11 | | `raw_response` | [httpx.Response](https://www.python-httpx.org/api/#response) | :heavy_check_mark: | Raw HTTP response; suitable for custom response parsing | -------------------------------------------------------------------------------- /docs/models/operations/updatedestinationrequest.md: -------------------------------------------------------------------------------- 1 | # UpdateDestinationRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------- | 8 | | `update_destination_connector` | [shared.UpdateDestinationConnector](../../models/shared/updatedestinationconnector.md) | :heavy_check_mark: | N/A | 9 | | `destination_id` | *str* | :heavy_check_mark: | N/A | 10 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/updatesourcerequest.md: -------------------------------------------------------------------------------- 1 | # UpdateSourceRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | ---------------------------------------------------------------------------- | 8 | | `update_source_connector` | [shared.UpdateSourceConnector](../../models/shared/updatesourceconnector.md) | :heavy_check_mark: | N/A | 9 | | `source_id` | *str* | :heavy_check_mark: | N/A | 10 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/operations/updateworkflowrequest.md: -------------------------------------------------------------------------------- 1 | # UpdateWorkflowRequest 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | -------------------------------------------------------------- | 8 | | `update_workflow` | [shared.UpdateWorkflow](../../models/shared/updateworkflow.md) | :heavy_check_mark: | N/A | 9 | | `unstructured_api_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `workflow_id` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/astradbconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # AstraDBConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `api_endpoint` | *str* | :heavy_check_mark: | N/A | 9 | | `batch_size` | *int* | :heavy_check_mark: | N/A | 10 | | `collection_name` | *str* | :heavy_check_mark: | N/A | 11 | | `keyspace` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 12 | | `token` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/astradbconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # AstraDBConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `api_endpoint` | *str* | :heavy_check_mark: | N/A | 9 | | `batch_size` | *Optional[int]* | :heavy_minus_sign: | N/A | 10 | | `collection_name` | *str* | :heavy_check_mark: | N/A | 11 | | `flatten_metadata` | *Optional[bool]* | :heavy_minus_sign: | N/A | 12 | | `keyspace` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 13 | | `token` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/azureaisearchconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # AzureAISearchConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `endpoint` | *str* | :heavy_check_mark: | N/A | 9 | | `index` | *str* | :heavy_check_mark: | N/A | 10 | | `key` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/azureaisearchconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # AzureAISearchConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `endpoint` | *str* | :heavy_check_mark: | N/A | 9 | | `index` | *str* | :heavy_check_mark: | N/A | 10 | | `key` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/azuredestinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # AzureDestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `account_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 9 | | `account_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `connection_string` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 12 | | `sas_token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/azuredestinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # AzureDestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `account_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 9 | | `account_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `connection_string` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 12 | | `sas_token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/azuresourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # AzureSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `account_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 9 | | `account_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `connection_string` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `recursive` | *bool* | :heavy_check_mark: | N/A | 12 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 13 | | `sas_token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/azuresourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # AzureSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `account_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 9 | | `account_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `connection_string` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `recursive` | *Optional[bool]* | :heavy_minus_sign: | N/A | 12 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 13 | | `sas_token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/bodyrunworkflow.md: -------------------------------------------------------------------------------- 1 | # BodyRunWorkflow 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | ------------------------------------------------------------ | 8 | | `input_files` | List[[shared.InputFiles](../../models/shared/inputfiles.md)] | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/boxsourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # BoxSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `box_app_config` | *str* | :heavy_check_mark: | N/A | 9 | | `recursive` | *bool* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/boxsourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # BoxSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `box_app_config` | *str* | :heavy_check_mark: | N/A | 9 | | `recursive` | *Optional[bool]* | :heavy_minus_sign: | N/A | 10 | | `remote_url` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/connectioncheckstatus.md: -------------------------------------------------------------------------------- 1 | # ConnectionCheckStatus 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ----------- | ----------- | 8 | | `SCHEDULED` | SCHEDULED | 9 | | `SUCCESS` | SUCCESS | 10 | | `FAILURE` | FAILURE | -------------------------------------------------------------------------------- /docs/models/shared/couchbasedestinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # CouchbaseDestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `batch_size` | *int* | :heavy_check_mark: | N/A | 9 | | `bucket` | *str* | :heavy_check_mark: | N/A | 10 | | `collection` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `connection_string` | *str* | :heavy_check_mark: | N/A | 12 | | `password` | *str* | :heavy_check_mark: | N/A | 13 | | `scope` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 14 | | `username` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/couchbasedestinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # CouchbaseDestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `batch_size` | *int* | :heavy_check_mark: | N/A | 9 | | `bucket` | *str* | :heavy_check_mark: | N/A | 10 | | `collection` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `connection_string` | *str* | :heavy_check_mark: | N/A | 12 | | `password` | *str* | :heavy_check_mark: | N/A | 13 | | `scope` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 14 | | `username` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/couchbasesourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # CouchbaseSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `batch_size` | *int* | :heavy_check_mark: | N/A | 9 | | `bucket` | *str* | :heavy_check_mark: | N/A | 10 | | `collection` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `collection_id` | *str* | :heavy_check_mark: | N/A | 12 | | `connection_string` | *str* | :heavy_check_mark: | N/A | 13 | | `password` | *str* | :heavy_check_mark: | N/A | 14 | | `scope` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 15 | | `username` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/couchbasesourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # CouchbaseSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `batch_size` | *int* | :heavy_check_mark: | N/A | 9 | | `bucket` | *str* | :heavy_check_mark: | N/A | 10 | | `collection` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `collection_id` | *str* | :heavy_check_mark: | N/A | 12 | | `connection_string` | *str* | :heavy_check_mark: | N/A | 13 | | `password` | *str* | :heavy_check_mark: | N/A | 14 | | `scope` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 15 | | `username` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/createdestinationconnector.md: -------------------------------------------------------------------------------- 1 | # CreateDestinationConnector 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------- | 8 | | `config` | [shared.Config](../../models/shared/config.md) | :heavy_check_mark: | N/A | 9 | | `name` | *str* | :heavy_check_mark: | N/A | 10 | | `type` | [shared.DestinationConnectorType](../../models/shared/destinationconnectortype.md) | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/createsourceconnector.md: -------------------------------------------------------------------------------- 1 | # CreateSourceConnector 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | 8 | | `config` | [shared.CreateSourceConnectorConfig](../../models/shared/createsourceconnectorconfig.md) | :heavy_check_mark: | N/A | 9 | | `name` | *str* | :heavy_check_mark: | N/A | 10 | | `type` | [shared.SourceConnectorType](../../models/shared/sourceconnectortype.md) | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/crontabentry.md: -------------------------------------------------------------------------------- 1 | # CronTabEntry 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `cron_expression` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/databricksvdtdestinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # DatabricksVDTDestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `catalog` | *str* | :heavy_check_mark: | N/A | 9 | | `client_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `client_secret` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `database` | *Optional[str]* | :heavy_minus_sign: | N/A | 12 | | `http_path` | *str* | :heavy_check_mark: | N/A | 13 | | `schema_` | *Optional[str]* | :heavy_minus_sign: | N/A | 14 | | `server_hostname` | *str* | :heavy_check_mark: | N/A | 15 | | `table_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 16 | | `token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 17 | | `volume` | *str* | :heavy_check_mark: | N/A | 18 | | `volume_path` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/databricksvdtdestinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # DatabricksVDTDestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `catalog` | *str* | :heavy_check_mark: | N/A | 9 | | `client_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `client_secret` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `database` | *Optional[str]* | :heavy_minus_sign: | N/A | 12 | | `http_path` | *str* | :heavy_check_mark: | N/A | 13 | | `schema_` | *Optional[str]* | :heavy_minus_sign: | N/A | 14 | | `server_hostname` | *str* | :heavy_check_mark: | N/A | 15 | | `table_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 16 | | `token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 17 | | `volume` | *str* | :heavy_check_mark: | N/A | 18 | | `volume_path` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/databricksvolumesconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # DatabricksVolumesConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `catalog` | *str* | :heavy_check_mark: | N/A | 9 | | `client_id` | *str* | :heavy_check_mark: | N/A | 10 | | `client_secret` | *str* | :heavy_check_mark: | N/A | 11 | | `host` | *str* | :heavy_check_mark: | N/A | 12 | | `schema_` | *Optional[str]* | :heavy_minus_sign: | N/A | 13 | | `volume` | *str* | :heavy_check_mark: | N/A | 14 | | `volume_path` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/databricksvolumesconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # DatabricksVolumesConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `catalog` | *str* | :heavy_check_mark: | N/A | 9 | | `client_id` | *str* | :heavy_check_mark: | N/A | 10 | | `client_secret` | *str* | :heavy_check_mark: | N/A | 11 | | `host` | *str* | :heavy_check_mark: | N/A | 12 | | `schema_` | *Optional[str]* | :heavy_minus_sign: | N/A | 13 | | `volume` | *str* | :heavy_check_mark: | N/A | 14 | | `volume_path` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/deltatableconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # DeltaTableConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `aws_access_key_id` | *str* | :heavy_check_mark: | N/A | 9 | | `aws_region` | *str* | :heavy_check_mark: | N/A | 10 | | `aws_secret_access_key` | *str* | :heavy_check_mark: | N/A | 11 | | `table_uri` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/deltatableconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # DeltaTableConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `aws_access_key_id` | *str* | :heavy_check_mark: | N/A | 9 | | `aws_region` | *str* | :heavy_check_mark: | N/A | 10 | | `aws_secret_access_key` | *str* | :heavy_check_mark: | N/A | 11 | | `table_uri` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/destinationconnectortype.md: -------------------------------------------------------------------------------- 1 | # DestinationConnectorType 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | -------------------------------- | -------------------------------- | 8 | | `ASTRADB` | astradb | 9 | | `AZURE_AI_SEARCH` | azure_ai_search | 10 | | `COUCHBASE` | couchbase | 11 | | `DATABRICKS_VOLUMES` | databricks_volumes | 12 | | `DATABRICKS_VOLUME_DELTA_TABLES` | databricks_volume_delta_tables | 13 | | `DELTA_TABLE` | delta_table | 14 | | `ELASTICSEARCH` | elasticsearch | 15 | | `GCS` | gcs | 16 | | `KAFKA_CLOUD` | kafka-cloud | 17 | | `MILVUS` | milvus | 18 | | `MONGODB` | mongodb | 19 | | `MOTHERDUCK` | motherduck | 20 | | `NEO4J` | neo4j | 21 | | `ONEDRIVE` | onedrive | 22 | | `PINECONE` | pinecone | 23 | | `POSTGRES` | postgres | 24 | | `REDIS` | redis | 25 | | `QDRANT_CLOUD` | qdrant-cloud | 26 | | `S3` | s3 | 27 | | `SNOWFLAKE` | snowflake | 28 | | `WEAVIATE_CLOUD` | weaviate-cloud | 29 | | `IBM_WATSONX_S3` | ibm_watsonx_s3 | -------------------------------------------------------------------------------- /docs/models/shared/dropboxsourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # DropboxSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `recursive` | *bool* | :heavy_check_mark: | N/A | 9 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 10 | | `token` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/dropboxsourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # DropboxSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `recursive` | *Optional[bool]* | :heavy_minus_sign: | N/A | 9 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 10 | | `token` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/elasticsearchconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # ElasticsearchConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `es_api_key` | *str* | :heavy_check_mark: | N/A | 9 | | `hosts` | List[*str*] | :heavy_check_mark: | N/A | 10 | | `index_name` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/elasticsearchconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # ElasticsearchConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `es_api_key` | *str* | :heavy_check_mark: | N/A | 9 | | `hosts` | List[*str*] | :heavy_check_mark: | N/A | 10 | | `index_name` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/gcsdestinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # GCSDestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | --------------------- | --------------------- | --------------------- | --------------------- | 8 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 9 | | `service_account_key` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/gcsdestinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # GCSDestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | --------------------- | --------------------- | --------------------- | --------------------- | 8 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 9 | | `service_account_key` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/gcssourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # GCSSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | --------------------- | --------------------- | --------------------- | --------------------- | 8 | | `recursive` | *bool* | :heavy_check_mark: | N/A | 9 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 10 | | `service_account_key` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/gcssourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # GCSSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | --------------------- | --------------------- | --------------------- | --------------------- | 8 | | `recursive` | *Optional[bool]* | :heavy_minus_sign: | N/A | 9 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 10 | | `service_account_key` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/googledrivesourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # GoogleDriveSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | --------------------- | --------------------- | --------------------- | --------------------- | 8 | | `drive_id` | *str* | :heavy_check_mark: | N/A | 9 | | `extensions` | List[*str*] | :heavy_minus_sign: | N/A | 10 | | `recursive` | *bool* | :heavy_check_mark: | N/A | 11 | | `service_account_key` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/googledrivesourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # GoogleDriveSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | --------------------- | --------------------- | --------------------- | --------------------- | 8 | | `drive_id` | *str* | :heavy_check_mark: | N/A | 9 | | `extensions` | List[*str*] | :heavy_minus_sign: | N/A | 10 | | `recursive` | *Optional[bool]* | :heavy_minus_sign: | N/A | 11 | | `service_account_key` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/ibmwatsonxs3destinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # IBMWatsonxS3DestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | 8 | | `access_key_id` | *str* | :heavy_check_mark: | N/A | 9 | | `catalog` | *str* | :heavy_check_mark: | N/A | 10 | | `iam_api_key` | *str* | :heavy_check_mark: | N/A | 11 | | `iceberg_endpoint` | *str* | :heavy_check_mark: | N/A | 12 | | `max_retries` | *int* | :heavy_check_mark: | N/A | 13 | | `max_retries_connection` | *int* | :heavy_check_mark: | N/A | 14 | | `namespace` | *str* | :heavy_check_mark: | N/A | 15 | | `object_storage_endpoint` | *str* | :heavy_check_mark: | N/A | 16 | | `object_storage_region` | *str* | :heavy_check_mark: | N/A | 17 | | `record_id_key` | *str* | :heavy_check_mark: | N/A | 18 | | `secret_access_key` | *str* | :heavy_check_mark: | N/A | 19 | | `table` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/inputfiles.md: -------------------------------------------------------------------------------- 1 | # InputFiles 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | -------------------------------------------- | 8 | | `content` | *Union[bytes, IO[bytes], io.BufferedReader]* | :heavy_check_mark: | N/A | 9 | | `content_type` | *Optional[str]* | :heavy_minus_sign: | N/A | 10 | | `file_name` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/jirasourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # JiraSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | 8 | | `boards` | List[*str*] | :heavy_minus_sign: | N/A | 9 | | `cloud` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | 10 | | `download_attachments` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | 11 | | `issues` | List[*str*] | :heavy_minus_sign: | N/A | 12 | | `password` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 13 | | `projects` | List[*str*] | :heavy_minus_sign: | N/A | 14 | | `status_filters` | List[*str*] | :heavy_minus_sign: | N/A | 15 | | `token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 16 | | `url` | *str* | :heavy_check_mark: | N/A | 17 | | `username` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/jirasourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # JiraSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------ | ------------------------ | ------------------------ | ------------------------ | 8 | | `boards` | List[*str*] | :heavy_minus_sign: | N/A | 9 | | `cloud` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | 10 | | `download_attachments` | *OptionalNullable[bool]* | :heavy_minus_sign: | N/A | 11 | | `issues` | List[*str*] | :heavy_minus_sign: | N/A | 12 | | `password` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 13 | | `projects` | List[*str*] | :heavy_minus_sign: | N/A | 14 | | `status_filters` | List[*str*] | :heavy_minus_sign: | N/A | 15 | | `token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 16 | | `url` | *str* | :heavy_check_mark: | N/A | 17 | | `username` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/jobstatus.md: -------------------------------------------------------------------------------- 1 | # JobStatus 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------- | ------------- | 8 | | `SCHEDULED` | SCHEDULED | 9 | | `IN_PROGRESS` | IN_PROGRESS | 10 | | `COMPLETED` | COMPLETED | 11 | | `STOPPED` | STOPPED | 12 | | `FAILED` | FAILED | -------------------------------------------------------------------------------- /docs/models/shared/kafkaclouddestinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # KafkaCloudDestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `batch_size` | *int* | :heavy_check_mark: | N/A | 9 | | `bootstrap_servers` | *str* | :heavy_check_mark: | N/A | 10 | | `group_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `kafka_api_key` | *str* | :heavy_check_mark: | N/A | 12 | | `port` | *int* | :heavy_check_mark: | N/A | 13 | | `secret` | *str* | :heavy_check_mark: | N/A | 14 | | `topic` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/kafkaclouddestinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # KafkaCloudDestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `batch_size` | *Optional[int]* | :heavy_minus_sign: | N/A | 9 | | `bootstrap_servers` | *str* | :heavy_check_mark: | N/A | 10 | | `group_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `kafka_api_key` | *str* | :heavy_check_mark: | N/A | 12 | | `port` | *Optional[int]* | :heavy_minus_sign: | N/A | 13 | | `secret` | *str* | :heavy_check_mark: | N/A | 14 | | `topic` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/kafkacloudsourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # KafkaCloudSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | 8 | | `bootstrap_servers` | *str* | :heavy_check_mark: | N/A | 9 | | `group_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `kafka_api_key` | *str* | :heavy_check_mark: | N/A | 11 | | `num_messages_to_consume` | *int* | :heavy_check_mark: | N/A | 12 | | `port` | *int* | :heavy_check_mark: | N/A | 13 | | `secret` | *str* | :heavy_check_mark: | N/A | 14 | | `topic` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/kafkacloudsourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # KafkaCloudSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------------- | ------------------------- | ------------------------- | ------------------------- | 8 | | `bootstrap_servers` | *str* | :heavy_check_mark: | N/A | 9 | | `group_id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `kafka_api_key` | *str* | :heavy_check_mark: | N/A | 11 | | `num_messages_to_consume` | *Optional[int]* | :heavy_minus_sign: | N/A | 12 | | `port` | *Optional[int]* | :heavy_minus_sign: | N/A | 13 | | `secret` | *str* | :heavy_check_mark: | N/A | 14 | | `topic` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/loc.md: -------------------------------------------------------------------------------- 1 | # Loc 2 | 3 | 4 | ## Supported Types 5 | 6 | ### `str` 7 | 8 | ```python 9 | value: str = /* values here */ 10 | ``` 11 | 12 | ### `int` 13 | 14 | ```python 15 | value: int = /* values here */ 16 | ``` 17 | 18 | -------------------------------------------------------------------------------- /docs/models/shared/milvusdestinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # MilvusDestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `collection_name` | *str* | :heavy_check_mark: | N/A | 9 | | `db_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `password` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `record_id_key` | *str* | :heavy_check_mark: | N/A | 12 | | `token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 13 | | `uri` | *str* | :heavy_check_mark: | N/A | 14 | | `user` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/milvusdestinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # MilvusDestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `collection_name` | *str* | :heavy_check_mark: | N/A | 9 | | `db_name` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `password` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `record_id_key` | *str* | :heavy_check_mark: | N/A | 12 | | `token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 13 | | `uri` | *str* | :heavy_check_mark: | N/A | 14 | | `user` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/mongodbconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # MongoDBConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `collection` | *str* | :heavy_check_mark: | N/A | 9 | | `database` | *str* | :heavy_check_mark: | N/A | 10 | | `uri` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/mongodbconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # MongoDBConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `collection` | *str* | :heavy_check_mark: | N/A | 9 | | `database` | *str* | :heavy_check_mark: | N/A | 10 | | `uri` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/neo4jdestinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # Neo4jDestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `batch_size` | *int* | :heavy_check_mark: | N/A | 9 | | `database` | *str* | :heavy_check_mark: | N/A | 10 | | `password` | *str* | :heavy_check_mark: | N/A | 11 | | `uri` | *str* | :heavy_check_mark: | N/A | 12 | | `username` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/neo4jdestinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # Neo4jDestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `batch_size` | *Optional[int]* | :heavy_minus_sign: | N/A | 9 | | `database` | *str* | :heavy_check_mark: | N/A | 10 | | `password` | *str* | :heavy_check_mark: | N/A | 11 | | `uri` | *str* | :heavy_check_mark: | N/A | 12 | | `username` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/nodefilemetadata.md: -------------------------------------------------------------------------------- 1 | # NodeFileMetadata 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `file_id` | *str* | :heavy_check_mark: | N/A | 9 | | `node_id` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/onedrivedestinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # OneDriveDestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `authority_url` | *str* | :heavy_check_mark: | N/A | 9 | | `client_cred` | *str* | :heavy_check_mark: | N/A | 10 | | `client_id` | *str* | :heavy_check_mark: | N/A | 11 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 12 | | `tenant` | *str* | :heavy_check_mark: | N/A | 13 | | `user_pname` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/onedrivedestinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # OneDriveDestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `authority_url` | *str* | :heavy_check_mark: | N/A | 9 | | `client_cred` | *str* | :heavy_check_mark: | N/A | 10 | | `client_id` | *str* | :heavy_check_mark: | N/A | 11 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 12 | | `tenant` | *str* | :heavy_check_mark: | N/A | 13 | | `user_pname` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/onedrivesourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # OneDriveSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `authority_url` | *str* | :heavy_check_mark: | N/A | 9 | | `client_cred` | *str* | :heavy_check_mark: | N/A | 10 | | `client_id` | *str* | :heavy_check_mark: | N/A | 11 | | `path` | *str* | :heavy_check_mark: | N/A | 12 | | `recursive` | *bool* | :heavy_check_mark: | N/A | 13 | | `tenant` | *str* | :heavy_check_mark: | N/A | 14 | | `user_pname` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/onedrivesourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # OneDriveSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `authority_url` | *str* | :heavy_check_mark: | N/A | 9 | | `client_cred` | *str* | :heavy_check_mark: | N/A | 10 | | `client_id` | *str* | :heavy_check_mark: | N/A | 11 | | `path` | *str* | :heavy_check_mark: | N/A | 12 | | `recursive` | *Optional[bool]* | :heavy_minus_sign: | N/A | 13 | | `tenant` | *str* | :heavy_check_mark: | N/A | 14 | | `user_pname` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/outlooksourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # OutlookSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `authority_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 9 | | `client_cred` | *str* | :heavy_check_mark: | N/A | 10 | | `client_id` | *str* | :heavy_check_mark: | N/A | 11 | | `outlook_folders` | List[*str*] | :heavy_minus_sign: | N/A | 12 | | `recursive` | *bool* | :heavy_check_mark: | N/A | 13 | | `tenant` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 14 | | `user_email` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/outlooksourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # OutlookSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `authority_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 9 | | `client_cred` | *str* | :heavy_check_mark: | N/A | 10 | | `client_id` | *str* | :heavy_check_mark: | N/A | 11 | | `outlook_folders` | List[*str*] | :heavy_minus_sign: | N/A | 12 | | `recursive` | *Optional[bool]* | :heavy_minus_sign: | N/A | 13 | | `tenant` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 14 | | `user_email` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/outputformat.md: -------------------------------------------------------------------------------- 1 | # OutputFormat 2 | 3 | The format of the response. Supported formats are application/json and text/csv. Default: application/json. 4 | 5 | 6 | ## Values 7 | 8 | | Name | Value | 9 | | ------------------ | ------------------ | 10 | | `APPLICATION_JSON` | application/json | 11 | | `TEXT_CSV` | text/csv | -------------------------------------------------------------------------------- /docs/models/shared/pineconedestinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # PineconeDestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `api_key` | *str* | :heavy_check_mark: | N/A | 9 | | `batch_size` | *int* | :heavy_check_mark: | N/A | 10 | | `index_name` | *str* | :heavy_check_mark: | N/A | 11 | | `namespace` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/pineconedestinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # PineconeDestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `api_key` | *str* | :heavy_check_mark: | N/A | 9 | | `batch_size` | *Optional[int]* | :heavy_minus_sign: | N/A | 10 | | `index_name` | *str* | :heavy_check_mark: | N/A | 11 | | `namespace` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/postgresdestinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # PostgresDestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `batch_size` | *int* | :heavy_check_mark: | N/A | 9 | | `database` | *str* | :heavy_check_mark: | N/A | 10 | | `host` | *str* | :heavy_check_mark: | N/A | 11 | | `password` | *str* | :heavy_check_mark: | N/A | 12 | | `port` | *int* | :heavy_check_mark: | N/A | 13 | | `table_name` | *str* | :heavy_check_mark: | N/A | 14 | | `username` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/postgresdestinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # PostgresDestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `batch_size` | *int* | :heavy_check_mark: | N/A | 9 | | `database` | *str* | :heavy_check_mark: | N/A | 10 | | `host` | *str* | :heavy_check_mark: | N/A | 11 | | `password` | *str* | :heavy_check_mark: | N/A | 12 | | `port` | *int* | :heavy_check_mark: | N/A | 13 | | `table_name` | *str* | :heavy_check_mark: | N/A | 14 | | `username` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/postgressourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # PostgresSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `batch_size` | *int* | :heavy_check_mark: | N/A | 9 | | `database` | *str* | :heavy_check_mark: | N/A | 10 | | `fields` | List[*str*] | :heavy_minus_sign: | N/A | 11 | | `host` | *str* | :heavy_check_mark: | N/A | 12 | | `id_column` | *str* | :heavy_check_mark: | N/A | 13 | | `password` | *str* | :heavy_check_mark: | N/A | 14 | | `port` | *int* | :heavy_check_mark: | N/A | 15 | | `table_name` | *str* | :heavy_check_mark: | N/A | 16 | | `username` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/postgressourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # PostgresSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `batch_size` | *int* | :heavy_check_mark: | N/A | 9 | | `database` | *str* | :heavy_check_mark: | N/A | 10 | | `fields` | List[*str*] | :heavy_minus_sign: | N/A | 11 | | `host` | *str* | :heavy_check_mark: | N/A | 12 | | `id_column` | *Optional[str]* | :heavy_minus_sign: | N/A | 13 | | `password` | *str* | :heavy_check_mark: | N/A | 14 | | `port` | *int* | :heavy_check_mark: | N/A | 15 | | `table_name` | *str* | :heavy_check_mark: | N/A | 16 | | `username` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/qdrantclouddestinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # QdrantCloudDestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `api_key` | *str* | :heavy_check_mark: | N/A | 9 | | `batch_size` | *int* | :heavy_check_mark: | N/A | 10 | | `collection_name` | *str* | :heavy_check_mark: | N/A | 11 | | `url` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/qdrantclouddestinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # QdrantCloudDestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `api_key` | *str* | :heavy_check_mark: | N/A | 9 | | `batch_size` | *Optional[int]* | :heavy_minus_sign: | N/A | 10 | | `collection_name` | *str* | :heavy_check_mark: | N/A | 11 | | `url` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/redisdestinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # RedisDestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `batch_size` | *int* | :heavy_check_mark: | N/A | 9 | | `database` | *int* | :heavy_check_mark: | N/A | 10 | | `host` | *str* | :heavy_check_mark: | N/A | 11 | | `password` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 12 | | `port` | *int* | :heavy_check_mark: | N/A | 13 | | `ssl` | *bool* | :heavy_check_mark: | N/A | 14 | | `uri` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 15 | | `username` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/redisdestinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # RedisDestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `batch_size` | *Optional[int]* | :heavy_minus_sign: | N/A | 9 | | `database` | *Optional[int]* | :heavy_minus_sign: | N/A | 10 | | `host` | *str* | :heavy_check_mark: | N/A | 11 | | `password` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 12 | | `port` | *Optional[int]* | :heavy_minus_sign: | N/A | 13 | | `ssl` | *Optional[bool]* | :heavy_minus_sign: | N/A | 14 | | `uri` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 15 | | `username` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/s3destinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # S3DestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `anonymous` | *bool* | :heavy_check_mark: | N/A | 9 | | `endpoint_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 12 | | `secret` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 13 | | `token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/s3destinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # S3DestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `anonymous` | *Optional[bool]* | :heavy_minus_sign: | N/A | 9 | | `endpoint_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 12 | | `secret` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 13 | | `token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/s3sourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # S3SourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `anonymous` | *bool* | :heavy_check_mark: | N/A | 9 | | `endpoint_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `recursive` | *bool* | :heavy_check_mark: | N/A | 12 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 13 | | `secret` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 14 | | `token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/s3sourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # S3SourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `anonymous` | *Optional[bool]* | :heavy_minus_sign: | N/A | 9 | | `endpoint_url` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 10 | | `key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 11 | | `recursive` | *Optional[bool]* | :heavy_minus_sign: | N/A | 12 | | `remote_url` | *str* | :heavy_check_mark: | N/A | 13 | | `secret` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 14 | | `token` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/salesforcesourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # SalesforceSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `categories` | List[*str*] | :heavy_check_mark: | N/A | 9 | | `consumer_key` | *str* | :heavy_check_mark: | N/A | 10 | | `private_key` | *str* | :heavy_check_mark: | N/A | 11 | | `username` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/salesforcesourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # SalesforceSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `categories` | List[*str*] | :heavy_check_mark: | N/A | 9 | | `consumer_key` | *str* | :heavy_check_mark: | N/A | 10 | | `private_key` | *str* | :heavy_check_mark: | N/A | 11 | | `username` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/schedule.md: -------------------------------------------------------------------------------- 1 | # Schedule 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------------ | ------------------ | 8 | | `EVERY_15_MINUTES` | every 15 minutes | 9 | | `EVERY_HOUR` | every hour | 10 | | `EVERY_2_HOURS` | every 2 hours | 11 | | `EVERY_4_HOURS` | every 4 hours | 12 | | `EVERY_6_HOURS` | every 6 hours | 13 | | `EVERY_8_HOURS` | every 8 hours | 14 | | `EVERY_10_HOURS` | every 10 hours | 15 | | `EVERY_12_HOURS` | every 12 hours | 16 | | `DAILY` | daily | 17 | | `WEEKLY` | weekly | 18 | | `MONTHLY` | monthly | -------------------------------------------------------------------------------- /docs/models/shared/security.md: -------------------------------------------------------------------------------- 1 | # Security 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | Example | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `api_key_auth` | *Optional[str]* | :heavy_minus_sign: | N/A | YOUR_API_KEY | -------------------------------------------------------------------------------- /docs/models/shared/sharepointsourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # SharePointSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `authority_url` | *Optional[str]* | :heavy_minus_sign: | N/A | 9 | | `client_cred` | *str* | :heavy_check_mark: | N/A | 10 | | `client_id` | *str* | :heavy_check_mark: | N/A | 11 | | `path` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 12 | | `recursive` | *bool* | :heavy_check_mark: | N/A | 13 | | `site` | *str* | :heavy_check_mark: | N/A | 14 | | `tenant` | *str* | :heavy_check_mark: | N/A | 15 | | `user_pname` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/sharepointsourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # SharePointSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `authority_url` | *Optional[str]* | :heavy_minus_sign: | N/A | 9 | | `client_cred` | *str* | :heavy_check_mark: | N/A | 10 | | `client_id` | *str* | :heavy_check_mark: | N/A | 11 | | `path` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 12 | | `recursive` | *Optional[bool]* | :heavy_minus_sign: | N/A | 13 | | `site` | *str* | :heavy_check_mark: | N/A | 14 | | `tenant` | *str* | :heavy_check_mark: | N/A | 15 | | `user_pname` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/snowflakedestinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # SnowflakeDestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `account` | *str* | :heavy_check_mark: | N/A | 9 | | `batch_size` | *Optional[int]* | :heavy_minus_sign: | N/A | 10 | | `database` | *str* | :heavy_check_mark: | N/A | 11 | | `host` | *str* | :heavy_check_mark: | N/A | 12 | | `password` | *str* | :heavy_check_mark: | N/A | 13 | | `port` | *Optional[int]* | :heavy_minus_sign: | N/A | 14 | | `record_id_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 15 | | `role` | *str* | :heavy_check_mark: | N/A | 16 | | `schema_` | *Optional[str]* | :heavy_minus_sign: | N/A | 17 | | `table_name` | *Optional[str]* | :heavy_minus_sign: | N/A | 18 | | `user` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/snowflakedestinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # SnowflakeDestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `account` | *str* | :heavy_check_mark: | N/A | 9 | | `batch_size` | *Optional[int]* | :heavy_minus_sign: | N/A | 10 | | `database` | *str* | :heavy_check_mark: | N/A | 11 | | `host` | *str* | :heavy_check_mark: | N/A | 12 | | `password` | *str* | :heavy_check_mark: | N/A | 13 | | `port` | *Optional[int]* | :heavy_minus_sign: | N/A | 14 | | `record_id_key` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 15 | | `role` | *str* | :heavy_check_mark: | N/A | 16 | | `schema_` | *Optional[str]* | :heavy_minus_sign: | N/A | 17 | | `table_name` | *Optional[str]* | :heavy_minus_sign: | N/A | 18 | | `user` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/snowflakesourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # SnowflakeSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `account` | *str* | :heavy_check_mark: | N/A | 9 | | `batch_size` | *Optional[int]* | :heavy_minus_sign: | N/A | 10 | | `database` | *str* | :heavy_check_mark: | N/A | 11 | | `fields` | List[*str*] | :heavy_minus_sign: | N/A | 12 | | `host` | *str* | :heavy_check_mark: | N/A | 13 | | `id_column` | *str* | :heavy_check_mark: | N/A | 14 | | `password` | *str* | :heavy_check_mark: | N/A | 15 | | `port` | *Optional[int]* | :heavy_minus_sign: | N/A | 16 | | `role` | *str* | :heavy_check_mark: | N/A | 17 | | `schema_` | *Optional[str]* | :heavy_minus_sign: | N/A | 18 | | `table_name` | *str* | :heavy_check_mark: | N/A | 19 | | `user` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/snowflakesourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # SnowflakeSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ------------------ | ------------------ | ------------------ | ------------------ | 8 | | `account` | *str* | :heavy_check_mark: | N/A | 9 | | `batch_size` | *Optional[int]* | :heavy_minus_sign: | N/A | 10 | | `database` | *str* | :heavy_check_mark: | N/A | 11 | | `fields` | List[*str*] | :heavy_minus_sign: | N/A | 12 | | `host` | *str* | :heavy_check_mark: | N/A | 13 | | `id_column` | *str* | :heavy_check_mark: | N/A | 14 | | `password` | *str* | :heavy_check_mark: | N/A | 15 | | `port` | *Optional[int]* | :heavy_minus_sign: | N/A | 16 | | `role` | *str* | :heavy_check_mark: | N/A | 17 | | `schema_` | *Optional[str]* | :heavy_minus_sign: | N/A | 18 | | `table_name` | *str* | :heavy_check_mark: | N/A | 19 | | `user` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/sourceconnectortype.md: -------------------------------------------------------------------------------- 1 | # SourceConnectorType 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | -------------------- | -------------------- | 8 | | `AZURE` | azure | 9 | | `BOX` | box | 10 | | `CONFLUENCE` | confluence | 11 | | `COUCHBASE` | couchbase | 12 | | `DATABRICKS_VOLUMES` | databricks_volumes | 13 | | `DROPBOX` | dropbox | 14 | | `ELASTICSEARCH` | elasticsearch | 15 | | `GCS` | gcs | 16 | | `GOOGLE_DRIVE` | google_drive | 17 | | `KAFKA_CLOUD` | kafka-cloud | 18 | | `MONGODB` | mongodb | 19 | | `ONEDRIVE` | onedrive | 20 | | `OUTLOOK` | outlook | 21 | | `POSTGRES` | postgres | 22 | | `S3` | s3 | 23 | | `SALESFORCE` | salesforce | 24 | | `SHAREPOINT` | sharepoint | 25 | | `SNOWFLAKE` | snowflake | 26 | | `JIRA` | jira | 27 | | `ZENDESK` | zendesk | -------------------------------------------------------------------------------- /docs/models/shared/strategy.md: -------------------------------------------------------------------------------- 1 | # Strategy 2 | 3 | The strategy to use for partitioning PDF/image. Options are fast, hi_res, auto. Default: hi_res 4 | 5 | 6 | ## Values 7 | 8 | | Name | Value | 9 | | ---------- | ---------- | 10 | | `FAST` | fast | 11 | | `HI_RES` | hi_res | 12 | | `AUTO` | auto | 13 | | `OCR_ONLY` | ocr_only | 14 | | `OD_ONLY` | od_only | 15 | | `VLM` | vlm | -------------------------------------------------------------------------------- /docs/models/shared/updatedestinationconnector.md: -------------------------------------------------------------------------------- 1 | # UpdateDestinationConnector 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | 8 | | `config` | [shared.UpdateDestinationConnectorConfig](../../models/shared/updatedestinationconnectorconfig.md) | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/updatesourceconnector.md: -------------------------------------------------------------------------------- 1 | # UpdateSourceConnector 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------- | 8 | | `config` | [shared.UpdateSourceConnectorConfig](../../models/shared/updatesourceconnectorconfig.md) | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/updateworkflowschedule.md: -------------------------------------------------------------------------------- 1 | # UpdateWorkflowSchedule 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------------ | ------------------ | 8 | | `EVERY_15_MINUTES` | every 15 minutes | 9 | | `EVERY_HOUR` | every hour | 10 | | `EVERY_2_HOURS` | every 2 hours | 11 | | `EVERY_4_HOURS` | every 4 hours | 12 | | `EVERY_6_HOURS` | every 6 hours | 13 | | `EVERY_8_HOURS` | every 8 hours | 14 | | `EVERY_10_HOURS` | every 10 hours | 15 | | `EVERY_12_HOURS` | every 12 hours | 16 | | `DAILY` | daily | 17 | | `WEEKLY` | weekly | 18 | | `MONTHLY` | monthly | -------------------------------------------------------------------------------- /docs/models/shared/validationerror.md: -------------------------------------------------------------------------------- 1 | # ValidationError 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | ---------------------------------------------- | 8 | | `loc` | List[[shared.Loc](../../models/shared/loc.md)] | :heavy_check_mark: | N/A | 9 | | `msg` | *str* | :heavy_check_mark: | N/A | 10 | | `type` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/vlmmodel.md: -------------------------------------------------------------------------------- 1 | # VLMModel 2 | 3 | The VLM Model to use. 4 | 5 | 6 | ## Values 7 | 8 | | Name | Value | 9 | | ---------------------------------------------- | ---------------------------------------------- | 10 | | `CLAUDE_3_5_SONNET_20241022` | claude-3-5-sonnet-20241022 | 11 | | `CLAUDE_3_7_SONNET_20250219` | claude-3-7-sonnet-20250219 | 12 | | `GPT_4O` | gpt-4o | 13 | | `GEMINI_1_5_PRO` | gemini-1.5-pro | 14 | | `US_AMAZON_NOVA_PRO_V1_0` | us.amazon.nova-pro-v1:0 | 15 | | `US_AMAZON_NOVA_LITE_V1_0` | us.amazon.nova-lite-v1:0 | 16 | | `US_ANTHROPIC_CLAUDE_3_5_SONNET_20241022_V2_0` | us.anthropic.claude-3-5-sonnet-20241022-v2:0 | 17 | | `US_ANTHROPIC_CLAUDE_3_OPUS_20240229_V1_0` | us.anthropic.claude-3-opus-20240229-v1:0 | 18 | | `US_ANTHROPIC_CLAUDE_3_HAIKU_20240307_V1_0` | us.anthropic.claude-3-haiku-20240307-v1:0 | 19 | | `US_ANTHROPIC_CLAUDE_3_SONNET_20240229_V1_0` | us.anthropic.claude-3-sonnet-20240229-v1:0 | 20 | | `US_META_LLAMA3_2_90B_INSTRUCT_V1_0` | us.meta.llama3-2-90b-instruct-v1:0 | 21 | | `US_META_LLAMA3_2_11B_INSTRUCT_V1_0` | us.meta.llama3-2-11b-instruct-v1:0 | 22 | | `GEMINI_2_0_FLASH_001` | gemini-2.0-flash-001 | -------------------------------------------------------------------------------- /docs/models/shared/vlmmodelprovider.md: -------------------------------------------------------------------------------- 1 | # VLMModelProvider 2 | 3 | The VLM Model provider to use. 4 | 5 | 6 | ## Values 7 | 8 | | Name | Value | 9 | | ------------------- | ------------------- | 10 | | `OPENAI` | openai | 11 | | `ANTHROPIC` | anthropic | 12 | | `BEDROCK` | bedrock | 13 | | `ANTHROPIC_BEDROCK` | anthropic_bedrock | 14 | | `VERTEXAI` | vertexai | 15 | | `GOOGLE` | google | 16 | | `AZURE_OPENAI` | azure_openai | -------------------------------------------------------------------------------- /docs/models/shared/weaviatedestinationconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # WeaviateDestinationConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `api_key` | *str* | :heavy_check_mark: | N/A | 9 | | `cluster_url` | *str* | :heavy_check_mark: | N/A | 10 | | `collection` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/weaviatedestinationconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # WeaviateDestinationConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `api_key` | *str* | :heavy_check_mark: | N/A | 9 | | `cluster_url` | *str* | :heavy_check_mark: | N/A | 10 | | `collection` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/workflowjobtype.md: -------------------------------------------------------------------------------- 1 | # WorkflowJobType 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ------------ | ------------ | 8 | | `EPHEMERAL` | ephemeral | 9 | | `PERSISTENT` | persistent | 10 | | `SCHEDULED` | scheduled | -------------------------------------------------------------------------------- /docs/models/shared/workflownode.md: -------------------------------------------------------------------------------- 1 | # WorkflowNode 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `id` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 9 | | `name` | *str* | :heavy_check_mark: | N/A | 10 | | `settings` | Dict[str, *Any*] | :heavy_minus_sign: | N/A | 11 | | `subtype` | *str* | :heavy_check_mark: | N/A | 12 | | `type` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/workflownodetype.md: -------------------------------------------------------------------------------- 1 | # WorkflowNodeType 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ----------- | ----------- | 8 | | `PARTITION` | partition | 9 | | `PROMPTER` | prompter | 10 | | `CHUNK` | chunk | 11 | | `EMBED` | embed | -------------------------------------------------------------------------------- /docs/models/shared/workflowschedule.md: -------------------------------------------------------------------------------- 1 | # WorkflowSchedule 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | ---------------------------------------------------------------- | 8 | | `crontab_entries` | List[[shared.CronTabEntry](../../models/shared/crontabentry.md)] | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/workflowstate.md: -------------------------------------------------------------------------------- 1 | # WorkflowState 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ---------- | ---------- | 8 | | `ACTIVE` | active | 9 | | `INACTIVE` | inactive | -------------------------------------------------------------------------------- /docs/models/shared/workflowtype.md: -------------------------------------------------------------------------------- 1 | # WorkflowType 2 | 3 | 4 | ## Values 5 | 6 | | Name | Value | 7 | | ---------- | ---------- | 8 | | `BASIC` | basic | 9 | | `ADVANCED` | advanced | 10 | | `PLATINUM` | platinum | 11 | | `CUSTOM` | custom | -------------------------------------------------------------------------------- /docs/models/shared/zendesksourceconnectorconfig.md: -------------------------------------------------------------------------------- 1 | # ZendeskSourceConnectorConfig 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `api_token` | *str* | :heavy_check_mark: | N/A | 9 | | `batch_size` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 10 | | `email` | *str* | :heavy_check_mark: | N/A | 11 | | `item_type` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 12 | | `subdomain` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/shared/zendesksourceconnectorconfiginput.md: -------------------------------------------------------------------------------- 1 | # ZendeskSourceConnectorConfigInput 2 | 3 | 4 | ## Fields 5 | 6 | | Field | Type | Required | Description | 7 | | ----------------------- | ----------------------- | ----------------------- | ----------------------- | 8 | | `api_token` | *str* | :heavy_check_mark: | N/A | 9 | | `batch_size` | *OptionalNullable[int]* | :heavy_minus_sign: | N/A | 10 | | `email` | *str* | :heavy_check_mark: | N/A | 11 | | `item_type` | *OptionalNullable[str]* | :heavy_minus_sign: | N/A | 12 | | `subdomain` | *str* | :heavy_check_mark: | N/A | -------------------------------------------------------------------------------- /docs/models/utils/retryconfig.md: -------------------------------------------------------------------------------- 1 | # RetryConfig 2 | 3 | Allows customizing the default retry configuration. Only usable with methods that mention they support retries. 4 | 5 | ## Fields 6 | 7 | | Name | Type | Description | Example | 8 | | ------------------------- | ----------------------------------- | --------------------------------------- | --------- | 9 | | `strategy` | `*str*` | The retry strategy to use. | `backoff` | 10 | | `backoff` | [BackoffStrategy](#backoffstrategy) | Configuration for the backoff strategy. | | 11 | | `retry_connection_errors` | `*bool*` | Whether to retry on connection errors. | `true` | 12 | 13 | ## BackoffStrategy 14 | 15 | The backoff strategy allows retrying a request with an exponential backoff between each retry. 16 | 17 | ### Fields 18 | 19 | | Name | Type | Description | Example | 20 | | ------------------ | --------- | ----------------------------------------- | -------- | 21 | | `initial_interval` | `*int*` | The initial interval in milliseconds. | `500` | 22 | | `max_interval` | `*int*` | The maximum interval in milliseconds. | `60000` | 23 | | `exponent` | `*float*` | The exponent to use for the backoff. | `1.5` | 24 | | `max_elapsed_time` | `*int*` | The maximum elapsed time in milliseconds. | `300000` | -------------------------------------------------------------------------------- /docs/sdks/unstructuredclient/README.md: -------------------------------------------------------------------------------- 1 | # UnstructuredClient SDK 2 | 3 | ## Overview 4 | 5 | ### Available Operations 6 | -------------------------------------------------------------------------------- /files.gen: -------------------------------------------------------------------------------- 1 | src/unstructured_client/sdkconfiguration.py 2 | src/unstructured_client/general.py 3 | src/unstructured_client/sdk.py 4 | pylintrc 5 | setup.py 6 | src/unstructured_client/__init__.py 7 | src/unstructured_client/utils/__init__.py 8 | src/unstructured_client/utils/retries.py 9 | src/unstructured_client/utils/utils.py 10 | src/unstructured_client/models/errors/sdkerror.py 11 | tests/helpers.py 12 | src/unstructured_client/models/operations/partition.py 13 | src/unstructured_client/models/errors/httpvalidationerror.py 14 | src/unstructured_client/models/shared/validationerror.py 15 | src/unstructured_client/models/shared/partition_parameters.py 16 | src/unstructured_client/models/shared/security.py 17 | src/unstructured_client/models/__init__.py 18 | src/unstructured_client/models/errors/__init__.py 19 | src/unstructured_client/models/operations/__init__.py 20 | src/unstructured_client/models/shared/__init__.py 21 | docs/models/operations/partitionresponse.md 22 | docs/models/errors/httpvalidationerror.md 23 | docs/models/shared/loc.md 24 | docs/models/shared/validationerror.md 25 | docs/models/shared/files.md 26 | docs/models/shared/partitionparameters.md 27 | docs/models/shared/security.md 28 | USAGE.md 29 | .gitattributes -------------------------------------------------------------------------------- /poetry.toml: -------------------------------------------------------------------------------- 1 | [virtualenvs] 2 | in-project = true 3 | -------------------------------------------------------------------------------- /py.typed: -------------------------------------------------------------------------------- 1 | # Marker file for PEP 561. The package enables type hints. 2 | -------------------------------------------------------------------------------- /pyproject.toml: -------------------------------------------------------------------------------- 1 | [project] 2 | name = "unstructured-client" 3 | version = "0.36.0" 4 | description = "Python Client SDK for Unstructured API" 5 | authors = [{ name = "Unstructured" },] 6 | readme = "README-PYPI.md" 7 | requires-python = ">=3.9.2" 8 | dependencies = [ 9 | "aiofiles >=24.1.0", 10 | "cryptography >=3.1", 11 | "httpx >=0.27.0", 12 | "nest-asyncio >=1.6.0", 13 | "pydantic >=2.11.2", 14 | "pypdf >=4.0", 15 | "requests-toolbelt >=1.0.0", 16 | ] 17 | 18 | [tool.poetry] 19 | repository = "https://github.com/Unstructured-IO/unstructured-python-client.git" 20 | license = "MIT" 21 | packages = [ 22 | { include = "unstructured_client", from = "src" } 23 | ] 24 | include = ["py.typed", "src/unstructured_client/py.typed"] 25 | 26 | [tool.setuptools.package-data] 27 | "*" = ["py.typed", "src/unstructured_client/py.typed"] 28 | 29 | [virtualenvs] 30 | in-project = true 31 | 32 | [tool.poetry.group.dev.dependencies] 33 | deepdiff = ">=6.0" 34 | freezegun = ">=1.5.1" 35 | mypy = "==1.15.0" 36 | pylint = "==3.2.3" 37 | pytest = ">=8.3.3" 38 | pytest-asyncio = ">=0.24.0" 39 | pytest-httpx = ">=0.35.0" 40 | pytest-mock = ">=3.14.0" 41 | pytest-xdist = "^3.5.0" 42 | types-aiofiles = ">=24.1.0" 43 | uvloop = ">=0.20.0" 44 | 45 | [build-system] 46 | requires = ["poetry-core"] 47 | build-backend = "poetry.core.masonry.api" 48 | 49 | [tool.pytest.ini_options] 50 | asyncio_default_fixture_loop_scope = "function" 51 | pythonpath = ["src"] 52 | 53 | [tool.mypy] 54 | disable_error_code = "misc" 55 | 56 | [[tool.mypy.overrides]] 57 | module = "typing_inspect" 58 | ignore_missing_imports = true 59 | 60 | [[tool.mypy.overrides]] 61 | module = "jsonpath" 62 | ignore_missing_imports = true 63 | 64 | [tool.pyright] 65 | venvPath = "." 66 | venv = ".venv" 67 | 68 | 69 | -------------------------------------------------------------------------------- /scripts/prepare_readme.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | import re 4 | import shutil 5 | 6 | try: 7 | with open("README.md", "r", encoding="utf-8") as rh: 8 | readme_contents = rh.read() 9 | GITHUB_URL = "https://github.com/Unstructured-IO/unstructured-python-client.git" 10 | GITHUB_URL = ( 11 | GITHUB_URL[: -len(".git")] if GITHUB_URL.endswith(".git") else GITHUB_URL 12 | ) 13 | # links on PyPI should have absolute URLs 14 | readme_contents = re.sub( 15 | r"(\[[^\]]+\]\()((?!https?:)[^\)]+)(\))", 16 | lambda m: m.group(1) 17 | + GITHUB_URL 18 | + "/blob/master/" 19 | + m.group(2) 20 | + m.group(3), 21 | readme_contents, 22 | ) 23 | 24 | with open("README-PYPI.md", "w", encoding="utf-8") as wh: 25 | wh.write(readme_contents) 26 | except Exception as e: 27 | try: 28 | print("Failed to rewrite README.md to README-PYPI.md, copying original instead") 29 | print(e) 30 | shutil.copyfile("README.md", "README-PYPI.md") 31 | except Exception as ie: 32 | print("Failed to copy README.md to README-PYPI.md") 33 | print(ie) 34 | -------------------------------------------------------------------------------- /scripts/publish.sh: -------------------------------------------------------------------------------- 1 | #!/usr/bin/env bash 2 | 3 | export POETRY_PYPI_TOKEN_PYPI=${PYPI_TOKEN} 4 | 5 | poetry run python scripts/prepare_readme.py 6 | 7 | poetry publish --build --skip-existing 8 | -------------------------------------------------------------------------------- /src/unstructured_client/__init__.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from ._version import ( 4 | __title__, 5 | __version__, 6 | __openapi_doc_version__, 7 | __gen_version__, 8 | __user_agent__, 9 | ) 10 | from .sdk import * 11 | from .sdkconfiguration import * 12 | 13 | 14 | VERSION: str = __version__ 15 | OPENAPI_DOC_VERSION = __openapi_doc_version__ 16 | SPEAKEASY_GENERATOR_VERSION = __gen_version__ 17 | USER_AGENT = __user_agent__ 18 | -------------------------------------------------------------------------------- /src/unstructured_client/_hooks/__init__.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from .sdkhooks import * 4 | from .types import * 5 | from .registration import * 6 | -------------------------------------------------------------------------------- /src/unstructured_client/_hooks/custom/__init__.py: -------------------------------------------------------------------------------- 1 | from .clean_server_url_hook import CleanServerUrlSDKInitHook 2 | from .logger_hook import LoggerHook 3 | from .split_pdf_hook import SplitPdfHook 4 | import logging 5 | -------------------------------------------------------------------------------- /src/unstructured_client/_hooks/custom/clean_server_url_hook.py: -------------------------------------------------------------------------------- 1 | from __future__ import annotations 2 | 3 | from typing import Tuple 4 | from urllib.parse import ParseResult, urlparse, urlunparse 5 | 6 | from unstructured_client._hooks.types import SDKInitHook 7 | from unstructured_client.httpclient import HttpClient 8 | 9 | 10 | def clean_server_url(base_url: str) -> str: 11 | """Fix url scheme and remove subpath for URLs under Unstructured domains.""" 12 | 13 | if not base_url: 14 | return "" 15 | 16 | # add a url scheme if not present (urllib.parse does not work reliably without it) 17 | if "http" not in base_url: 18 | base_url = "http://" + base_url 19 | 20 | parsed_url: ParseResult = urlparse(base_url) 21 | 22 | if "unstructuredapp.io" in parsed_url.netloc: 23 | if parsed_url.scheme != "https": 24 | parsed_url = parsed_url._replace(scheme="https") 25 | # We only want the base url for Unstructured domains 26 | clean_url = urlunparse(parsed_url._replace(path="", params="", query="", fragment="")) 27 | 28 | else: 29 | # For other domains, we want to keep the path 30 | clean_url = urlunparse(parsed_url._replace(params="", query="", fragment="")) 31 | 32 | return clean_url.rstrip("/") 33 | 34 | 35 | 36 | class CleanServerUrlSDKInitHook(SDKInitHook): 37 | """Hook fixing common mistakes by users in defining `server_url` in the unstructured-client""" 38 | 39 | def sdk_init( 40 | self, base_url: str, client: HttpClient 41 | ) -> Tuple[str, HttpClient]: 42 | """Concrete implementation for SDKInitHook.""" 43 | cleaned_url = clean_server_url(base_url) 44 | 45 | return cleaned_url, client 46 | -------------------------------------------------------------------------------- /src/unstructured_client/_hooks/custom/common.py: -------------------------------------------------------------------------------- 1 | UNSTRUCTURED_CLIENT_LOGGER_NAME = "unstructured-client" 2 | -------------------------------------------------------------------------------- /src/unstructured_client/_hooks/custom/pdf_utils.py: -------------------------------------------------------------------------------- 1 | from __future__ import annotations 2 | 3 | import io 4 | import logging 5 | from typing import cast, Optional, BinaryIO, Union 6 | 7 | from pypdf import PdfReader 8 | from pypdf.errors import PdfReadError 9 | 10 | from unstructured_client._hooks.custom.common import UNSTRUCTURED_CLIENT_LOGGER_NAME 11 | 12 | logger = logging.getLogger(UNSTRUCTURED_CLIENT_LOGGER_NAME) 13 | 14 | # Loading pdfs with strict=False can dump a lot of warnings 15 | # We don't need to display these 16 | pdf_logger = logging.getLogger("pypdf") 17 | pdf_logger.setLevel(logging.ERROR) 18 | 19 | def read_pdf(pdf_file: Union[BinaryIO, bytes]) -> Optional[PdfReader]: 20 | """Reads the given PDF file. 21 | 22 | Args: 23 | pdf_file: The PDF file to be read. 24 | 25 | Returns: 26 | The PdfReader object if the file is a PDF, None otherwise. 27 | """ 28 | 29 | try: 30 | if isinstance(pdf_file, bytes): 31 | content = cast(bytes, pdf_file) 32 | pdf_file = io.BytesIO(content) 33 | return PdfReader(pdf_file, strict=False) 34 | except (PdfReadError, UnicodeDecodeError): 35 | return None 36 | -------------------------------------------------------------------------------- /src/unstructured_client/_hooks/registration.py: -------------------------------------------------------------------------------- 1 | """Registration of custom, human-written hooks.""" 2 | 3 | from .custom import ( 4 | CleanServerUrlSDKInitHook, 5 | LoggerHook, 6 | SplitPdfHook, 7 | ) 8 | from .types import Hooks 9 | 10 | 11 | # This file is only ever generated once on the first generation and then is free to be modified. 12 | # Any hooks you wish to add should be registered in the init_hooks function. Feel free to define 13 | # them in this file or in separate files in the hooks folder. 14 | 15 | 16 | def init_hooks(hooks: Hooks): 17 | # pylint: disable=unused-argument 18 | """Add hooks by calling `hooks.register__hook` with an instance of that hook. 19 | 20 | Hooks are registered per SDK instance, and are valid for the lifetime of the SDK instance 21 | """ 22 | 23 | # Initialize custom hooks 24 | clean_server_url_hook = CleanServerUrlSDKInitHook() 25 | logger_hook = LoggerHook() 26 | split_pdf_hook = SplitPdfHook() 27 | 28 | # NOTE: logger_hook should stay registered last as logs the status of 29 | # request and whether it will be retried which can be changed by e.g. split_pdf_hook 30 | 31 | # Register SDK Init hooks 32 | hooks.register_sdk_init_hook(clean_server_url_hook) 33 | hooks.register_sdk_init_hook(logger_hook) 34 | hooks.register_sdk_init_hook(split_pdf_hook) 35 | 36 | # Register Before Request hooks 37 | hooks.register_before_request_hook(split_pdf_hook) 38 | 39 | # Register After Error hooks 40 | hooks.register_after_success_hook(split_pdf_hook) 41 | hooks.register_after_success_hook(logger_hook) 42 | 43 | # Register After Error hooks 44 | hooks.register_after_error_hook(split_pdf_hook) 45 | hooks.register_after_error_hook(logger_hook) 46 | -------------------------------------------------------------------------------- /src/unstructured_client/_version.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | import importlib.metadata 4 | 5 | __title__: str = "unstructured-client" 6 | __version__: str = "0.36.0" 7 | __openapi_doc_version__: str = "1.1.17" 8 | __gen_version__: str = "2.610.0" 9 | __user_agent__: str = "speakeasy-sdk/python 0.36.0 2.610.0 1.1.17 unstructured-client" 10 | 11 | try: 12 | if __package__ is not None: 13 | __version__ = importlib.metadata.version(__package__) 14 | except importlib.metadata.PackageNotFoundError: 15 | pass 16 | -------------------------------------------------------------------------------- /src/unstructured_client/models/__init__.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | # package 4 | -------------------------------------------------------------------------------- /src/unstructured_client/models/errors/__init__.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from typing import TYPE_CHECKING 4 | from importlib import import_module 5 | 6 | if TYPE_CHECKING: 7 | from .httpvalidationerror import ( 8 | Detail, 9 | HTTPValidationError, 10 | HTTPValidationErrorData, 11 | ) 12 | from .sdkerror import SDKError 13 | from .servererror import ServerError, ServerErrorData 14 | 15 | __all__ = [ 16 | "Detail", 17 | "HTTPValidationError", 18 | "HTTPValidationErrorData", 19 | "SDKError", 20 | "ServerError", 21 | "ServerErrorData", 22 | ] 23 | 24 | _dynamic_imports: dict[str, str] = { 25 | "Detail": ".httpvalidationerror", 26 | "HTTPValidationError": ".httpvalidationerror", 27 | "HTTPValidationErrorData": ".httpvalidationerror", 28 | "SDKError": ".sdkerror", 29 | "ServerError": ".servererror", 30 | "ServerErrorData": ".servererror", 31 | } 32 | 33 | 34 | def __getattr__(attr_name: str) -> object: 35 | module_name = _dynamic_imports.get(attr_name) 36 | if module_name is None: 37 | raise AttributeError( 38 | f"No {attr_name} found in _dynamic_imports for module name -> {__name__} " 39 | ) 40 | 41 | try: 42 | module = import_module(module_name, __package__) 43 | result = getattr(module, attr_name) 44 | return result 45 | except ImportError as e: 46 | raise ImportError( 47 | f"Failed to import {attr_name} from {module_name}: {e}" 48 | ) from e 49 | except AttributeError as e: 50 | raise AttributeError( 51 | f"Failed to get {attr_name} from {module_name}: {e}" 52 | ) from e 53 | 54 | 55 | def __dir__(): 56 | lazy_attrs = list(_dynamic_imports.keys()) 57 | return sorted(lazy_attrs) 58 | -------------------------------------------------------------------------------- /src/unstructured_client/models/errors/httpvalidationerror.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import List, Optional, Union 5 | from typing_extensions import TypeAliasType 6 | from unstructured_client import utils 7 | from unstructured_client.models.shared import validationerror as shared_validationerror 8 | from unstructured_client.types import BaseModel 9 | 10 | 11 | DetailTypedDict = TypeAliasType( 12 | "DetailTypedDict", Union[List[shared_validationerror.ValidationErrorTypedDict], str] 13 | ) 14 | 15 | 16 | Detail = TypeAliasType( 17 | "Detail", Union[List[shared_validationerror.ValidationError], str] 18 | ) 19 | 20 | 21 | class HTTPValidationErrorData(BaseModel): 22 | detail: Optional[Detail] = None 23 | 24 | 25 | class HTTPValidationError(Exception): 26 | data: HTTPValidationErrorData 27 | 28 | def __init__(self, data: HTTPValidationErrorData): 29 | self.data = data 30 | 31 | def __str__(self) -> str: 32 | return utils.marshal_json(self.data, HTTPValidationErrorData) 33 | -------------------------------------------------------------------------------- /src/unstructured_client/models/errors/sdkerror.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from dataclasses import dataclass 4 | from typing import Optional 5 | import httpx 6 | 7 | 8 | @dataclass 9 | class SDKError(Exception): 10 | """Represents an error returned by the API.""" 11 | 12 | message: str 13 | status_code: int = -1 14 | body: str = "" 15 | raw_response: Optional[httpx.Response] = None 16 | 17 | def __str__(self): 18 | body = "" 19 | if len(self.body) > 0: 20 | body = f"\n{self.body}" 21 | 22 | return f"{self.message}: Status {self.status_code}{body}" 23 | -------------------------------------------------------------------------------- /src/unstructured_client/models/errors/servererror.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import Optional 5 | from unstructured_client import utils 6 | from unstructured_client.types import BaseModel 7 | 8 | 9 | class ServerErrorData(BaseModel): 10 | detail: Optional[str] = None 11 | 12 | 13 | class ServerError(Exception): 14 | data: ServerErrorData 15 | 16 | def __init__(self, data: ServerErrorData): 17 | self.data = data 18 | 19 | def __str__(self) -> str: 20 | return utils.marshal_json(self.data, ServerErrorData) 21 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/azureaisearchconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class AzureAISearchConnectorConfigTypedDict(TypedDict): 9 | endpoint: str 10 | index: str 11 | key: str 12 | 13 | 14 | class AzureAISearchConnectorConfig(BaseModel): 15 | endpoint: str 16 | 17 | index: str 18 | 19 | key: str 20 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/azureaisearchconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class AzureAISearchConnectorConfigInputTypedDict(TypedDict): 9 | endpoint: str 10 | index: str 11 | key: str 12 | 13 | 14 | class AzureAISearchConnectorConfigInput(BaseModel): 15 | endpoint: str 16 | 17 | index: str 18 | 19 | key: str 20 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/boxsourceconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class BoxSourceConnectorConfigTypedDict(TypedDict): 9 | box_app_config: str 10 | recursive: bool 11 | 12 | 13 | class BoxSourceConnectorConfig(BaseModel): 14 | box_app_config: str 15 | 16 | recursive: bool 17 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/boxsourceconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import Optional 5 | from typing_extensions import NotRequired, TypedDict 6 | from unstructured_client.types import BaseModel 7 | 8 | 9 | class BoxSourceConnectorConfigInputTypedDict(TypedDict): 10 | box_app_config: str 11 | remote_url: str 12 | recursive: NotRequired[bool] 13 | 14 | 15 | class BoxSourceConnectorConfigInput(BaseModel): 16 | box_app_config: str 17 | 18 | remote_url: str 19 | 20 | recursive: Optional[bool] = True 21 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/connectioncheckstatus.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from enum import Enum 5 | 6 | 7 | class ConnectionCheckStatus(str, Enum): 8 | SCHEDULED = "SCHEDULED" 9 | SUCCESS = "SUCCESS" 10 | FAILURE = "FAILURE" 11 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/crontabentry.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class CronTabEntryTypedDict(TypedDict): 9 | cron_expression: str 10 | 11 | 12 | class CronTabEntry(BaseModel): 13 | cron_expression: str 14 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/databricksvolumesconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | import pydantic 5 | from typing import Optional 6 | from typing_extensions import Annotated, NotRequired, TypedDict 7 | from unstructured_client.types import BaseModel 8 | 9 | 10 | class DatabricksVolumesConnectorConfigTypedDict(TypedDict): 11 | catalog: str 12 | client_id: str 13 | client_secret: str 14 | host: str 15 | volume: str 16 | volume_path: str 17 | schema_: NotRequired[str] 18 | 19 | 20 | class DatabricksVolumesConnectorConfig(BaseModel): 21 | catalog: str 22 | 23 | client_id: str 24 | 25 | client_secret: str 26 | 27 | host: str 28 | 29 | volume: str 30 | 31 | volume_path: str 32 | 33 | schema_: Annotated[Optional[str], pydantic.Field(alias="schema")] = "default" 34 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/databricksvolumesconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | import pydantic 5 | from typing import Optional 6 | from typing_extensions import Annotated, NotRequired, TypedDict 7 | from unstructured_client.types import BaseModel 8 | 9 | 10 | class DatabricksVolumesConnectorConfigInputTypedDict(TypedDict): 11 | catalog: str 12 | client_id: str 13 | client_secret: str 14 | host: str 15 | volume: str 16 | volume_path: str 17 | schema_: NotRequired[str] 18 | 19 | 20 | class DatabricksVolumesConnectorConfigInput(BaseModel): 21 | catalog: str 22 | 23 | client_id: str 24 | 25 | client_secret: str 26 | 27 | host: str 28 | 29 | volume: str 30 | 31 | volume_path: str 32 | 33 | schema_: Annotated[Optional[str], pydantic.Field(alias="schema")] = None 34 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/deltatableconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class DeltaTableConnectorConfigTypedDict(TypedDict): 9 | aws_access_key_id: str 10 | aws_region: str 11 | aws_secret_access_key: str 12 | table_uri: str 13 | 14 | 15 | class DeltaTableConnectorConfig(BaseModel): 16 | aws_access_key_id: str 17 | 18 | aws_region: str 19 | 20 | aws_secret_access_key: str 21 | 22 | table_uri: str 23 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/deltatableconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class DeltaTableConnectorConfigInputTypedDict(TypedDict): 9 | aws_access_key_id: str 10 | aws_region: str 11 | aws_secret_access_key: str 12 | table_uri: str 13 | 14 | 15 | class DeltaTableConnectorConfigInput(BaseModel): 16 | aws_access_key_id: str 17 | 18 | aws_region: str 19 | 20 | aws_secret_access_key: str 21 | 22 | table_uri: str 23 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/destinationconnectortype.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from enum import Enum 5 | 6 | 7 | class DestinationConnectorType(str, Enum): 8 | ASTRADB = "astradb" 9 | AZURE_AI_SEARCH = "azure_ai_search" 10 | COUCHBASE = "couchbase" 11 | DATABRICKS_VOLUMES = "databricks_volumes" 12 | DATABRICKS_VOLUME_DELTA_TABLES = "databricks_volume_delta_tables" 13 | DELTA_TABLE = "delta_table" 14 | ELASTICSEARCH = "elasticsearch" 15 | GCS = "gcs" 16 | KAFKA_CLOUD = "kafka-cloud" 17 | MILVUS = "milvus" 18 | MONGODB = "mongodb" 19 | MOTHERDUCK = "motherduck" 20 | NEO4J = "neo4j" 21 | ONEDRIVE = "onedrive" 22 | PINECONE = "pinecone" 23 | POSTGRES = "postgres" 24 | REDIS = "redis" 25 | QDRANT_CLOUD = "qdrant-cloud" 26 | S3 = "s3" 27 | SNOWFLAKE = "snowflake" 28 | WEAVIATE_CLOUD = "weaviate-cloud" 29 | IBM_WATSONX_S3 = "ibm_watsonx_s3" 30 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/dropboxsourceconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class DropboxSourceConnectorConfigTypedDict(TypedDict): 9 | recursive: bool 10 | remote_url: str 11 | token: str 12 | 13 | 14 | class DropboxSourceConnectorConfig(BaseModel): 15 | recursive: bool 16 | 17 | remote_url: str 18 | 19 | token: str 20 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/dropboxsourceconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import Optional 5 | from typing_extensions import NotRequired, TypedDict 6 | from unstructured_client.types import BaseModel 7 | 8 | 9 | class DropboxSourceConnectorConfigInputTypedDict(TypedDict): 10 | remote_url: str 11 | token: str 12 | recursive: NotRequired[bool] 13 | 14 | 15 | class DropboxSourceConnectorConfigInput(BaseModel): 16 | remote_url: str 17 | 18 | token: str 19 | 20 | recursive: Optional[bool] = True 21 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/elasticsearchconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import List 5 | from typing_extensions import TypedDict 6 | from unstructured_client.types import BaseModel 7 | 8 | 9 | class ElasticsearchConnectorConfigTypedDict(TypedDict): 10 | es_api_key: str 11 | hosts: List[str] 12 | index_name: str 13 | 14 | 15 | class ElasticsearchConnectorConfig(BaseModel): 16 | es_api_key: str 17 | 18 | hosts: List[str] 19 | 20 | index_name: str 21 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/elasticsearchconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import List 5 | from typing_extensions import TypedDict 6 | from unstructured_client.types import BaseModel 7 | 8 | 9 | class ElasticsearchConnectorConfigInputTypedDict(TypedDict): 10 | es_api_key: str 11 | hosts: List[str] 12 | index_name: str 13 | 14 | 15 | class ElasticsearchConnectorConfigInput(BaseModel): 16 | es_api_key: str 17 | 18 | hosts: List[str] 19 | 20 | index_name: str 21 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/gcsdestinationconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class GCSDestinationConnectorConfigTypedDict(TypedDict): 9 | remote_url: str 10 | service_account_key: str 11 | 12 | 13 | class GCSDestinationConnectorConfig(BaseModel): 14 | remote_url: str 15 | 16 | service_account_key: str 17 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/gcsdestinationconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class GCSDestinationConnectorConfigInputTypedDict(TypedDict): 9 | remote_url: str 10 | service_account_key: str 11 | 12 | 13 | class GCSDestinationConnectorConfigInput(BaseModel): 14 | remote_url: str 15 | 16 | service_account_key: str 17 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/gcssourceconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class GCSSourceConnectorConfigTypedDict(TypedDict): 9 | recursive: bool 10 | remote_url: str 11 | service_account_key: str 12 | 13 | 14 | class GCSSourceConnectorConfig(BaseModel): 15 | recursive: bool 16 | 17 | remote_url: str 18 | 19 | service_account_key: str 20 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/gcssourceconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import Optional 5 | from typing_extensions import NotRequired, TypedDict 6 | from unstructured_client.types import BaseModel 7 | 8 | 9 | class GCSSourceConnectorConfigInputTypedDict(TypedDict): 10 | remote_url: str 11 | service_account_key: str 12 | recursive: NotRequired[bool] 13 | 14 | 15 | class GCSSourceConnectorConfigInput(BaseModel): 16 | remote_url: str 17 | 18 | service_account_key: str 19 | 20 | recursive: Optional[bool] = True 21 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/ibmwatsonxs3destinationconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class IBMWatsonxS3DestinationConnectorConfigTypedDict(TypedDict): 9 | access_key_id: str 10 | catalog: str 11 | iam_api_key: str 12 | iceberg_endpoint: str 13 | max_retries: int 14 | max_retries_connection: int 15 | namespace: str 16 | object_storage_endpoint: str 17 | object_storage_region: str 18 | record_id_key: str 19 | secret_access_key: str 20 | table: str 21 | 22 | 23 | class IBMWatsonxS3DestinationConnectorConfig(BaseModel): 24 | access_key_id: str 25 | 26 | catalog: str 27 | 28 | iam_api_key: str 29 | 30 | iceberg_endpoint: str 31 | 32 | max_retries: int 33 | 34 | max_retries_connection: int 35 | 36 | namespace: str 37 | 38 | object_storage_endpoint: str 39 | 40 | object_storage_region: str 41 | 42 | record_id_key: str 43 | 44 | secret_access_key: str 45 | 46 | table: str 47 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/ibmwatsonxs3destinationconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import Optional 5 | from typing_extensions import NotRequired, TypedDict 6 | from unstructured_client.types import BaseModel 7 | 8 | 9 | class IBMWatsonxS3DestinationConnectorConfigInputTypedDict(TypedDict): 10 | access_key_id: str 11 | catalog: str 12 | iam_api_key: str 13 | iceberg_endpoint: str 14 | namespace: str 15 | object_storage_endpoint: str 16 | object_storage_region: str 17 | secret_access_key: str 18 | table: str 19 | max_retries: NotRequired[int] 20 | r"""Maximum number of retries to upload data""" 21 | max_retries_connection: NotRequired[int] 22 | r"""Maximum number of retries in case of a connection error""" 23 | record_id_key: NotRequired[str] 24 | r"""Searchable key to find entries for the same record on previous runs""" 25 | 26 | 27 | class IBMWatsonxS3DestinationConnectorConfigInput(BaseModel): 28 | access_key_id: str 29 | 30 | catalog: str 31 | 32 | iam_api_key: str 33 | 34 | iceberg_endpoint: str 35 | 36 | namespace: str 37 | 38 | object_storage_endpoint: str 39 | 40 | object_storage_region: str 41 | 42 | secret_access_key: str 43 | 44 | table: str 45 | 46 | max_retries: Optional[int] = 50 47 | r"""Maximum number of retries to upload data""" 48 | 49 | max_retries_connection: Optional[int] = 10 50 | r"""Maximum number of retries in case of a connection error""" 51 | 52 | record_id_key: Optional[str] = "record_id" 53 | r"""Searchable key to find entries for the same record on previous runs""" 54 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/jobstatus.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from enum import Enum 5 | 6 | 7 | class JobStatus(str, Enum): 8 | SCHEDULED = "SCHEDULED" 9 | IN_PROGRESS = "IN_PROGRESS" 10 | COMPLETED = "COMPLETED" 11 | STOPPED = "STOPPED" 12 | FAILED = "FAILED" 13 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/mongodbconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class MongoDBConnectorConfigTypedDict(TypedDict): 9 | collection: str 10 | database: str 11 | uri: str 12 | 13 | 14 | class MongoDBConnectorConfig(BaseModel): 15 | collection: str 16 | 17 | database: str 18 | 19 | uri: str 20 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/mongodbconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class MongoDBConnectorConfigInputTypedDict(TypedDict): 9 | collection: str 10 | database: str 11 | uri: str 12 | 13 | 14 | class MongoDBConnectorConfigInput(BaseModel): 15 | collection: str 16 | 17 | database: str 18 | 19 | uri: str 20 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/neo4jdestinationconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class Neo4jDestinationConnectorConfigTypedDict(TypedDict): 9 | batch_size: int 10 | database: str 11 | password: str 12 | uri: str 13 | username: str 14 | 15 | 16 | class Neo4jDestinationConnectorConfig(BaseModel): 17 | batch_size: int 18 | 19 | database: str 20 | 21 | password: str 22 | 23 | uri: str 24 | 25 | username: str 26 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/neo4jdestinationconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import Optional 5 | from typing_extensions import NotRequired, TypedDict 6 | from unstructured_client.types import BaseModel 7 | 8 | 9 | class Neo4jDestinationConnectorConfigInputTypedDict(TypedDict): 10 | database: str 11 | password: str 12 | uri: str 13 | username: str 14 | batch_size: NotRequired[int] 15 | 16 | 17 | class Neo4jDestinationConnectorConfigInput(BaseModel): 18 | database: str 19 | 20 | password: str 21 | 22 | uri: str 23 | 24 | username: str 25 | 26 | batch_size: Optional[int] = 100 27 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/nodefilemetadata.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class NodeFileMetadataTypedDict(TypedDict): 9 | file_id: str 10 | node_id: str 11 | 12 | 13 | class NodeFileMetadata(BaseModel): 14 | file_id: str 15 | 16 | node_id: str 17 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/onedrivedestinationconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class OneDriveDestinationConnectorConfigTypedDict(TypedDict): 9 | authority_url: str 10 | client_cred: str 11 | client_id: str 12 | remote_url: str 13 | tenant: str 14 | user_pname: str 15 | 16 | 17 | class OneDriveDestinationConnectorConfig(BaseModel): 18 | authority_url: str 19 | 20 | client_cred: str 21 | 22 | client_id: str 23 | 24 | remote_url: str 25 | 26 | tenant: str 27 | 28 | user_pname: str 29 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/onedrivedestinationconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class OneDriveDestinationConnectorConfigInputTypedDict(TypedDict): 9 | authority_url: str 10 | client_cred: str 11 | client_id: str 12 | remote_url: str 13 | tenant: str 14 | user_pname: str 15 | 16 | 17 | class OneDriveDestinationConnectorConfigInput(BaseModel): 18 | authority_url: str 19 | 20 | client_cred: str 21 | 22 | client_id: str 23 | 24 | remote_url: str 25 | 26 | tenant: str 27 | 28 | user_pname: str 29 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/onedrivesourceconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class OneDriveSourceConnectorConfigTypedDict(TypedDict): 9 | authority_url: str 10 | client_cred: str 11 | client_id: str 12 | path: str 13 | recursive: bool 14 | tenant: str 15 | user_pname: str 16 | 17 | 18 | class OneDriveSourceConnectorConfig(BaseModel): 19 | authority_url: str 20 | 21 | client_cred: str 22 | 23 | client_id: str 24 | 25 | path: str 26 | 27 | recursive: bool 28 | 29 | tenant: str 30 | 31 | user_pname: str 32 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/onedrivesourceconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import Optional 5 | from typing_extensions import NotRequired, TypedDict 6 | from unstructured_client.types import BaseModel 7 | 8 | 9 | class OneDriveSourceConnectorConfigInputTypedDict(TypedDict): 10 | authority_url: str 11 | client_cred: str 12 | client_id: str 13 | path: str 14 | tenant: str 15 | user_pname: str 16 | recursive: NotRequired[bool] 17 | 18 | 19 | class OneDriveSourceConnectorConfigInput(BaseModel): 20 | authority_url: str 21 | 22 | client_cred: str 23 | 24 | client_id: str 25 | 26 | path: str 27 | 28 | tenant: str 29 | 30 | user_pname: str 31 | 32 | recursive: Optional[bool] = False 33 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/pineconedestinationconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class PineconeDestinationConnectorConfigTypedDict(TypedDict): 9 | api_key: str 10 | batch_size: int 11 | index_name: str 12 | namespace: str 13 | 14 | 15 | class PineconeDestinationConnectorConfig(BaseModel): 16 | api_key: str 17 | 18 | batch_size: int 19 | 20 | index_name: str 21 | 22 | namespace: str 23 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/pineconedestinationconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import Optional 5 | from typing_extensions import NotRequired, TypedDict 6 | from unstructured_client.types import BaseModel 7 | 8 | 9 | class PineconeDestinationConnectorConfigInputTypedDict(TypedDict): 10 | api_key: str 11 | index_name: str 12 | namespace: str 13 | batch_size: NotRequired[int] 14 | 15 | 16 | class PineconeDestinationConnectorConfigInput(BaseModel): 17 | api_key: str 18 | 19 | index_name: str 20 | 21 | namespace: str 22 | 23 | batch_size: Optional[int] = 50 24 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/postgresdestinationconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class PostgresDestinationConnectorConfigTypedDict(TypedDict): 9 | batch_size: int 10 | database: str 11 | host: str 12 | password: str 13 | port: int 14 | table_name: str 15 | username: str 16 | 17 | 18 | class PostgresDestinationConnectorConfig(BaseModel): 19 | batch_size: int 20 | 21 | database: str 22 | 23 | host: str 24 | 25 | password: str 26 | 27 | port: int 28 | 29 | table_name: str 30 | 31 | username: str 32 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/postgresdestinationconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class PostgresDestinationConnectorConfigInputTypedDict(TypedDict): 9 | batch_size: int 10 | database: str 11 | host: str 12 | password: str 13 | port: int 14 | table_name: str 15 | username: str 16 | 17 | 18 | class PostgresDestinationConnectorConfigInput(BaseModel): 19 | batch_size: int 20 | 21 | database: str 22 | 23 | host: str 24 | 25 | password: str 26 | 27 | port: int 28 | 29 | table_name: str 30 | 31 | username: str 32 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/qdrantclouddestinationconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing_extensions import TypedDict 5 | from unstructured_client.types import BaseModel 6 | 7 | 8 | class QdrantCloudDestinationConnectorConfigTypedDict(TypedDict): 9 | api_key: str 10 | batch_size: int 11 | collection_name: str 12 | url: str 13 | 14 | 15 | class QdrantCloudDestinationConnectorConfig(BaseModel): 16 | api_key: str 17 | 18 | batch_size: int 19 | 20 | collection_name: str 21 | 22 | url: str 23 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/qdrantclouddestinationconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import Optional 5 | from typing_extensions import NotRequired, TypedDict 6 | from unstructured_client.types import BaseModel 7 | 8 | 9 | class QdrantCloudDestinationConnectorConfigInputTypedDict(TypedDict): 10 | api_key: str 11 | collection_name: str 12 | url: str 13 | batch_size: NotRequired[int] 14 | 15 | 16 | class QdrantCloudDestinationConnectorConfigInput(BaseModel): 17 | api_key: str 18 | 19 | collection_name: str 20 | 21 | url: str 22 | 23 | batch_size: Optional[int] = 50 24 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/salesforcesourceconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import List 5 | from typing_extensions import TypedDict 6 | from unstructured_client.types import BaseModel 7 | 8 | 9 | class SalesforceSourceConnectorConfigTypedDict(TypedDict): 10 | categories: List[str] 11 | consumer_key: str 12 | private_key: str 13 | username: str 14 | 15 | 16 | class SalesforceSourceConnectorConfig(BaseModel): 17 | categories: List[str] 18 | 19 | consumer_key: str 20 | 21 | private_key: str 22 | 23 | username: str 24 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/salesforcesourceconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import List 5 | from typing_extensions import TypedDict 6 | from unstructured_client.types import BaseModel 7 | 8 | 9 | class SalesforceSourceConnectorConfigInputTypedDict(TypedDict): 10 | categories: List[str] 11 | consumer_key: str 12 | private_key: str 13 | username: str 14 | 15 | 16 | class SalesforceSourceConnectorConfigInput(BaseModel): 17 | categories: List[str] 18 | 19 | consumer_key: str 20 | 21 | private_key: str 22 | 23 | username: str 24 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/security.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import Optional 5 | from typing_extensions import Annotated, NotRequired, TypedDict 6 | from unstructured_client.types import BaseModel 7 | from unstructured_client.utils import FieldMetadata, SecurityMetadata 8 | 9 | 10 | class SecurityTypedDict(TypedDict): 11 | api_key_auth: NotRequired[str] 12 | 13 | 14 | class Security(BaseModel): 15 | api_key_auth: Annotated[ 16 | Optional[str], 17 | FieldMetadata( 18 | security=SecurityMetadata( 19 | scheme=True, 20 | scheme_type="apiKey", 21 | sub_type="header", 22 | field_name="unstructured-api-key", 23 | ) 24 | ), 25 | ] = None 26 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/sourceconnectortype.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from enum import Enum 5 | 6 | 7 | class SourceConnectorType(str, Enum): 8 | AZURE = "azure" 9 | BOX = "box" 10 | CONFLUENCE = "confluence" 11 | COUCHBASE = "couchbase" 12 | DATABRICKS_VOLUMES = "databricks_volumes" 13 | DROPBOX = "dropbox" 14 | ELASTICSEARCH = "elasticsearch" 15 | GCS = "gcs" 16 | GOOGLE_DRIVE = "google_drive" 17 | KAFKA_CLOUD = "kafka-cloud" 18 | MONGODB = "mongodb" 19 | ONEDRIVE = "onedrive" 20 | OUTLOOK = "outlook" 21 | POSTGRES = "postgres" 22 | S3 = "s3" 23 | SALESFORCE = "salesforce" 24 | SHAREPOINT = "sharepoint" 25 | SNOWFLAKE = "snowflake" 26 | JIRA = "jira" 27 | ZENDESK = "zendesk" 28 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/validationerror.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from typing import List, Union 5 | from typing_extensions import TypeAliasType, TypedDict 6 | from unstructured_client.types import BaseModel 7 | 8 | 9 | LocTypedDict = TypeAliasType("LocTypedDict", Union[str, int]) 10 | 11 | 12 | Loc = TypeAliasType("Loc", Union[str, int]) 13 | 14 | 15 | class ValidationErrorTypedDict(TypedDict): 16 | loc: List[LocTypedDict] 17 | msg: str 18 | type: str 19 | 20 | 21 | class ValidationError(BaseModel): 22 | loc: List[Loc] 23 | 24 | msg: str 25 | 26 | type: str 27 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/weaviatedestinationconnectorconfig.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from pydantic import model_serializer 5 | from typing_extensions import NotRequired, TypedDict 6 | from unstructured_client.types import ( 7 | BaseModel, 8 | Nullable, 9 | OptionalNullable, 10 | UNSET, 11 | UNSET_SENTINEL, 12 | ) 13 | 14 | 15 | class WeaviateDestinationConnectorConfigTypedDict(TypedDict): 16 | api_key: str 17 | cluster_url: str 18 | collection: NotRequired[Nullable[str]] 19 | 20 | 21 | class WeaviateDestinationConnectorConfig(BaseModel): 22 | api_key: str 23 | 24 | cluster_url: str 25 | 26 | collection: OptionalNullable[str] = UNSET 27 | 28 | @model_serializer(mode="wrap") 29 | def serialize_model(self, handler): 30 | optional_fields = ["collection"] 31 | nullable_fields = ["collection"] 32 | null_default_fields = [] 33 | 34 | serialized = handler(self) 35 | 36 | m = {} 37 | 38 | for n, f in type(self).model_fields.items(): 39 | k = f.alias or n 40 | val = serialized.get(k) 41 | serialized.pop(k, None) 42 | 43 | optional_nullable = k in optional_fields and k in nullable_fields 44 | is_set = ( 45 | self.__pydantic_fields_set__.intersection({n}) 46 | or k in null_default_fields 47 | ) # pylint: disable=no-member 48 | 49 | if val is not None and val != UNSET_SENTINEL: 50 | m[k] = val 51 | elif val != UNSET_SENTINEL and ( 52 | not k in optional_fields or (optional_nullable and is_set) 53 | ): 54 | m[k] = val 55 | 56 | return m 57 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/weaviatedestinationconnectorconfiginput.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from pydantic import model_serializer 5 | from typing_extensions import NotRequired, TypedDict 6 | from unstructured_client.types import ( 7 | BaseModel, 8 | Nullable, 9 | OptionalNullable, 10 | UNSET, 11 | UNSET_SENTINEL, 12 | ) 13 | 14 | 15 | class WeaviateDestinationConnectorConfigInputTypedDict(TypedDict): 16 | api_key: str 17 | cluster_url: str 18 | collection: NotRequired[Nullable[str]] 19 | 20 | 21 | class WeaviateDestinationConnectorConfigInput(BaseModel): 22 | api_key: str 23 | 24 | cluster_url: str 25 | 26 | collection: OptionalNullable[str] = UNSET 27 | 28 | @model_serializer(mode="wrap") 29 | def serialize_model(self, handler): 30 | optional_fields = ["collection"] 31 | nullable_fields = ["collection"] 32 | null_default_fields = [] 33 | 34 | serialized = handler(self) 35 | 36 | m = {} 37 | 38 | for n, f in type(self).model_fields.items(): 39 | k = f.alias or n 40 | val = serialized.get(k) 41 | serialized.pop(k, None) 42 | 43 | optional_nullable = k in optional_fields and k in nullable_fields 44 | is_set = ( 45 | self.__pydantic_fields_set__.intersection({n}) 46 | or k in null_default_fields 47 | ) # pylint: disable=no-member 48 | 49 | if val is not None and val != UNSET_SENTINEL: 50 | m[k] = val 51 | elif val != UNSET_SENTINEL and ( 52 | not k in optional_fields or (optional_nullable and is_set) 53 | ): 54 | m[k] = val 55 | 56 | return m 57 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/workflowjobtype.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from enum import Enum 5 | 6 | 7 | class WorkflowJobType(str, Enum): 8 | EPHEMERAL = "ephemeral" 9 | PERSISTENT = "persistent" 10 | SCHEDULED = "scheduled" 11 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/workflownodetype.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from enum import Enum 5 | 6 | 7 | class WorkflowNodeType(str, Enum): 8 | PARTITION = "partition" 9 | PROMPTER = "prompter" 10 | CHUNK = "chunk" 11 | EMBED = "embed" 12 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/workflowschedule.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from .crontabentry import CronTabEntry, CronTabEntryTypedDict 5 | from typing import List 6 | from typing_extensions import TypedDict 7 | from unstructured_client.types import BaseModel 8 | 9 | 10 | class WorkflowScheduleTypedDict(TypedDict): 11 | crontab_entries: List[CronTabEntryTypedDict] 12 | 13 | 14 | class WorkflowSchedule(BaseModel): 15 | crontab_entries: List[CronTabEntry] 16 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/workflowstate.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from enum import Enum 5 | 6 | 7 | class WorkflowState(str, Enum): 8 | ACTIVE = "active" 9 | INACTIVE = "inactive" 10 | -------------------------------------------------------------------------------- /src/unstructured_client/models/shared/workflowtype.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from __future__ import annotations 4 | from enum import Enum 5 | 6 | 7 | class WorkflowType(str, Enum): 8 | BASIC = "basic" 9 | ADVANCED = "advanced" 10 | PLATINUM = "platinum" 11 | CUSTOM = "custom" 12 | -------------------------------------------------------------------------------- /src/unstructured_client/py.typed: -------------------------------------------------------------------------------- 1 | # Marker file for PEP 561. The package enables type hints. 2 | -------------------------------------------------------------------------------- /src/unstructured_client/types/__init__.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from .basemodel import ( 4 | BaseModel, 5 | Nullable, 6 | OptionalNullable, 7 | UnrecognizedInt, 8 | UnrecognizedStr, 9 | UNSET, 10 | UNSET_SENTINEL, 11 | ) 12 | 13 | __all__ = [ 14 | "BaseModel", 15 | "Nullable", 16 | "OptionalNullable", 17 | "UnrecognizedInt", 18 | "UnrecognizedStr", 19 | "UNSET", 20 | "UNSET_SENTINEL", 21 | ] 22 | -------------------------------------------------------------------------------- /src/unstructured_client/types/basemodel.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from pydantic import ConfigDict, model_serializer 4 | from pydantic import BaseModel as PydanticBaseModel 5 | from typing import TYPE_CHECKING, Literal, Optional, TypeVar, Union 6 | from typing_extensions import TypeAliasType, TypeAlias 7 | 8 | 9 | class BaseModel(PydanticBaseModel): 10 | model_config = ConfigDict( 11 | populate_by_name=True, arbitrary_types_allowed=True, protected_namespaces=() 12 | ) 13 | 14 | 15 | class Unset(BaseModel): 16 | @model_serializer(mode="plain") 17 | def serialize_model(self): 18 | return UNSET_SENTINEL 19 | 20 | def __bool__(self) -> Literal[False]: 21 | return False 22 | 23 | 24 | UNSET = Unset() 25 | UNSET_SENTINEL = "~?~unset~?~sentinel~?~" 26 | 27 | 28 | T = TypeVar("T") 29 | if TYPE_CHECKING: 30 | Nullable: TypeAlias = Union[T, None] 31 | OptionalNullable: TypeAlias = Union[Optional[Nullable[T]], Unset] 32 | else: 33 | Nullable = TypeAliasType("Nullable", Union[T, None], type_params=(T,)) 34 | OptionalNullable = TypeAliasType( 35 | "OptionalNullable", Union[Optional[Nullable[T]], Unset], type_params=(T,) 36 | ) 37 | 38 | UnrecognizedInt: TypeAlias = int 39 | UnrecognizedStr: TypeAlias = str 40 | -------------------------------------------------------------------------------- /src/unstructured_client/utils/datetimes.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | from datetime import datetime 4 | import sys 5 | 6 | 7 | def parse_datetime(datetime_string: str) -> datetime: 8 | """ 9 | Convert a RFC 3339 / ISO 8601 formatted string into a datetime object. 10 | Python versions 3.11 and later support parsing RFC 3339 directly with 11 | datetime.fromisoformat(), but for earlier versions, this function 12 | encapsulates the necessary extra logic. 13 | """ 14 | # Python 3.11 and later can parse RFC 3339 directly 15 | if sys.version_info >= (3, 11): 16 | return datetime.fromisoformat(datetime_string) 17 | 18 | # For Python 3.10 and earlier, a common ValueError is trailing 'Z' suffix, 19 | # so fix that upfront. 20 | if datetime_string.endswith("Z"): 21 | datetime_string = datetime_string[:-1] + "+00:00" 22 | 23 | return datetime.fromisoformat(datetime_string) 24 | -------------------------------------------------------------------------------- /src/unstructured_client/utils/logger.py: -------------------------------------------------------------------------------- 1 | """Code generated by Speakeasy (https://speakeasy.com). DO NOT EDIT.""" 2 | 3 | import httpx 4 | from typing import Any, Protocol 5 | 6 | 7 | class Logger(Protocol): 8 | def debug(self, msg: str, *args: Any, **kwargs: Any) -> None: 9 | pass 10 | 11 | 12 | class NoOpLogger: 13 | def debug(self, msg: str, *args: Any, **kwargs: Any) -> None: 14 | pass 15 | 16 | 17 | def get_body_content(req: httpx.Request) -> str: 18 | return "" if not hasattr(req, "_content") else str(req.content) 19 | 20 | 21 | def get_default_logger() -> Logger: 22 | return NoOpLogger() 23 | --------------------------------------------------------------------------------