huggingface_client library

Classes

Accelerator
Compute accelerator
AcceleratorTypeTransformer
Transformation class that can encode an instance of Accelerator to String, and decode dynamic data back to Accelerator.
ApiClient
ApiKeyAuth
ApiQueryChatCompletion
This task corresponds to any chatbot like structure. Models tend to have shorter max_length, so please check with caution when using a given model if you need long range dependency or not.
ApiQueryNLPConversational
This task corresponds to any chatbot like structure. Models tend to have shorter max_length, so please check with caution when using a given model if you need long range dependency or not.
ApiQueryNLPFeatureExtraction
This task reads some text and outputs raw float values, that are usually consumed as part of a semantic database/semantic search.
ApiQueryNLPFillMask
Tries to fill in a hole with a missing word (token to be precise). That’s the base task for BERT models.
ApiQueryNLPQA
Want to have a nice know-it-all bot that can answer any question?
ApiQueryNLPSentenceSimilarity
Calculate the semantic similarity between one text and a list of other sentences by comparing their embeddings.
ApiQueryNLPSummarisation
This task is well known to summarize longer text into shorter text. Be careful, some models have a maximum length of input. That means that the summary cannot handle full books for instance. Be careful when choosing your model.
ApiQueryNLPTableQA
Want to have a nice know-it-all bot that can answer any question?
ApiQueryNLPTextClassification
Usually used for sentiment-analysis this will output the likelihood of classes of an input.
ApiQueryNLPTextGeneration
Use to continue text from a prompt. This is a very generic task.
ApiQueryNLPTokenClassification
Usually used for sentence parsing, either grammatical, or Named Entity Recognition (NER) to understand keywords contained within text.
ApiQueryNLPTranslation
This task is well known to translate text from one language to another.
ApiQueryNLPZeroShotClassification
This task is super useful to try out classification with zero code, you simply pass a sentence/paragraph and the possible labels for that sentence, and you get a result.
ApiQuestionContext
ApiResponseAudioASR
ApiResponseAudioClassification
ApiResponseError
ApiResponseNLPChatCompletion
ApiResponseNLPConversational
ApiResponseNLPFeatureExtraction
ApiResponseNLPFillMask
ApiResponseNLPQA
ApiResponseNLPSentenceSimilarity
ApiResponseNLPSummarisation
ApiResponseNLPTableQA
ApiResponseNLPTextClassification
ApiResponseNLPTextGeneration
ApiResponseNLPTokenClassification
ApiResponseNLPTranslation
ApiResponseNLPZeroShotClassification
ApiResponseQueryStandard
ApiResponseTextToImage
ApiResponseVisionImageClassification
ApiResponseVisionImageSegmentation
ApiResponseVisionObjectDetection
ApiTableQuery
Authentication
BaseClient
The abstract base class for an HTTP client.
BaseRequest
The base class for HTTP requests.
BaseResponse
The base class for HTTP responses.
ByteStream
A stream of chunks of bytes representing a single piece of data.
ChatStreamResponse
Client
The interface for HTTP clients that take care of maintaining persistent connections across multiple requests to the same server.
Compute
ComputeList
Conversation
Delta
DeserializationMessage
Primarily intended for use in an isolate.
Endpoint
EndpointAccelerator
Endpoint accelerator
EndpointAcceleratorTypeTransformer
Transformation class that can encode an instance of EndpointAccelerator to String, and decode dynamic data back to EndpointAccelerator.
EndpointAccount
EndpointApi
The inference endpoint API
EndpointApiClient
The Inference endpoint API client just extends the Open API client
EndpointCompute
EndpointComputeUpdate
EndpointFramework
EndpointFrameworkTypeTransformer
Transformation class that can encode an instance of EndpointFramework to String, and decode dynamic data back to EndpointFramework.
EndpointImageCredentials
EndpointModel
EndpointModelImage
EndpointModelImageOneOf
EndpointModelImageOneOf1
EndpointModelImageOneOf1Custom
EndpointModelImageUpdate
EndpointModelImageUpdateOneOf
EndpointModelImageUpdateOneOfCustom
EndpointModelUpdate
EndpointProvider
EndpointProviderApi
The inference endpoint provider API
EndpointProviderApiClient
The Inference endpoint provider API client just extends the Open API client
EndpointScaling
EndpointScalingUpdate
EndpointState
State of the endpoint
EndpointStateTypeTransformer
Transformation class that can encode an instance of EndpointState to String, and decode dynamic data back to EndpointState.
EndpointStatus
EndpointStatusPrivate
EndpointTask
EndpointTaskTypeTransformer
Transformation class that can encode an instance of EndpointTask to String, and decode dynamic data back to EndpointTask.
EndpointType
Endpoint type. Public mean , private mean accessible only via a VPC
EndpointTypeTypeTransformer
Transformation class that can encode an instance of EndpointType to String, and decode dynamic data back to EndpointType.
EndpointUpdate
EndpointWithStatus
EndpointWithStatusList
HttpBasicAuth
HttpBearerAuth
HuggingFaceClient
Hugging Face client class. Provides a thin wrapper around the Open API implementation.
ImageBox
Represents the bounding box of a detected object.
InferenceApi
InferenceApiClient
InferenceConversation
A facility dictionary to send back for the next input (with the new user input addition).
InferenceOptions
Common inference options
Message
A facility dictionary to send back for the next input (with the new user input addition).
MetricName
MetricNameTypeTransformer
Transformation class that can encode an instance of MetricName to String, and decode dynamic data back to MetricName.
MetricsParams
MultipartFile
A file to be uploaded as part of a MultipartRequest.
MultipartRequest
A multipart/form-data request.
OAuth
QueryParam
Region
RegionList
Request
An HTTP request where the entire request body is known in advance.
Response
An HTTP response where the entire response body is known in advance.
Status
Resource status
StatusTypeTransformer
Transformation class that can encode an instance of Status to String, and decode dynamic data back to Status.
StreamedRequest
An HTTP request where the request body is sent asynchronously after the connection has been established and the headers have been sent.
StreamedResponse
An HTTP response where the response body is received asynchronously after the headers have been received.
TextGenerationStreamResponse
Unsafe
V1endpointApi
V1providerApi
V2endpointApi
V2providerApi
Vendor
VendorList
Vendors

