Struct GroqClient

pub struct GroqClient { /* private fields */ }

An client for interacting with the Groq API.

Parameters

• api_key: The API key for authenticating with the Groq API.
• endpoint: The URL of the Groq API endpoint. If not provided, it defaults to https://api.groq.com/openai/v1.

Returns

An instance of GroqClient configured with the provided API key and endpoint.

Example

 use groq_client::GroqClient;

 let client = GroqClient::new("my_api_key".to_string(), None);

Implementations

impl GroqClient

pub fn new(api_key: String, endpoint: Option<String>) -> Self

Constructs a new GroqClient instance with the provided API key and optional endpoint.

Parameters

• api_key: The API key for authenticating with the Groq API.
• endpoint: The URL of the Groq API endpoint. If not provided, it defaults to https://api.groq.com/openai/v1.

Returns

A new GroqClient instance configured with the provided API key and endpoint.

pub fn speech_to_text( &self, request: SpeechToTextRequest, ) -> Result<SpeechToTextResponse, GroqError>

Sends a speech-to-text request to the Groq API and returns the parsed response.

Parameters

• request: A SpeechToTextRequest containing the necessary parameters for the speech-to-text request.

Returns

The parsed SpeechToTextResponse from the Groq API.

Errors

Returns a GroqError if there is an issue sending the request or parsing the response.

pub fn chat_completion( &self, request: ChatCompletionRequest, ) -> Result<ChatCompletionResponse, GroqError>

Sends a chat completion request to the GROQ API and returns the response.

Parameters

• request - A ChatCompletionRequest containing the details of the chat completion request.

Errors

Returns a GroqError if there is an issue sending the request or parsing the response.