api_huggingface 0.4.1

HuggingFace's API for accessing large language models (LLMs) and embeddings.
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

//! Output handling and response processing for `HuggingFace` API.

use serde::{ Deserialize, Serialize };
use super::wire_types::ResponseMetadata;

/// Base response structure for `HuggingFace` inference
#[ derive( Debug, Clone, Serialize, Deserialize ) ]
pub struct InferenceOutput
{
  /// Generated text
  pub generated_text : String,
  
  /// Input tokens (if available)
  #[ serde( skip_serializing_if = "Option::is_none" ) ]
  pub input_tokens : Option< u32 >,
  
  /// Generated tokens (if available)
  #[ serde( skip_serializing_if = "Option::is_none" ) ]
  pub generated_tokens : Option< u32 >,
  
  /// Response metadata
  #[ serde( skip_serializing_if = "Option::is_none" ) ]
  pub metadata : Option< ResponseMetadata >,
}

/// Batch inference response containing multiple outputs
#[ derive( Debug, Clone, Serialize, Deserialize ) ]
pub struct BatchInferenceOutput
{
  /// List of inference outputs
  pub outputs : Vec< InferenceOutput >,
  
  /// Response metadata
  #[ serde( skip_serializing_if = "Option::is_none" ) ]
  pub metadata : Option< ResponseMetadata >,
}

/// Streaming token response
#[ derive( Debug, Clone, Serialize, Deserialize ) ]
pub struct StreamToken
{
  /// Token text
  pub token : String,
  
  /// Token id
  #[ serde( skip_serializing_if = "Option::is_none" ) ]
  pub id : Option< u32 >,
  
  /// Log probability
  #[ serde( skip_serializing_if = "Option::is_none" ) ]
  pub logprob : Option< f32 >,
  
  /// Whether this is the final token
  #[ serde( skip_serializing_if = "Option::is_none" ) ]
  pub is_final : Option< bool >,
}

/// Embedding output for feature extraction
#[ derive( Debug, Clone, Serialize, Deserialize ) ]
pub struct EmbeddingOutput
{
  /// Embedding vector
  pub embedding : Vec< f32 >,
  
  /// Input text length
  #[ serde( skip_serializing_if = "Option::is_none" ) ]
  pub input_length : Option< u32 >,
  
  /// Response metadata
  #[ serde( skip_serializing_if = "Option::is_none" ) ]
  pub metadata : Option< ResponseMetadata >,
}

/// Batch embedding response
#[ derive( Debug, Clone, Serialize, Deserialize ) ]
pub struct BatchEmbeddingOutput
{
  /// List of embeddings
  pub embeddings : Vec< EmbeddingOutput >,
  
  /// Response metadata
  #[ serde( skip_serializing_if = "Option::is_none" ) ]
  pub metadata : Option< ResponseMetadata >,
}