scorable.files

Classes

Files

Files API — upload documents and images for use in evaluator execution.

Module Contents

class scorable.files.Files(client_context: scorable.utils.ClientContextCallable, base_url: str, api_key: str)

Files API — upload documents and images for use in evaluator execution.

Access via client.files.

Parameters:

  • client_context (scorable.utils.ClientContextCallable)

  • base_url (str)

  • api_key (str)

async aupload(file: str | IO[bytes], filename: str | None = None, *, _request_timeout: int | None = None) → uuid.UUID

Asynchronously upload a file and return its ID.

Parameters:

  • file (Union[str, IO[bytes]])

  • filename (Optional[str])

  • _request_timeout (Optional[int])

Return type:

uuid.UUID

upload(file: str | IO[bytes], filename: str | None = None, *, _request_timeout: int | None = None) → uuid.UUID

Upload a file and return its ID for use in evaluator execution.

Parameters:

  • file (Union[str, IO[bytes]]) – Path to the file or a file-like object opened in binary mode.

  • filename (Optional[str]) – Override the file name sent to the server (required when passing a file-like object without a name attribute).

  • _request_timeout (Optional[int])

Returns:

UUID of the uploaded file. Pass this to the file_ids parameter of Evaluator.run().

Return type:

uuid.UUID

api_key
base_url
client_context