Skip to main content

Crate opengatellm

Crate opengatellm 

Source
Expand description

Client Rust pour OpenGateLLM, l’API gateway open-source pour LLM self-hosted (DINUM / Etalab).

§Statut

Crate en cours de construction. Endpoints couverts : models, embeddings, chat (+ streaming SSE), rerank, monitoring (health / health/models / metrics) et self-service me/* (info, clés d’API, usage). Compatible OGL >=0.4.5 <0.5.0.

§Exemple

use opengatellm::Client;

let client = Client::new("https://albert.api.etalab.gouv.fr", Some("TOKEN"))?;
let models = client.models().await?;
for m in &models.data {
    println!("{} ({:?})", m.id, m.kind);
}

Re-exports§

pub use chat::Annotation;
pub use chat::AnnotationUrlCitation;
pub use chat::ChatCompletion;
pub use chat::ChatContent;
pub use chat::ChatMessage;
pub use chat::Choice;
pub use chat::ChoiceLogprobs;
pub use chat::ContentPart;
pub use chat::CreateChatCompletion;
pub use chat::CustomDetails;
pub use chat::FinishReason;
pub use chat::FunctionDetails;
pub use chat::ImageUrl;
pub use chat::Role;
pub use chat::ServiceTier;
pub use chat::Stop;
pub use chat::TokenLogprob;
pub use chat::ToolCall;
pub use chat::TopLogprob;
pub use chunks::Chunk;
pub use chunks::Chunks;
pub use client::Client;
pub use client::ClientBuilder;
pub use collections::Collection;
pub use collections::CollectionRequest;
pub use collections::CollectionUpdateRequest;
pub use collections::CollectionVisibility;
pub use collections::Collections;
pub use collections::CollectionsQuery;
pub use common::CarbonFootprintRange;
pub use common::CarbonFootprintUsage;
pub use common::EnvironmentalImpacts;
pub use common::Usage;
pub use documents::CreateDocument;
pub use documents::Document;
pub use documents::DocumentResponse;
pub use documents::Documents;
pub use documents::DocumentsQuery;
pub use embeddings::Embedding;
pub use embeddings::Embeddings;
pub use embeddings::EmbeddingsInput;
pub use embeddings::EmbeddingsRequest;
pub use embeddings::EncodingFormat;
pub use error::Error;
pub use me::CreateKey;
pub use me::CreateKeyResponse;
pub use me::EndpointUsage;
pub use me::Key;
pub use me::Keys;
pub use me::KeysQuery;
pub use me::Limit;
pub use me::LimitType;
pub use me::MetricsUsage;
pub use me::PermissionType;
pub use me::UpdateUserInfo;
pub use me::UsageDetail;
pub use me::UsageQuery;
pub use me::UsageRecord;
pub use me::Usages;
pub use me::UserInfo;
pub use models::Model;
pub use models::ModelCosts;
pub use models::ModelType;
pub use models::ModelsResponse;
pub use monitoring::Health;
pub use monitoring::HealthStatus;
pub use monitoring::ModelHealthStatus;
pub use monitoring::ModelsHealthResponse;
pub use rerank::CreateRerankBody;
pub use rerank::RerankResponse;
pub use rerank::RerankResult;
pub use search::CreateSearch;
pub use search::Search;
pub use search::SearchMethod;
pub use search::Searches;
pub use stream::ChatCompletionChunk;
pub use stream::ChoiceDelta;
pub use stream::ChoiceDeltaToolCall;
pub use stream::ChoiceDeltaToolCallFunction;
pub use stream::ChunkChoice;

Modules§

chat
Endpoint POST /v1/chat/completions (non-streaming).
chunks
Endpoints chunks : GET /v1/chunks/{document} et GET /v1/chunks/{document}/{chunk}.
client
Client HTTP de base.
collections
Endpoints /v1/collections (CRUD des collections RAG).
common
Types partagés entre modules (usage de tokens, empreinte environnementale).
documents
Endpoints /v1/documents (ingestion et gestion des documents RAG).
embeddings
Endpoint POST /v1/embeddings.
error
Erreurs renvoyées par le client.
me
Endpoints self-service /v1/me/* : informations, clés d’API, usage.
models
Endpoints /v1/models et /v1/models/{model}.
monitoring
Endpoints de monitoring : GET /health, GET /health/models, GET /metrics.
rerank
Endpoint POST /v1/rerank.
search
Endpoint POST /v1/search (recherche RAG).
stream
Streaming SSE pour POST /v1/chat/completions (stream: true).