Skip to content

docs: clarify BYOK reasoning content #1352

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

Open
Herrtian wants to merge 1 commit into
base: main
Choose a base branch
from
+12 −0
Open

docs: clarify BYOK reasoning content #1352

Show file tree
Hide file tree
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: 10 additions & 0 deletions docs/auth/byok.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -490,6 +490,16 @@ Some Copilot features may behave differently with BYOK:
* **Usage tracking** - Usage is tracked by your provider, not GitHub Copilot
* **Premium requests** - Do not count against Copilot premium request quotas

### Reasoning content

Reasoning content is provider-specific:

| Provider | Behavior |
|----------|----------|
| OpenAI / Azure OpenAI | Readable reasoning text is not returned for Responses API calls; `assistant.reasoning` events may have empty `content`, and encrypted reasoning is available on `assistant.message.encryptedContent` for the same session |
| Anthropic | Readable reasoning text may be exposed through `assistant.reasoning` events and `assistant.message.reasoningText`; encrypted reasoning may be available as `reasoningOpaque` |
| OpenAI-compatible providers such as vLLM | Plaintext reasoning depends on the model and server response format |

### Provider-specific limitations

| Provider | Limitations |
Expand Down
2 changes: 2 additions & 0 deletions docs/features/streaming-events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -254,6 +254,8 @@ Ephemeral. Incremental chunk of the model's extended thinking, streamed in real
| `reasoningId` | `string` | ✅ | Matches the corresponding `assistant.reasoning` event |
| `deltaContent` | `string` | ✅ | Text chunk to append to reasoning content |

For OpenAI BYOK providers, these events may be emitted with empty `content` or `deltaContent` because readable reasoning text is not returned. Encrypted reasoning is available on the `assistant.message` event as `encryptedContent` for the same session.

### `assistant.message`

The assistant's complete response for this LLM call. May include tool invocation requests.
Expand Down