Skip to content

Commit 23338c6

Browse files
docs-botsunbryeCopilotgithub-actions[bot]
authored
Sync Copilot SDK docs (auto-generated) (#62003)
Co-authored-by: sunbrye <sunbrye@github.com> Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent fb30ff6 commit 23338c6

21 files changed

Lines changed: 302 additions & 128 deletions
3 Bytes
Loading
6 Bytes
Loading
2.25 KB
Loading
2 KB
Loading
16.9 KB
Loading

content/copilot/how-tos/copilot-sdk/auth/byok.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -413,7 +413,7 @@ func main() {
413413
Name: "My Custom Model",
414414
Capabilities: copilot.ModelCapabilities{
415415
Supports: copilot.ModelSupports{Vision: false, ReasoningEffort: false},
416-
Limits: copilot.ModelLimits{MaxContextWindowTokens: 128000},
416+
Limits: copilot.ModelLimits{MaxContextWindowTokens: copilot.Int(128000)},
417417
},
418418
},
419419
}, nil
@@ -479,7 +479,7 @@ When using BYOK, be aware of these limitations:
479479

480480
### Identity limitations
481481

482-
BYOK authentication uses **static credentials only**.
482+
BYOK authentication uses **static credentials only**.
483483

484484
You must use an API key or static bearer token that you manage yourself.
485485

content/copilot/how-tos/copilot-sdk/features/cloud-sessions.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,10 @@
22
title: Cloud sessions
33
shortTitle: Cloud Sessions
44
intro: >-
5-
Run Copilot sessions on GitHub-hosted compute through Mission Control instead
6-
of local CLI sessions.
5+
Cloud sessions run Copilot work on GitHub-hosted compute through Mission
6+
Control. Use them when your app should create a session that executes remotely
7+
instead of starting a local Copilot CLI session on the user's machine or your
8+
server.
79
versions:
810
fpt: '*'
911
ghec: '*'

content/copilot/how-tos/copilot-sdk/features/custom-agents.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,8 @@ title: Custom agents and sub-agent orchestration
33
shortTitle: Custom Agents
44
intro: >-
55
Define specialized agents with scoped tools and prompts, then let Copilot
6-
orchestrate them as sub-agents within a single session.
6+
orchestrate them as sub-agents within a single session. For dispatching
7+
multiple sub-agents in parallel, see [AUTOTITLE](/copilot/how-tos/copilot-sdk/features/fleet-mode).
78
versions:
89
fpt: '*'
910
ghec: '*'

content/copilot/how-tos/copilot-sdk/features/fleet-mode.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,13 @@
22
title: Fleet mode
33
shortTitle: Fleet Mode
44
intro: >-
5-
Use fleet mode to split work across multiple sub-agents and combine their
6-
results in one parent session.
5+
Fleet mode is Copilot's parallel orchestration pattern for work that can be
6+
split across independent sub-agents. In the runtime research notes, fleet mode
7+
is described as "the runtime's built-in pattern for dispatching multiple
8+
sub-agents in parallel via the `task` tool, with SQL todos as the shared
9+
coordination state." Use it when one parent session should coordinate several
10+
workers, collect their results, and continue the conversation with the
11+
combined context.
712
versions:
813
fpt: '*'
914
ghec: '*'
@@ -59,7 +64,7 @@ if (result.started) {
5964
{% codetab python %}
6065

6166
```python
62-
from copilot.generated.rpc import FleetStartRequest
67+
from copilot.rpc import FleetStartRequest
6368

6469
result = await session.rpc.fleet.start(
6570
FleetStartRequest(
@@ -151,7 +156,7 @@ if (result.Started)
151156
{% codetab rust %}
152157

153158
```rust
154-
use github_copilot_sdk::generated::api_types::FleetStartRequest;
159+
use github_copilot_sdk::rpc::FleetStartRequest;
155160

156161
let result = session
157162
.rpc()

content/copilot/how-tos/copilot-sdk/features/image-input.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -326,7 +326,7 @@ func main() {
326326
Prompt: "Describe what you see in this image",
327327
Attachments: []copilot.Attachment{
328328
&copilot.AttachmentBlob{
329-
Data: base64ImageData,
329+
Data: &base64ImageData,
330330
MIMEType: mimeType,
331331
DisplayName: &displayName,
332332
},
@@ -342,7 +342,7 @@ session.Send(ctx, copilot.MessageOptions{
342342
Prompt: "Describe what you see in this image",
343343
Attachments: []copilot.Attachment{
344344
&copilot.AttachmentBlob{
345-
Data: base64ImageData, // base64-encoded string
345+
Data: &base64ImageData, // base64-encoded string
346346
MIMEType: mimeType,
347347
DisplayName: &displayName,
348348
},

0 commit comments

Comments
 (0)