Expand description
This module provides traits for defining and creating provider clients. Clients are used to create models for completion, embeddings, etc.
Modules§
Structs§
- Bearer
Auth - An API key which will be inserted into a
Client’s default headers as a bearer auth token - Capable
- A wrapper type providing runtime checks on a provider’s capabilities via the Capability trait
- Client
- Generic provider client shared by Rig provider integrations.
- Client
Builder - Type-state builder for
Client. - Nothing
- A type containing nothing at all. For
Option-like behavior on the type level, i.e. to describe the lack of a capability or field (an API key, for instance)
Enums§
- Client
Builder Error - Provider
Client Error - Errors returned while constructing provider clients from environment variables or explicit input.
- Transport
- Verify
Error - Errors from provider client verification.
Traits§
- ApiKey
- A trait for API key inputs accepted by
ClientBuilder::api_key. - Capabilities
- The capabilities of a given provider, i.e. embeddings, audio transcriptions, text completion
- Capability
- Type-level marker for whether a provider supports a capability.
- Completion
Client - A provider client with completion capabilities. Clone is required for conversions between client types.
- Debug
Ext - Provider extension hook for redacted
Debugoutput. - Embeddings
Client - A provider client with embedding capabilities. Clone is required for conversions between client types.
- Model
Lister - A trait for implementing model listing logic for a specific provider.
- Model
Listing Client - A provider client with model listing capabilities.
- Provider
- An API provider extension, this abstracts over extensions which may be used in conjunction with
the
Client<Ext, H>struct to define the behavior of a provider with respect to networking, auth, instantiating models - Provider
Builder - An API provider extension builder, this abstracts over provider-specific builders which are able to configure and produce a given provider’s extension type
- Provider
Client - Abstracts over the ability to instantiate a client, either via environment variables or some
Self::Input - Reranking
Client - A provider client with reranking capabilities.
- Verify
Client - A provider client that can verify the configuration. Clone is required for conversions between client types.
Functions§
- optional_
env_ var - Read an optional environment variable for provider client construction.
- required_
env_ var - Read a required environment variable for provider client construction.
Type Aliases§
- Provider
Client Result - Result type returned by provider client construction helpers.