Skip to content

chore/Document breaking changes in js client #73

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

Merged
merged 8 commits into from
Jun 14, 2024
Merged

Conversation

awalker4
Copy link
Contributor

@awalker4 awalker4 commented Jun 14, 2024

Changes:

  • Refer to TypeScript client instead of JavaScript client
  • Add list of breaking changes for new typescript release
  • Update code samples for cleaner syntax

@awalker4 awalker4 force-pushed the chore/sdk-updates branch from 1d3a576 to 4a0f4c8 Compare June 14, 2024 01:09
@awalker4 awalker4 marked this pull request as ready for review June 14, 2024 01:28
@awalker4 awalker4 changed the title Chore/sdk updates chore/Document breaking changes in js client Jun 14, 2024
@awalker4 awalker4 requested a review from badGarnet June 14, 2024 15:06
@@ -73,35 +83,46 @@ deployment of Unstructured API, you can access the API using the Python or JavaS
# Handle the response
pass
Copy link
Contributor

Choose a reason for hiding this comment

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

unrelated to this PR, but I'm noticing now that the response is handled differently in the two python examples. This first example should probably do the same as the Python (SDK <=v0.22.0) tab

Suggested change
pass
try:
res = client.general.partition(request=req)
print(res.elements[0])
except SDKError as e:
print(e)

Copy link
Contributor

@Coniferish Coniferish left a comment

Choose a reason for hiding this comment

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

Added comments, but approving in advance

awalker4 added 2 commits June 14, 2024 12:10
* Use data as variable in all samples
* Keep the example params consistent
@awalker4 awalker4 merged commit 85ad3d0 into main Jun 14, 2024
1 check passed
@awalker4 awalker4 deleted the chore/sdk-updates branch June 14, 2024 16:30
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.

2 participants