Uploads

pydantic model DeleteFileResponse

Show JSON schema

{
   "title": "DeleteFileResponse",
   "type": "object",
   "properties": {
      "message": {
         "title": "Message",
         "type": "string"
      }
   },
   "required": [
      "message"
   ]
}

Fields:

• message (str)

field message: str [Required]

class ExtractorTypes

PDF_EXTRACTOR_1_0 = 'PDF_EXTRACTOR_1_0'

pydantic model FileResponse

Model to represent a single upload in the ListFilesResponse

Show JSON schema

{
   "title": "FileResponse",
   "description": "Model to represent a single upload in the ListFilesResponse",
   "type": "object",
   "properties": {
      "file_id": {
         "title": "File Id",
         "type": "string"
      },
      "file_name": {
         "title": "File Name",
         "type": "string"
      },
      "status": {
         "$ref": "#/$defs/FileStatus"
      },
      "upload_ts": {
         "format": "date-time",
         "title": "Upload Ts",
         "type": "string"
      },
      "raw_size": {
         "title": "Raw Size",
         "type": "integer"
      },
      "folder_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Folder Id"
      },
      "tags": {
         "anyOf": [
            {
               "items": {
                  "type": "string"
               },
               "type": "array"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Tags"
      },
      "company_shared_permission": {
         "anyOf": [
            {
               "$ref": "#/$defs/SharePermission"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "FileStatus": {
         "enum": [
            "PENDING",
            "PROCESSING",
            "COMPLETED",
            "FAILED",
            "DELETED"
         ],
         "title": "FileStatus",
         "type": "string"
      },
      "SharePermission": {
         "enum": [
            "read",
            "undefined"
         ],
         "title": "SharePermission",
         "type": "string"
      }
   },
   "required": [
      "file_id",
      "file_name",
      "status",
      "upload_ts",
      "raw_size"
   ]
}

Fields:

• company_shared_permission (bigdata_client.models.sharing.SharePermission | None)

• folder_id (str | None)

• id (str)

• name (str)

• raw_size (int)

• status (bigdata_client.api.uploads.FileStatus)

• tags (list[str] | None)

• uploaded_at (datetime.datetime)

Validators:

• set_company_shared_permission » all fields

• set_tz » all fields

field company_shared_permission: SharePermission | None = None

Validated by:

• set_company_shared_permission

• set_tz

field folder_id: str | None = None

Validated by:

• set_company_shared_permission

• set_tz

field id: str [Required] (alias 'file_id')

Validated by:

• set_company_shared_permission

• set_tz

field name: str [Required] (alias 'file_name')

Validated by:

• set_company_shared_permission

• set_tz

field raw_size: int [Required]

Validated by:

• set_company_shared_permission

• set_tz

field status: FileStatus [Required]

Validated by:

• set_company_shared_permission

• set_tz

field tags: list[str] | None = None

Validated by:

• set_company_shared_permission

• set_tz

field uploaded_at: datetime [Required] (alias 'upload_ts')

Validated by:

• set_company_shared_permission

• set_tz

validator set_company_shared_permission  »  all fields

Parameters:

values (dict) –

validator set_tz  »  all fields

pydantic model FileShareResponse

Show JSON schema

{
   "title": "FileShareResponse",
   "type": "object",
   "properties": {
      "status": {
         "const": "OK",
         "title": "Status",
         "type": "string"
      },
      "message": {
         "title": "Message",
         "type": "string"
      }
   },
   "required": [
      "status",
      "message"
   ]
}

Fields:

• message (str)

• status (Literal['OK'])

field message: str [Required]

field status: Literal['OK'] [Required]

class FileStatus

COMPLETED = 'COMPLETED'

DELETED = 'DELETED'

FAILED = 'FAILED'

PENDING = 'PENDING'

PROCESSING = 'PROCESSING'

pydantic model GetDownloadPresignedUrlResponse

Show JSON schema

{
   "title": "GetDownloadPresignedUrlResponse",
   "type": "object",
   "properties": {
      "url": {
         "title": "Url",
         "type": "string"
      }
   },
   "required": [
      "url"
   ]
}

Fields:

• url (str)

field url: str [Required]

pydantic model GetFileStatusResponse

Show JSON schema

{
   "title": "GetFileStatusResponse",
   "type": "object",
   "properties": {
      "status": {
         "anyOf": [
            {
               "$ref": "#/$defs/FileStatus"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      },
      "error": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Error"
      }
   },
   "$defs": {
      "FileStatus": {
         "enum": [
            "PENDING",
            "PROCESSING",
            "COMPLETED",
            "FAILED",
            "DELETED"
         ],
         "title": "FileStatus",
         "type": "string"
      }
   }
}

Fields:

• error (str | None)

• status (bigdata_client.api.uploads.FileStatus | None)

field error: str | None = None

field status: FileStatus | None = None

pydantic model ListFilesResponse

Model to represent the response of the list uploads endpoint

Show JSON schema

{
   "title": "ListFilesResponse",
   "description": "Model to represent the response of the list uploads endpoint",
   "type": "object",
   "properties": {
      "results": {
         "items": {
            "$ref": "#/$defs/FileResponse"
         },
         "title": "Results",
         "type": "array"
      }
   },
   "$defs": {
      "FileResponse": {
         "description": "Model to represent a single upload in the ListFilesResponse",
         "properties": {
            "file_id": {
               "title": "File Id",
               "type": "string"
            },
            "file_name": {
               "title": "File Name",
               "type": "string"
            },
            "status": {
               "$ref": "#/$defs/FileStatus"
            },
            "upload_ts": {
               "format": "date-time",
               "title": "Upload Ts",
               "type": "string"
            },
            "raw_size": {
               "title": "Raw Size",
               "type": "integer"
            },
            "folder_id": {
               "anyOf": [
                  {
                     "type": "string"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Folder Id"
            },
            "tags": {
               "anyOf": [
                  {
                     "items": {
                        "type": "string"
                     },
                     "type": "array"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null,
               "title": "Tags"
            },
            "company_shared_permission": {
               "anyOf": [
                  {
                     "$ref": "#/$defs/SharePermission"
                  },
                  {
                     "type": "null"
                  }
               ],
               "default": null
            }
         },
         "required": [
            "file_id",
            "file_name",
            "status",
            "upload_ts",
            "raw_size"
         ],
         "title": "FileResponse",
         "type": "object"
      },
      "FileStatus": {
         "enum": [
            "PENDING",
            "PROCESSING",
            "COMPLETED",
            "FAILED",
            "DELETED"
         ],
         "title": "FileStatus",
         "type": "string"
      },
      "SharePermission": {
         "enum": [
            "read",
            "undefined"
         ],
         "title": "SharePermission",
         "type": "string"
      }
   },
   "required": [
      "results"
   ]
}

Fields:

• results (list[bigdata_client.api.uploads.FileResponse])

field results: list[FileResponse] [Required]

pydantic model PostFileRequest

Model to represent the request of the post upload endpoint

Show JSON schema

{
   "title": "PostFileRequest",
   "description": "Model to represent the request of the post upload endpoint",
   "type": "object",
   "properties": {
      "filename": {
         "title": "Filename",
         "type": "string"
      },
      "folder_id": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Folder Id"
      },
      "source_url": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Source Url"
      },
      "upload_mode": {
         "anyOf": [
            {
               "type": "string"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Upload Mode"
      },
      "properties": {
         "anyOf": [
            {
               "type": "object"
            },
            {
               "type": "null"
            }
         ],
         "default": null,
         "title": "Properties"
      },
      "connect_to": {
         "default": [
            "smart_topics"
         ],
         "items": {
            "const": "smart_topics",
            "type": "string"
         },
         "title": "Connect To",
         "type": "array"
      },
      "extractor": {
         "anyOf": [
            {
               "$ref": "#/$defs/ExtractorTypes"
            },
            {
               "type": "null"
            }
         ],
         "default": null
      }
   },
   "$defs": {
      "ExtractorTypes": {
         "enum": [
            "PDF_EXTRACTOR_1_0"
         ],
         "title": "ExtractorTypes",
         "type": "string"
      }
   },
   "required": [
      "filename"
   ]
}

Fields:

• connect_to (list[Literal['smart_topics']])

• extractor (bigdata_client.api.uploads.ExtractorTypes | None)

• filename (str)

• folder_id (str | None)

• properties (dict | None)

• source_url (str | None)

• upload_mode (str | None)

field connect_to: list[Literal['smart_topics']] = ['smart_topics']

field extractor: ExtractorTypes | None = None

field filename: str [Required]

field folder_id: str | None = None

field properties: dict | None = None

field source_url: str | None = None

field upload_mode: str | None = None

pydantic model PostFileResponse

Model to represent the response of the post upload endpoint

Show JSON schema

{
   "title": "PostFileResponse",
   "description": "Model to represent the response of the post upload endpoint",
   "type": "object",
   "properties": {
      "file_id": {
         "title": "File Id",
         "type": "string"
      },
      "Location": {
         "title": "Location",
         "type": "string"
      }
   },
   "required": [
      "file_id",
      "Location"
   ]
}

Fields:

• file_id (str)

• location (str)

field file_id: str [Required]

field location: str [Required] (alias 'Location')

class UploadsConnectionProtocol

__init__(*args, **kwargs)

delete_file(id)

Parameters:

id (str) –

Return type:

DeleteFileResponse

download_analytics(id)

Parameters:

id (str) –

Return type:

Iterable[bytes]

download_annotated(id)

Parameters:

id (str) –

Return type:

Iterable[bytes]

download_text(id)

Parameters:

id (str) –

Return type:

Iterable[bytes]

get_download_presigned_url(id)

Parameters:

id (str) –

Return type:

GetDownloadPresignedUrlResponse

get_file(id)

Parameters:

id (str) –

Return type:

FileResponse

get_file_status(file_id)

Parameters:

file_id (str) –

Return type:

GetFileStatusResponse

list_files(date_range, tags, status, file_name, folder_id, page_size, shared, offset)

Parameters:

• date_range (AbsoluteDateRange | None) –

• tags (list[str] | None) –

• status (FileStatus | None) –

• file_name (str | None) –

• folder_id (str | None) –

• page_size (int) –

• shared (bool | None) –

• offset (int) –

Return type:

ListFilesResponse

post_file(request)

Parameters:

request (PostFileRequest) –

Return type:

PostFileResponse

share_file_with_company(file_id)

Parameters:

file_id (str) –

Return type:

FileResponse

unshare_file_with_company(file_id)

Parameters:

file_id (str) –

Return type:

FileResponse

update_file_tags(file_id, tags)

Parameters:

• file_id (str) –

• tags (list[str]) –

Return type:

FileResponse