Add pages about troubleshooting sdk errors #2806
Draft
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
lgrammel
reviewed
Aug 27, 2024
| @@ -1,10 +1,73 @@ | |||
| --- | |||
| title: AI_InvalidDataContentError | |||
| description: How to fix AI_InvalidDataContentError | |||
| title: InvalidDataContentError | |||
There was a problem hiding this comment.
Had AI_ prefix on purpose for SEO
lgrammel
reviewed
Aug 27, 2024
Comment on lines
+58
to
+73
| ## Usage | ||
|
|
||
| ```ts | ||
| import { InvalidDataContentError } from '@ai-sdk/core'; | ||
|
|
||
| try { | ||
| // Code that might throw an InvalidDataContentError | ||
| } catch (error) { | ||
| if (InvalidDataContentError.isInstance(error)) { | ||
| console.log('An invalid data content error occurred:', error.message); | ||
| // Handle the error appropriately | ||
| } else { | ||
| // Handle other types of errors | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Not sure we need this section.
There was a problem hiding this comment.
Or maybe some additional context is helpful
lgrammel
reviewed
Aug 27, 2024
| @@ -0,0 +1,60 @@ | |||
| --- | |||
| title: APICallError | |||
lgrammel
reviewed
Aug 27, 2024
| description: Error thrown during a failed API call | ||
| --- | ||
|
|
||
| # APICallError |
lgrammel
reviewed
Aug 27, 2024
Comment on lines
+10
to
+15
| The `APICallError` occurs when there's an issue during an API call made by the SDK. This can happen in various scenarios, such as: | ||
|
|
||
| 1. Network connectivity problems | ||
| 2. Server-side errors | ||
| 3. Rate limiting or request timeouts | ||
| 4. Invalid requests or authentication issues |
There was a problem hiding this comment.
While this is generally true, it is really a misleading explanation.
This happens when a provider API returns with an error. Most of the time, this means that there API cannot be used in this way, e.g. invalid message structure. The user needs to carefully read the actual error message from the provider and figure out what to do.
lgrammel
reviewed
Aug 27, 2024
Comment on lines
+41
to
+60
| ## Usage | ||
|
|
||
| ```ts | ||
| import { APICallError } from '@vercel/ai'; | ||
|
|
||
| try { | ||
| // Make an API call using the Vercel AI SDK | ||
| } catch (error) { | ||
| if (APICallError.isInstance(error)) { | ||
| console.error(`API Call Error: ${error.message}`); | ||
| console.error(`URL: ${error.url}`); | ||
| console.error(`Status Code: ${error.statusCode}`); | ||
| console.error(`Is Retryable: ${error.isRetryable}`); | ||
|
|
||
| if (error.isRetryable) { | ||
| // Implement retry logic here | ||
| } | ||
| } | ||
| } | ||
| ``` |
There was a problem hiding this comment.
Just printing the error would do the job already.
lgrammel
reviewed
Aug 27, 2024
| console.error(`Status Code: ${error.statusCode}`); | ||
| console.error(`Is Retryable: ${error.isRetryable}`); | ||
|
|
||
| if (error.isRetryable) { |
There was a problem hiding this comment.
This is for internal logic (automatic retries) and should not be mentioned
lgrammel
reviewed
Aug 27, 2024
| @@ -0,0 +1,47 @@ | |||
| --- | |||
| title: DownloadError | |||
lgrammel
reviewed
Aug 27, 2024
| description: An error thrown when downloading a file fails | ||
| --- | ||
|
|
||
| # DownloadError |
lgrammel
reviewed
Aug 27, 2024
Comment on lines
+16
to
+23
| ## How to Resolve It | ||
|
|
||
| To resolve this error: | ||
|
|
||
| 1. Check your network connection to ensure there are no connectivity issues. | ||
| 2. Verify that the AI service is functioning correctly and not experiencing any outages. | ||
| 3. Review your request parameters to make sure they are valid and complete. | ||
| 4. If the issue persists, contact the AI service provider's support team for assistance. |
There was a problem hiding this comment.
This is caused by provider limitations & bad prompts for the most part, e.g. object generation with perplexity
lgrammel
reviewed
Aug 27, 2024
| - [ InvalidMessageRoleError ](/docs/troubleshooting/ai-sdk-errors/invalid-message-role-error) | ||
| - [ DownloadError ](/docs/troubleshooting/ai-sdk-errors/download-error) | ||
| - [ RetryError ](/docs/troubleshooting/ai-sdk-errors/retry-error) | ||
| - [ MessageConversionError ](/docs/troubleshooting/ai-sdk-errors/message-conversion-error) |
lgrammel
reviewed
Aug 27, 2024
Comment on lines
+23
to
+29
| To resolve this error, you can try the following: | ||
|
|
||
| 1. Check the URL: Ensure that the image URL is correct and publicly accessible. | ||
| 2. Verify network connectivity: Make sure your application has a stable internet connection. | ||
| 3. Validate content type: Make sure the content type of the file matches what's expected (e.g., image/png, image/jpeg). | ||
|
|
||
| If the issue persists after trying these solutions, you may need to investigate further by examining the specific error details provided in the DownloadError instance, such as the `statusCode` and `statusText`. |
There was a problem hiding this comment.
These instructions are good when you are an end user, however, our "users" build apps that need to generically handle those situations
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.