docs: clarify sendStart usage in streamText#6970
Merged
Conversation
As of vercel#6499 `sendStart` is used to control whether the start message is sent or not. https://github.com/vercel/ai/blob/1ed028703999fe3a897f5a3dc240c452791e3555/packages/ai/core/generate-text/stream-text.ts#L1541-L1550
chrisvariety
force-pushed
the
v5-send-start
branch
from
6e30bbe to
8ea4419
Compare
lgrammel
approved these changes
Jul 2, 2025
lgrammel
changed the title
sendStart usage in streamTextsendStart usage in streamText
botirk38
pushed a commit
to Nordlys-Labs/ai
that referenced
this pull request
Jul 6, 2025
Documentation for `sendStart` within `streamText` in v5 is outdated. As of vercel#6499 `sendStart` is used to control whether the start message is sent or not. https://github.com/vercel/ai/blob/1ed028703999fe3a897f5a3dc240c452791e3555/packages/ai/core/generate-text/stream-text.ts#L1541-L1550 Removed out-of-date documentation. docs: remove `newMessageId` in `streamText` (vercel#6971) Documentation for `newMessageId ` within `streamText` in v5 is outdated. `newMessageId` was removed in vercel#6726 but leftover in the documentation. Removed out-of-date documentation. chore: add .envrc to .gitignore (vercel#6965) `.envrc` files are commonly used with [direnv](https://direnv.net/) to automatically set environment variables when entering a directory. These files often contain sensitive information, local development settings, or personal configuration that should not be committed to version control. Added `.envrc` to `.gitignore` to prevent direnv environment files from being accidentally committed to the repository. This change can be verified by: 1. Creating a `.envrc` file in the project root 2. Running `git status` to confirm the file is ignored 3. Checking that the file doesn't appear in git tracking docs: add Amazon Nova Canvas availability regions (vercel#6977) The documentation for Amazon Bedrock's `amazon.nova-canvas-v1:0` image model was outdated. It only listed `us-east-1` as the available region, but the model is now available in additional regions. Updated the region availability for the `amazon.nova-canvas-v1:0` image model: * Added `eu-west-1` region * Added `ap-northeast-1` region The model is now documented as available in: `us-east-1`, `eu-west-1`, and `ap-northeast-1`. Add Vercel SDK Provider list (vercel#6863) (vercel#6961) I noticed that in the [Providers and Models docs](https://ai-sdk.dev/docs/foundations/providers-and-models), we mention the Vercel (v0) model in the [Model Capabilities](https://ai-sdk.dev/docs/foundations/providers-and-models#model-capabilities) but not in the [AI SDK Providers](https://ai-sdk.dev/docs/foundations/providers-and-models#ai-sdk-providers). This PR adds the Vercel Provider to the [Providers and Models docs](https://ai-sdk.dev/docs/foundations/providers-and-models#ai-sdk-providers) list. - [x] Formatting issues have been fixed (run `pnpm prettier-fix` in the project root) Co-authored-by: Anshuman Bhardwaj <anshu5074@gmail.com> refactor(adaptive): simplify usage properties by replacing providers array with a single provider string and removing cost_saved to streamline the data structure and improve clarity feat: update readme and changelog
botirk38
pushed a commit
to Nordlys-Labs/ai
that referenced
this pull request
Jul 6, 2025
Documentation for `sendStart` within `streamText` in v5 is outdated. As of vercel#6499 `sendStart` is used to control whether the start message is sent or not. https://github.com/vercel/ai/blob/1ed028703999fe3a897f5a3dc240c452791e3555/packages/ai/core/generate-text/stream-text.ts#L1541-L1550 Removed out-of-date documentation. docs: remove `newMessageId` in `streamText` (vercel#6971) Documentation for `newMessageId ` within `streamText` in v5 is outdated. `newMessageId` was removed in vercel#6726 but leftover in the documentation. Removed out-of-date documentation. chore: add .envrc to .gitignore (vercel#6965) `.envrc` files are commonly used with [direnv](https://direnv.net/) to automatically set environment variables when entering a directory. These files often contain sensitive information, local development settings, or personal configuration that should not be committed to version control. Added `.envrc` to `.gitignore` to prevent direnv environment files from being accidentally committed to the repository. This change can be verified by: 1. Creating a `.envrc` file in the project root 2. Running `git status` to confirm the file is ignored 3. Checking that the file doesn't appear in git tracking docs: add Amazon Nova Canvas availability regions (vercel#6977) The documentation for Amazon Bedrock's `amazon.nova-canvas-v1:0` image model was outdated. It only listed `us-east-1` as the available region, but the model is now available in additional regions. Updated the region availability for the `amazon.nova-canvas-v1:0` image model: * Added `eu-west-1` region * Added `ap-northeast-1` region The model is now documented as available in: `us-east-1`, `eu-west-1`, and `ap-northeast-1`. Add Vercel SDK Provider list (vercel#6863) (vercel#6961) I noticed that in the [Providers and Models docs](https://ai-sdk.dev/docs/foundations/providers-and-models), we mention the Vercel (v0) model in the [Model Capabilities](https://ai-sdk.dev/docs/foundations/providers-and-models#model-capabilities) but not in the [AI SDK Providers](https://ai-sdk.dev/docs/foundations/providers-and-models#ai-sdk-providers). This PR adds the Vercel Provider to the [Providers and Models docs](https://ai-sdk.dev/docs/foundations/providers-and-models#ai-sdk-providers) list. - [x] Formatting issues have been fixed (run `pnpm prettier-fix` in the project root) Co-authored-by: Anshuman Bhardwaj <anshu5074@gmail.com> refactor(adaptive): simplify usage properties by replacing providers array with a single provider string and removing cost_saved to streamline the data structure and improve clarity feat: update readme and changelog
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Background
Documentation for
sendStartwithinstreamTextin v5 is outdated. As of #6499sendStartis used to control whether the start message is sent or not.ai/packages/ai/core/generate-text/stream-text.ts
Lines 1541 to 1550 in 1ed0287
Summary
Removed out-of-date documentation.
Tasks
pnpm prettier-fixin the project root)