Struct Copilot 

pub struct Copilot { /* private fields */ }

GitHub Copilot: its CopilotConfig on a transport. Every model it builds sends through that transport.

Implementations

impl Copilot

pub fn with_http(self, http: impl HttpClientExt + 'static) -> Self

The same configuration, sending through http.

pub fn config(&self) -> &CopilotConfig

The configuration this client sends with.

impl Copilot

pub fn new(api_key: impl Into<Secret>) -> Self

Available on crate feature reqwest only.

Copilot with an exchanged session token, on the shared reqwest client. See CopilotConfig::new for how the endpoint is chosen.

pub fn from_env() -> Result<Self, EnvError>

Available on crate feature reqwest only.

Copilot from the environment (CopilotConfig::from_env), on the shared reqwest client. This does not exchange a token.

pub fn completion(&self, model: impl Into<String>) -> Model<CopilotWire>

The completion model for model, on whichever route answers it.

pub fn embedding( &self, model: impl Into<String>, ndims: Option<usize>, ) -> Model<Embeddings>

The embedding model for model, ndims wide when set.

pub async fn list_models(&self) -> Result<ModelList, ProviderError>

The models this session can use.

pub async fn authenticate( self, authenticator: &Authenticator, ) -> Result<Self, AuthError>

A client on this client’s transport, configured with the session authenticator resolves: the device login, the GitHub token exchange and the refresh all send through this client’s transport. The session token replaces the credential; the API root is the one the exchange names, unless this client’s was set explicitly.

use rig_core::providers::copilot::{CopilotConfig, auth::{AuthSource, Authenticator, DeviceCodeHandler}};

let authenticator = Authenticator::new(AuthSource::OAuth, None, None, DeviceCodeHandler::default(), true);
let copilot = CopilotConfig::new("").connect(http).authenticate(&authenticator).await?;

Trait Implementations

impl Clone for Copilot

fn clone(&self) -> Self

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

Formats the value using the given formatter.