Properties

defaultApiClient ↔ ApiClient
getter/setter pair
defaultInferenceApiClient ↔ InferenceApiClient
getter/setter pair

Functions

delete(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP DELETE request with the given headers to the given URL.
deserializeAsync(DeserializationMessage message) → Future
Primarily intended for use in an isolate.
get(Uri url, {Map<String, String>? headers}) → Future<Response>
Sends an HTTP GET request with the given headers to the given URL.
Sends an HTTP HEAD request with the given headers to the given URL.
mapCastOfType<K, V>(dynamic map, String key) → Map<K, V>?
Returns a valid Map<K, V> found at the specified Map key, null otherwise.
mapDateTime(dynamic map, String key, [String? pattern]) → DateTime?
Returns a valid DateTime found at the specified Map key, null otherwise.
mapValueOfType<T>(dynamic map, String key) → T?
Returns a valid T value found at the specified Map key, null otherwise.
mapValueOfTypeWithDefault<T>(dynamic map, String key, T defaultValue) → T?
Returns a valid T value found at the specified Map key, if no key is found the supplied default is used.
parameterToString(dynamic value) → String
Format the given parameter object into a String.
patch(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP PATCH request with the given headers and body to the given URL.
post(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP POST request with the given headers and body to the given URL.
put(Uri url, {Map<String, String>? headers, Object? body, Encoding? encoding}) → Future<Response>
Sends an HTTP PUT request with the given headers and body to the given URL.
read(Uri url, {Map<String, String>? headers}) → Future<String>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a String.
readBytes(Uri url, {Map<String, String>? headers}) → Future<Uint8List>
Sends an HTTP GET request with the given headers to the given URL and returns a Future that completes to the body of the response as a list of bytes.
runWithClient<R>(R body(), Client clientFactory(), {ZoneSpecification? zoneSpecification}) → R
Runs body in its own Zone with the Client returned by clientFactory set as the default Client.
serializeAsync(Object? value) → Future<String>
Primarily intended for use in an isolate.

Typedefs

HttpBearerAuthProvider = String Function()

Exceptions / Errors

ApiException
ClientException
An exception caused by an error in a pkg/http client.