Skip to main content
Version: 1.0

aixplain.v2.file

FileCreateParams Objects​

class FileCreateParams(BaseCreateParams)

[view_source]

Parameters for creating a file.

File Objects​

class File(BaseResource, CreateResourceMixin[FileCreateParams, "File"])

[view_source]

Resource for files.

create​

@classmethod
def create(cls, *args, **kwargs: Unpack[FileCreateParams]) -> "File"

[view_source]

Create a file.

@classmethod
def to_link(cls, local_path: str) -> str

[view_source]

Convert a local path to a link.

Arguments:

  • local_path - str: The local path to the file.

Returns:

  • str - The link to the file.

upload​

@classmethod
def upload(cls,
           local_path: str,
           tags: List[str] = None,
           license: "License" = None,
           is_temp: bool = True) -> str

[view_source]

Upload a file.

Arguments:

  • local_path - str: The local path to the file.

Returns:

  • str - The upload URL.

check_storage_type​

@classmethod
def check_storage_type(cls, upload_url: str) -> "StorageType"

[view_source]

Check the storage type of a file.

Arguments:

  • upload_url - str: The upload URL.

Returns:

  • StorageType - The storage type of the file.