Struct CopilotClient

pub struct CopilotClient { /* private fields */ }

Client for interacting with the GitHub Copilot API.

This client handles GitHub token retrieval, fetching available models, and sending API requests for chat completions and embeddings.

Implementations

impl CopilotClient

pub async fn from_env_with_models( editor_version: String, ) -> Result<Self, CopilotError>

Creates a new CopilotClient by retrieving the GitHub token from environment variables or configuration files, and then fetching the list of available models.

Arguments

• editor_version - The version of the editor (e.g., “1.0.0”).

Errors

Returns a CopilotError if the token retrieval or model fetching fails.

pub async fn new_with_models( github_token: String, editor_version: String, ) -> Result<Self, CopilotError>

Creates a new CopilotClient with the provided GitHub token and editor version, and fetches the list of available models.

Arguments

• github_token - The GitHub token for authentication.
• editor_version - The version of the editor.

Errors

Returns a CopilotError if the model fetching fails.

pub async fn get_agents(&self) -> Result<Vec<Agent>, CopilotError>

Fetches the list of agents from the GitHub Copilot API.

Errors

Returns a CopilotError if the HTTP request fails or the response cannot be parsed.

pub async fn get_models(&self) -> Result<Vec<Model>, CopilotError>

Fetches the list of available models from the GitHub Copilot API.

Errors

Returns a CopilotError if the HTTP request fails or the response cannot be parsed.

pub async fn chat_completion( &self, messages: Vec<Message>, model_id: String, ) -> Result<ChatResponse, CopilotError>

Sends a chat completion request to the GitHub Copilot API.

Arguments

• messages - A vector of chat messages to send.
• model_id - The identifier of the model to use.

Errors

Returns a CopilotError::InvalidModel error if the specified model is not available, or another CopilotError if the HTTP request or response parsing fails.

pub async fn get_embeddings( &self, inputs: Vec<String>, ) -> Result<Vec<Embedding>, CopilotError>

Sends an embeddings request to the GitHub Copilot API.

Arguments

• inputs - A vector of input strings to generate embeddings for.

Errors

Returns a CopilotError if the HTTP request fails or the response cannot be parsed.