Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Docs: Fix upload_bytes docstrings #194

Merged
merged 1 commit into from
Jun 6, 2024
Merged

Docs: Fix upload_bytes docstrings #194

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions deepset_cloud_sdk/workflows/async_client/files.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -218,7 +218,7 @@ async def upload_texts(
) -> S3UploadSummary:
"""Upload raw texts to deepset Cloud.

:param files: List of DeepsetCloudFiles to upload.
:param files: List of DeepsetCloudFile objects to upload.
:param api_key: deepset Cloud API key to use for authentication.
:param api_url: API URL to use for authentication.
:param workspace_name: Name of the workspace to upload the files to. It uses the workspace from the .ENV file by default.
Expand Down Expand Up @@ -253,17 +253,17 @@ async def upload_bytes(
timeout_s: Optional[int] = None,
show_progress: bool = True,
) -> S3UploadSummary:
"""Upload raw texts to deepset Cloud.
"""Upload files in byte format.

:param files: List of DeepsetCloudFiles to upload.
:param files: List of DeepsetCloudFileBytes objects to upload.
:param api_key: deepset Cloud API key to use for authentication.
:param api_url: API URL to use for authentication.
:param workspace_name: Name of the workspace to upload the files to. It uses the workspace from the .ENV file by default.
:param write_mode: Specifies what to do when a file with the same name already exists in the workspace.
Possible options are:
KEEP - uploads the file with the same name and keeps both files in the workspace.
OVERWRITE - overwrites the file that is in the workspace.
FAIL - fails to upload the file with the same name.
OVERWRITE - overwrites the file in the workspace with the file you're uploading.
FAIL - fails to upload the file if a file with the same name already exists in the workspace.
:param blocking: Whether to wait for the files to be listed and displayed in deepset Cloud.
This may take a couple of minutes.
:param timeout_s: Timeout in seconds for the `blocking` parameter.
Expand Down
Loading