Struct Copilot 

pub struct Copilot { /* private fields */ }

GitHub Copilot language model client.

Uses the OpenAI-compatible chat completions API at api.githubcopilot.com.

Implementations

impl Copilot

pub fn new(token: impl Into<String>) -> Copilot

Create a new Copilot client with the given OAuth token.

pub fn builder(token: impl Into<String>) -> Builder

Create a builder for configuring the Copilot client.

pub fn with_model(self, model: impl Into<String>) -> Copilot

Override the default chat model.

pub fn with_base_url(self, base_url: impl Into<String>) -> Copilot

Override the REST base URL.

pub fn with_oauth_token(self, token: impl Into<String>) -> Copilot

Provide an OAuth token so the client can refresh session tokens on 401s.

Trait Implementations

impl Clone for Copilot

fn clone(&self) -> Copilot

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Copilot

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl From<Copilot> for CloudProvider

fn from(client: Copilot) -> Self

Converts to this type from the input type.

impl LanguageModel for Copilot

type Error = CopilotError

The error type returned by this language model.

fn respond( &self, request: LLMRequest, ) -> impl Stream<Item = Result<Event, <Copilot as LanguageModel>::Error>> + Send

Generates a streaming response to a conversation.

fn profile( &self, ) -> impl Future<Output = Result<Profile, <Copilot as LanguageModel>::Error>> + Send

Returns model profile and capabilities.

fn respond_with_tools( &self, request: LLMRequestWithTools<'_>, ) -> impl Stream<Item = Result<Event, Self::Error>> + Send

Generates a streaming response with a mutable tool registry.

fn generate<T>( &self, request: LLMRequest, ) -> impl Future<Output = Result<T, GenerateError<Self::Error>>> + Send

where T: JsonSchema + DeserializeOwned + 'static,

Generates structured output conforming to JSON schema.

fn complete( &self, prefix: &str, ) -> impl Stream<Item = Result<Event, Self::Error>> + Send

Completes given text prefix.

fn summarize( &self, text: &str, ) -> impl Stream<Item = Result<Event, Self::Error>> + Send

Summarizes text.

fn categorize<T>( &self, text: &str, ) -> impl Future<Output = Result<T, GenerateError<Self::Error>>> + Send

where T: JsonSchema + DeserializeOwned + 'static,

Categorizes text.

fn retry_policy(&self) -> RetryPolicy

How a request to this model that failed with a retryable failure is sent again.