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.

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

Docs: Move tupload_texts() example from guides to reference #196

Merged
merged 4 commits into from
Jun 7, 2024

Conversation

agnieszka-m
Copy link
Contributor

Proposed Changes?

SOLs suggested upload_bytes() is the method we should promote in the guides, since they can use it for all file types, not just text. I'm deleting upload_texts() examples from https://docs.cloud.deepset.ai/docs/upload-files-with-python#upload-texts-or-bytes and moving them to reference. The how-tos will just have examples of upload_bytes.

How did you test it?

Notes for the reviewer

I'm not sure the formatting is OK.

Screenshots (optional)

Checklist

  • I have updated the referenced issue with new insights and changes
  • If this is a code change, I have added unit tests
  • I've used the conventional commit specification for my PR title
  • I updated the docstrings
  • If this is a code change, I added meaningful logs and prepared Datadog visualizations and alerts

@agnieszka-m agnieszka-m requested a review from FHardow June 5, 2024 08:48
Copy link

github-actions bot commented Jun 5, 2024

Coverage report

This PR does not seem to contain any modification to coverable code.

Copy link
Member

@FHardow FHardow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not sure if my suggestions will be a problem

deepset_cloud_sdk/workflows/async_client/files.py Outdated Show resolved Hide resolved
deepset_cloud_sdk/workflows/sync_client/files.py Outdated Show resolved Hide resolved
@agnieszka-m agnieszka-m added this pull request to the merge queue Jun 5, 2024
@github-merge-queue github-merge-queue bot removed this pull request from the merge queue due to failed status checks Jun 5, 2024
@sjrl
Copy link
Contributor

sjrl commented Jun 6, 2024

Hey @agnieszka-m there were a few indenting changes I made, that were hard to create as suggestions, so I just made a quick commit!

@agnieszka-m agnieszka-m added this pull request to the merge queue Jun 7, 2024
Merged via the queue into main with commit 066f14c Jun 7, 2024
9 checks passed
@agnieszka-m agnieszka-m deleted the upload-text-example branch June 7, 2024 04:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants