Skip to content

Commit 9eb7922

Browse files
github-actions[bot]github-actions[bot]
committed
Deploy documentation: snapshot
1 parent 59c9fd2 commit 9eb7922

372 files changed

Lines changed: 915 additions & 877 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎snapshot/advanced.html‎

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -110,7 +110,7 @@
110110
<ul class="breadcrumb">
111111
<li id="publishDate">Last Published: 2026-02-08<span class="divider">|</span>
112112
</li>
113-
<li id="projectVersion">Version: 1.0.8-SNAPSHOT<span class="divider">|</span></li>
113+
<li id="projectVersion">Version: 1.0.9-SNAPSHOT<span class="divider">|</span></li>
114114
<li><a href="index.html">Home</a><span class="divider">/</span></li>
115115
<li class="active">Advanced Usage</li>
116116
</ul>
@@ -281,7 +281,8 @@ <h2>File Attachments</h2>
281281
).get();
282282
</code></pre><hr /></section><section><a id="Bring_Your_Own_Key_.28BYOK.29"></a>
283283
<h2>Bring Your Own Key (BYOK)</h2>
284-
<p>Use your own OpenAI or Azure OpenAI API key instead of GitHub Copilot.</p>
284+
<p>Use your own OpenAI or Azure OpenAI API key instead of GitHub Copilot.</p><section><a id="API_Key_Authentication"></a>
285+
<h3>API Key Authentication</h3>
285286

