Class CopilotLanguageModel

Language model implementation for GitHub Copilot. Uses the OpenAI SDK to communicate with the Copilot API.

Implements

LanguageModel

Constructors

constructor

new CopilotLanguageModel(
    id: string,
    model: string,
    status: LanguageModelStatus,
    enableStreaming: boolean,
    supportsStructuredOutput: boolean,
    maxRetries: number,
    accessTokenProvider: () => Promise<undefined | string>,
    enterpriseUrlProvider: () => undefined | string,
    userAgentProvider: () => string,
): CopilotLanguageModel
Parameters
- id: string
- model: string
- status: LanguageModelStatus
- enableStreaming: boolean
- supportsStructuredOutput: boolean
- maxRetries: number
- accessTokenProvider: () => Promise<undefined | string>
- enterpriseUrlProvider: () => undefined | string
- userAgentProvider: () => string
Returns CopilotLanguageModel
- Defined in packages/ai-copilot/src/node/copilot-language-model.ts:47

Properties

`Protected` `Readonly`accessTokenProvider

accessTokenProvider: () => Promise<undefined | string>

enableStreaming

enableStreaming: boolean

`Protected` `Readonly`enterpriseUrlProvider

enterpriseUrlProvider: () => undefined | string

`Readonly`id

id: string

maxRetries

maxRetries: number

model

model: string

`Protected`runnerOptions

runnerOptions: RunnerOptions = ...

status

status: LanguageModelStatus

supportsStructuredOutput

supportsStructuredOutput: boolean

`Protected` `Readonly`userAgentProvider

userAgentProvider: () => string

Methods

`Protected`createTools

createTools(
request: LanguageModelRequest,
): undefined | RunnableToolFunctionWithoutParse[]
Parameters
- request: LanguageModelRequest
Returns undefined | RunnableToolFunctionWithoutParse[]
- Defined in packages/ai-copilot/src/node/copilot-language-model.ts:155

`Protected`getSettings

getSettings(request: LanguageModelRequest): Record<string, unknown>
Parameters
- request: LanguageModelRequest
Returns Record<string, unknown>
- Defined in packages/ai-copilot/src/node/copilot-language-model.ts:59

`Protected`handleNonStreamingRequest

handleNonStreamingRequest(
openai: OpenAI,
request: UserRequest,
): Promise<LanguageModelTextResponse>
Parameters
- openai: OpenAI
- request: UserRequest
Returns Promise<LanguageModelTextResponse>
- Defined in packages/ai-copilot/src/node/copilot-language-model.ts:112

`Protected`handleStructuredOutputRequest

handleStructuredOutputRequest(
openai: OpenAI,
request: UserRequest,
): Promise<LanguageModelParsedResponse>
Parameters
- openai: OpenAI
- request: UserRequest
Returns Promise<LanguageModelParsedResponse>
- Defined in packages/ai-copilot/src/node/copilot-language-model.ts:131

`Protected`initializeCopilotClient

initializeCopilotClient(): Promise<OpenAI>
Returns Promise<OpenAI>
- Defined in packages/ai-copilot/src/node/copilot-language-model.ts:167

`Protected`processMessages

processMessages(messages: LanguageModelMessage[]): ChatCompletionMessageParam[]
Parameters
- messages: LanguageModelMessage[]
Returns ChatCompletionMessageParam[]
- Defined in packages/ai-copilot/src/node/copilot-language-model.ts:186

request

request(
request: UserRequest,
cancellationToken?: CancellationToken,
): Promise<LanguageModelResponse>
Parameters
- request: UserRequest
- OptionalcancellationToken: CancellationToken
Returns Promise<LanguageModelResponse>
Implementation of LanguageModel.request
- Defined in packages/ai-copilot/src/node/copilot-language-model.ts:63

`Protected`toOpenAIMessage

toOpenAIMessage(message: LanguageModelMessage): ChatCompletionMessageParam
Parameters
- message: LanguageModelMessage
Returns ChatCompletionMessageParam
- Defined in packages/ai-copilot/src/node/copilot-language-model.ts:190

`Protected`toOpenAiRole

toOpenAiRole(
message: LanguageModelMessage,
): "developer" | "user" | "assistant" | "system"
Parameters
- message: LanguageModelMessage
Returns "developer" | "user" | "assistant" | "system"
- Defined in packages/ai-copilot/src/node/copilot-language-model.ts:233

Class CopilotLanguageModel

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns CopilotLanguageModel

Properties

Protected ReadonlyaccessTokenProvider

enableStreaming

Protected ReadonlyenterpriseUrlProvider

Readonlyid

maxRetries

model

ProtectedrunnerOptions

status

supportsStructuredOutput

Protected ReadonlyuserAgentProvider

Methods

ProtectedcreateTools

Parameters

Returns undefined | RunnableToolFunctionWithoutParse[]

ProtectedgetSettings

Parameters

Returns Record<string, unknown>

ProtectedhandleNonStreamingRequest

Parameters

Returns Promise<LanguageModelTextResponse>

ProtectedhandleStructuredOutputRequest

Parameters

Returns Promise<LanguageModelParsedResponse>

ProtectedinitializeCopilotClient

Returns Promise<OpenAI>

ProtectedprocessMessages

Parameters

Returns ChatCompletionMessageParam[]

request

Parameters

Returns Promise<LanguageModelResponse>

ProtectedtoOpenAIMessage

Parameters

Returns ChatCompletionMessageParam

ProtectedtoOpenAiRole

Parameters

Returns "developer" | "user" | "assistant" | "system"

Settings

On This Page

`Protected` `Readonly`accessTokenProvider

`Protected` `Readonly`enterpriseUrlProvider

`Readonly`id

`Protected`runnerOptions

`Protected` `Readonly`userAgentProvider

`Protected`createTools

`Protected`getSettings

`Protected`handleNonStreamingRequest

`Protected`handleStructuredOutputRequest

`Protected`initializeCopilotClient

`Protected`processMessages

`Protected`toOpenAIMessage

`Protected`toOpenAiRole