codeSamples.yaml

overlay: 1.0.0
info:
  title: CodeSamples overlay for python target
  version: 0.0.0
actions:
  - target: $["paths"]["/api/v1/destinations/"]["get"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "list_destinations"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.destinations.list_destinations(request={})\n\n    assert res.response_list_destinations is not None\n\n    # Handle response\n    print(res.response_list_destinations)"
  - target: $["paths"]["/api/v1/destinations/"]["post"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "create_destination"
          "source": "from unstructured_client import UnstructuredClient\nfrom unstructured_client.models import shared\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.destinations.create_destination(request={\n        \"create_destination_connector\": {\n            \"name\": \"<value>\",\n            \"type\": shared.DestinationConnectorType.ASTRADB,\n            \"config\": {\n                \"remote_url\": \"https://fortunate-appliance.info\",\n                \"anonymous\": False,\n            },\n        },\n    })\n\n    assert res.destination_connector_information is not None\n\n    # Handle response\n    print(res.destination_connector_information)"
  - target: $["paths"]["/api/v1/destinations/{destination_id}"]["delete"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "delete_destination"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.destinations.delete_destination(request={\n        \"destination_id\": \"10a88d76-65fb-4c88-8488-9e7d272c6373\",\n    })\n\n    assert res.any is not None\n\n    # Handle response\n    print(res.any)"
  - target: $["paths"]["/api/v1/destinations/{destination_id}"]["get"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "get_destination"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.destinations.get_destination(request={\n        \"destination_id\": \"41ba03fb-faa3-4e9e-8cfb-27f133c4198a\",\n    })\n\n    assert res.destination_connector_information is not None\n\n    # Handle response\n    print(res.destination_connector_information)"
  - target: $["paths"]["/api/v1/destinations/{destination_id}"]["put"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "update_destination"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.destinations.update_destination(request={\n        \"destination_id\": \"9ea9d27c-4e2e-4cb5-9a69-71bd7ec9d226\",\n        \"update_destination_connector\": {\n            \"config\": {\n                \"host\": \"acidic-patroller.com\",\n                \"database\": \"<value>\",\n                \"port\": 832931,\n                \"username\": \"Salvador.Walsh-Thiel\",\n                \"password\": \"vIMqbllzrdJBExE\",\n                \"table_name\": \"<value>\",\n                \"batch_size\": 977983,\n            },\n        },\n    })\n\n    assert res.destination_connector_information is not None\n\n    # Handle response\n    print(res.destination_connector_information)"
  - target: $["paths"]["/api/v1/jobs/"]["get"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "list_jobs"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.jobs.list_jobs(request={})\n\n    assert res.response_list_jobs is not None\n\n    # Handle response\n    print(res.response_list_jobs)"
  - target: $["paths"]["/api/v1/jobs/{job_id}"]["get"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "get_job"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.jobs.get_job(request={\n        \"job_id\": \"6bb4cb72-a072-4398-9de3-194e59352a3c\",\n    })\n\n    assert res.job_information is not None\n\n    # Handle response\n    print(res.job_information)"
  - target: $["paths"]["/api/v1/jobs/{job_id}/cancel"]["post"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "cancel_job"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.jobs.cancel_job(request={\n        \"job_id\": \"ec29bf67-0f30-4793-b5ee-8fc0da196032\",\n    })\n\n    assert res.any is not None\n\n    # Handle response\n    print(res.any)"
  - target: $["paths"]["/api/v1/jobs/{job_id}/download"]["get"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "download_job_output"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.jobs.download_job_output(request={\n        \"job_id\": \"bddbb621-2124-4cc2-9fa7-c6cdc21dac44\",\n        \"file_id\": \"<id>\",\n    })\n\n    assert res.any is not None\n\n    # Handle response\n    print(res.any)"
  - target: $["paths"]["/api/v1/sources/"]["get"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "list_sources"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.sources.list_sources(request={})\n\n    assert res.response_list_sources is not None\n\n    # Handle response\n    print(res.response_list_sources)"
  - target: $["paths"]["/api/v1/sources/"]["post"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "create_source"
          "source": "from unstructured_client import UnstructuredClient\nfrom unstructured_client.models import shared\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.sources.create_source(request={\n        \"create_source_connector\": {\n            \"name\": \"<value>\",\n            \"type\": shared.SourceConnectorType.SHAREPOINT,\n            \"config\": {\n                \"account\": \"21158540\",\n                \"role\": \"<value>\",\n                \"user\": \"Andrew_Ebert71\",\n                \"password\": \"RKAX3jUtlnjWe9D\",\n                \"host\": \"impractical-academics.net\",\n                \"port\": 443,\n                \"database\": \"<value>\",\n                \"table_name\": \"<value>\",\n                \"batch_size\": 100,\n                \"id_column\": \"<value>\",\n            },\n        },\n    })\n\n    assert res.source_connector_information is not None\n\n    # Handle response\n    print(res.source_connector_information)"
  - target: $["paths"]["/api/v1/sources/{source_id}"]["delete"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "delete_source"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.sources.delete_source(request={\n        \"source_id\": \"8a24d7ae-5524-45e9-83f9-b0adba5303d4\",\n    })\n\n    assert res.any is not None\n\n    # Handle response\n    print(res.any)"
  - target: $["paths"]["/api/v1/sources/{source_id}"]["get"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "get_source"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.sources.get_source(request={\n        \"source_id\": \"e02d8147-b614-4e4c-9c6d-0cd9c4492ea0\",\n    })\n\n    assert res.source_connector_information is not None\n\n    # Handle response\n    print(res.source_connector_information)"
  - target: $["paths"]["/api/v1/sources/{source_id}"]["put"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "update_source"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.sources.update_source(request={\n        \"source_id\": \"396edec4-39e8-4ef6-ac69-c9e3ba7a8418\",\n        \"update_source_connector\": {\n            \"config\": {\n                \"host\": \"black-and-white-obesity.info\",\n                \"database\": \"<value>\",\n                \"port\": 848106,\n                \"username\": \"Bruce.Stracke19\",\n                \"password\": \"L8K8WEZq1xvBpSw\",\n                \"table_name\": \"<value>\",\n                \"batch_size\": 177849,\n                \"id_column\": \"id\",\n            },\n        },\n    })\n\n    assert res.source_connector_information is not None\n\n    # Handle response\n    print(res.source_connector_information)"
  - target: $["paths"]["/api/v1/workflows/"]["get"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "list_workflows"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.workflows.list_workflows(request={})\n\n    assert res.response_list_workflows is not None\n\n    # Handle response\n    print(res.response_list_workflows)"
  - target: $["paths"]["/api/v1/workflows/"]["post"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "create_workflow"
          "source": "from unstructured_client import UnstructuredClient\nfrom unstructured_client.models import shared\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.workflows.create_workflow(request={\n        \"create_workflow\": {\n            \"name\": \"<value>\",\n            \"workflow_type\": shared.WorkflowType.PLATINUM,\n        },\n    })\n\n    assert res.workflow_information is not None\n\n    # Handle response\n    print(res.workflow_information)"
  - target: $["paths"]["/api/v1/workflows/{workflow_id}"]["delete"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "delete_workflow"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.workflows.delete_workflow(request={\n        \"workflow_id\": \"26c0bd77-269e-4239-86b8-71541359440c\",\n    })\n\n    assert res.any is not None\n\n    # Handle response\n    print(res.any)"
  - target: $["paths"]["/api/v1/workflows/{workflow_id}"]["get"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "get_workflow"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.workflows.get_workflow(request={\n        \"workflow_id\": \"270d9bb5-13f1-4e4d-bb84-4bcc30c93967\",\n    })\n\n    assert res.workflow_information is not None\n\n    # Handle response\n    print(res.workflow_information)"
  - target: $["paths"]["/api/v1/workflows/{workflow_id}"]["put"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "update_workflow"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.workflows.update_workflow(request={\n        \"workflow_id\": \"b63b90df-08ba-41e1-b15b-bc744e5781fa\",\n        \"update_workflow\": {},\n    })\n\n    assert res.workflow_information is not None\n\n    # Handle response\n    print(res.workflow_information)"
  - target: $["paths"]["/api/v1/workflows/{workflow_id}/run"]["post"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "run_workflow"
          "source": "from unstructured_client import UnstructuredClient\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.workflows.run_workflow(request={\n        \"workflow_id\": \"6b67be6d-98e9-440c-88fd-721e5d2d0036\",\n    })\n\n    assert res.job_information is not None\n\n    # Handle response\n    print(res.job_information)"
  - target: $["paths"]["/general/v0/general"]["post"]
    update:
      "x-codeSamples":
        - "lang": "python"
          "label": "partition"
          "source": "from unstructured_client import UnstructuredClient\nfrom unstructured_client.models import shared\n\n\nwith UnstructuredClient() as uc_client:\n\n    res = uc_client.general.partition(request={\n        \"partition_parameters\": {\n            \"files\": {\n                \"file_name\": \"example.file\",\n                \"content\": open(\"example.file\", \"rb\"),\n            },\n            \"vlm_model_provider\": shared.VLMModelProvider.OPENAI,\n            \"vlm_model\": shared.VLMModel.GPT_4O,\n            \"split_pdf_page_range\": [\n                1,\n                10,\n            ],\n        },\n    })\n\n    assert res.elements is not None\n\n    # Handle response\n    print(res.elements)"