Struct cohere_rust::Cohere

pub struct Cohere { /* private fields */ }

Cohere Rust SDK to build natural language understanding and generation into your product with a few lines of code.

Implementations

impl Cohere

pub fn new<U: Into<String>, K: Into<String>, V: Into<String>>( api_url: U, api_key: K, version: V ) -> Self

pub async fn check_api_key(&self) -> Result<(), CohereApiError>

Verify that the Cohere API key being used is valid

pub async fn generate<'input>( &self, request: &GenerateRequest<'input> ) -> Result<Vec<Generation>, CohereApiError>

Generates realistic text conditioned on a given input.

pub async fn chat<'input>( &self, request: &ChatRequest<'input> ) -> Result<Receiver<Result<ChatStreamResponse, CohereStreamError>>, CohereApiError>

Chat with Cohere’s LLM

pub async fn embed<'input>( &self, request: &EmbedRequest<'input> ) -> Result<Vec<Vec<f64>>, CohereApiError>

Returns text embeddings. An embedding is a list of floating point numbers that captures semantic information about the text that it represents. Embeddings can be used to create text classifiers as well as empower semantic search.

pub async fn classify<'input>( &self, request: &ClassifyRequest<'input> ) -> Result<Vec<Classification>, CohereApiError>

Makes a prediction about which label fits the specified text inputs best. To make a prediction, classify uses the provided examples of text + label pairs as a reference.

pub async fn summarize<'input>( &self, request: &SummarizeRequest<'input> ) -> Result<String, CohereApiError>

Generates a summary in English for a given text.

pub async fn tokenize<'input>( &self, request: &TokenizeRequest<'input> ) -> Result<TokenizeResponse, CohereApiError>

Splits input text into smaller units called tokens using byte-pair encoding (BPE).

pub async fn detokenize<'input>( &self, request: &DetokenizeRequest<'input> ) -> Result<String, CohereApiError>

Takes tokens using byte-pair encoding and returns their text representation.

pub async fn detect_language<'input>( &self, request: &DetectLanguageRequest<'input> ) -> Result<Vec<DetectLanguageResult>, CohereApiError>

Identifies which language each of the provided texts is written in

pub async fn rerank<'input>( &self, request: &ReRankRequest<'input> ) -> Result<Vec<ReRankResult>, CohereApiError>

Takes a query plus an list of texts and return an ordered array with each text assigned a relevance score.

Trait Implementations

impl Default for Cohere

fn default() -> Self

Returns the “default value” for a type.