286287
<pre class="prettyprint"><code class="language-java">var session = client.createSession(
287288
new SessionConfig()
@@ -290,7 +291,34 @@ <h2>Bring Your Own Key (BYOK)</h2>
290291
.setBaseUrl(&quot;https://api.openai.com/v1&quot;)
291292
.setApiKey(&quot;sk-...&quot;))
292293
).get();
293-
</code></pre><hr /></section><section><a id="Infinite_Sessions"></a>
294+
</code></pre></section><section><a id="Bearer_Token_Authentication"></a>
295+
<h3>Bearer Token Authentication</h3>
296+
<p>Some providers require bearer token authentication instead of API keys:</p>
297+
298+
<pre class="prettyprint"><code class="language-java">var session = client.createSession(
299+
new SessionConfig()
300+
.setProvider(new ProviderConfig()
301+
.setType(&quot;openai&quot;)
302+
.setBaseUrl(&quot;https://my-custom-endpoint.example.com/v1&quot;)
303+
.setBearerToken(System.getenv(&quot;MY_BEARER_TOKEN&quot;)))
304+
).get();
305+
</code></pre>
306+
<blockquote>
307+
308+
<p><strong>Note:</strong> The <code>bearerToken</code> option accepts a <strong>static token string</strong> only. The SDK does not refresh this token automatically. If your token expires, requests will fail and you'll need to create a new session with a fresh token.</p>
309+
</blockquote></section><section><a id="Limitations"></a>
310+
<h3>Limitations</h3>
311+
<p>When using BYOK, be aware of these limitations:</p><section><a id="Identity_Limitations"></a>
312+
<h4>Identity Limitations</h4>
313+
<p>BYOK authentication uses <strong>static credentials only</strong>. The following identity providers are NOT supported:</p>
314+
<ul>
315+
316+
<li>&#x274c; <strong>Microsoft Entra ID (Azure AD)</strong> - No support for Entra managed identities or service principals</li>
317+
<li>&#x274c; <strong>Third-party identity providers</strong> - No OIDC, SAML, or other federated identity</li>
318+
<li>&#x274c; <strong>Managed identities</strong> - Azure Managed Identity is not supported</li>
319+
</ul>
320+
<p>You must use an API key or static bearer token that you manage yourself.</p>
321+
<p><strong>Why not Entra ID?</strong> While Entra ID does issue bearer tokens, these tokens are short-lived (typically 1 hour) and require automatic refresh via the Azure Identity SDK. The <code>bearerToken</code> option only accepts a static string&#x2014;there is no callback mechanism for the SDK to request fresh tokens. For long-running workloads requiring Entra authentication, you would need to implement your own token refresh logic and create new sessions with updated tokens.</p><hr /></section></section></section><section><a id="Infinite_Sessions"></a>
294322
<h2>Infinite Sessions</h2>
295323
<p>Run long conversations without hitting context limits.</p>
296324
<p>When enabled (default), the session automatically compacts older messages as the context window fills up.</p>

‎snapshot/apidocs/allclasses-index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sun Feb 08 02:39:17 UTC 2026 -->
5-
<title>All Classes and Interfaces (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
4+
<!-- Generated by javadoc (17) on Sun Feb 08 03:58:31 UTC 2026 -->
5+
<title>All Classes and Interfaces (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2026-02-08">

‎snapshot/apidocs/allpackages-index.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sun Feb 08 02:39:17 UTC 2026 -->
5-
<title>All Packages (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
4+
<!-- Generated by javadoc (17) on Sun Feb 08 03:58:31 UTC 2026 -->
5+
<title>All Packages (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2026-02-08">

‎snapshot/apidocs/com/github/copilot/sdk/ConnectionState.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sun Feb 08 02:39:17 UTC 2026 -->
5-
<title>ConnectionState (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
4+
<!-- Generated by javadoc (17) on Sun Feb 08 03:58:31 UTC 2026 -->
5+
<title>ConnectionState (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2026-02-08">

‎snapshot/apidocs/com/github/copilot/sdk/CopilotClient.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sun Feb 08 02:39:17 UTC 2026 -->
5-
<title>CopilotClient (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
4+
<!-- Generated by javadoc (17) on Sun Feb 08 03:58:31 UTC 2026 -->
5+
<title>CopilotClient (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2026-02-08">

‎snapshot/apidocs/com/github/copilot/sdk/CopilotSession.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sun Feb 08 02:39:17 UTC 2026 -->
5-
<title>CopilotSession (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
4+
<!-- Generated by javadoc (17) on Sun Feb 08 03:58:31 UTC 2026 -->
5+
<title>CopilotSession (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2026-02-08">

‎snapshot/apidocs/com/github/copilot/sdk/EventErrorHandler.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sun Feb 08 02:39:17 UTC 2026 -->
5-
<title>EventErrorHandler (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
4+
<!-- Generated by javadoc (17) on Sun Feb 08 03:58:31 UTC 2026 -->
5+
<title>EventErrorHandler (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2026-02-08">

‎snapshot/apidocs/com/github/copilot/sdk/EventErrorPolicy.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sun Feb 08 02:39:17 UTC 2026 -->
5-
<title>EventErrorPolicy (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
4+
<!-- Generated by javadoc (17) on Sun Feb 08 03:58:31 UTC 2026 -->
5+
<title>EventErrorPolicy (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2026-02-08">

‎snapshot/apidocs/com/github/copilot/sdk/SdkProtocolVersion.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sun Feb 08 02:39:17 UTC 2026 -->
5-
<title>SdkProtocolVersion (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
4+
<!-- Generated by javadoc (17) on Sun Feb 08 03:58:31 UTC 2026 -->
5+
<title>SdkProtocolVersion (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2026-02-08">

‎snapshot/apidocs/com/github/copilot/sdk/SystemMessageMode.html‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
<!DOCTYPE HTML>
22
<html lang>
33
<head>
4-
<!-- Generated by javadoc (17) on Sun Feb 08 02:39:17 UTC 2026 -->
5-
<title>SystemMessageMode (GitHub Copilot Community SDK :: Java 1.0.8-SNAPSHOT API)</title>
4+
<!-- Generated by javadoc (17) on Sun Feb 08 03:58:31 UTC 2026 -->
5+
<title>SystemMessageMode (GitHub Copilot Community SDK :: Java 1.0.9-SNAPSHOT API)</title>
66
<meta name="viewport" content="width=device-width, initial-scale=1">
77
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
88
<meta name="dc.created" content="2026-02-08">

0 commit comments

Comments
 (0)