overlay_client.yaml

overlay: 1.0.0
info:
  title: Overlay openapi.json to add client-specific features
  version: 0.0.0
actions:
  - target: $
    update:
      servers:
        - url: "https://platform.unstructuredapp.io/"
          description: "Unstructured Platform API"
          x-speakeasy-server-id: "platform-api"
  - target: $["components"]["schemas"]["partition_parameters"]["properties"]
    update:
      "split_pdf_page":
        {
          "type": "boolean",
          "title": "Split Pdf Page",
          "description": "This parameter determines if the PDF file should be split on the client side. It's an internal parameter for the Python client and is not sent to the backend.",
          "default": true,
        }
  - target: $["components"]["schemas"]["partition_parameters"]["properties"]
    update:
      "split_pdf_page_range":
        {
          "type": "array",
          "title": "Split Pdf Page Range",
          "description": "When `split_pdf_page is set to `True`, this parameter selects a subset of the pdf to send to the API. The parameter is a list of 2 integers within the range [1, length_of_pdf]. A ValueError is thrown if the given range is invalid. It's an internal parameter for the Python client and is not sent to the backend.",
          "items": {"type": "integer"},
          "minItems": 2,
          "maxItems": 2,
          "example": [1, 10],
        }
  - target: $["components"]["schemas"]["partition_parameters"]["properties"]
    update:
      "split_pdf_concurrency_level":
        {
          "title": "Split Pdf Concurrency Level",
          "description": "When `split_pdf_page` is set to `True`, this parameter specifies the number of workers used for sending requests when the PDF is split on the client side. It's an internal parameter for the Python client and is not sent to the backend.",
          "type": "integer",
          "default": 5,
        }
  - target: $["components"]["schemas"]["partition_parameters"]["properties"]
    update:
      "split_pdf_allow_failed":
        {
          "title": "Split Pdf Allow Failed",
          "description": "When `split_pdf_page` is set to `True`, this parameter defines the behavior when some of the parallel requests fail. By default `split_pdf_allow_failed` is set to `False` and any failed request send to the API will make the whole process break and raise an Exception. If `split_pdf_allow_failed` is set to `True`, the errors encountered while sending parallel requests will not break the processing - the resuling list of Elements will miss the data from errored pages.",
          "type": "boolean",
          "default": false,
        }
  - target: $["components"]["schemas"]["partition_parameters"]["properties"]
    update:
      "split_pdf_cache_tmp_data":
        {
          "title": "Split Pdf Cache Temporary Data",
          "description": "When `split_pdf_page` is set to `True`, this parameter determines if the temporary data used for splitting the PDF should be cached into disc - if enabled should save significant amount of RAM memory when processing big files. It's an internal parameter for the Python client and is not sent to the backend.",
          "type": "boolean",
          "default": false,
        }
  - target: $["components"]["schemas"]["partition_parameters"]["properties"]
    update:
      "split_pdf_cache_tmp_data_dir":
        {
          "title": "Split Pdf Cache Temporary Data Directory",
          "description": "When `split_pdf_page` is set to `True` and `split_pdf_cache_tmp_data` feature is used, this parameter specifies the directory where the temporary data used for splitting the PDF should be cached into disc. It's an internal parameter for the Python client and is not sent to the backend.",
          "type": "string",
          "default": null,
        }
  - target: $["components"]["schemas"]["partition_parameters"]["properties"][*].anyOf[0]
    description: Add a null default to all optional parameters. Prevents the sdk from sending a default string when param is not specified.
    update:
      "default": null