@huggingface/tasks 0.13.5 → 0.13.6

package/src/snippets/js.ts

@@ -10,7 +10,7 @@ export const snippetBasic = (model: ModelDataMinimal, accessToken: string): Infe
 		"https://api-inference.huggingface.co/models/${model.id}",
 		{
 			headers: {
-				Authorization: "Bearer ${accessToken || `{API_TOKEN}`}"
+				Authorization: "Bearer ${accessToken || `{API_TOKEN}`}",
 				"Content-Type": "application/json",
 			},
 			method: "POST",
@@ -151,7 +151,7 @@ export const snippetZeroShotClassification = (model: ModelDataMinimal, accessTok
 		"https://api-inference.huggingface.co/models/${model.id}",
 		{
 			headers: {
-				Authorization: "Bearer ${accessToken || `{API_TOKEN}`}"
+				Authorization: "Bearer ${accessToken || `{API_TOKEN}`}",
 				"Content-Type": "application/json",
 			},
 			method: "POST",
@@ -175,7 +175,7 @@ export const snippetTextToImage = (model: ModelDataMinimal, accessToken: string)
 		"https://api-inference.huggingface.co/models/${model.id}",
 		{
 			headers: {
-				Authorization: "Bearer ${accessToken || `{API_TOKEN}`}"
+				Authorization: "Bearer ${accessToken || `{API_TOKEN}`}",
 				"Content-Type": "application/json",
 			},
 			method: "POST",
@@ -196,7 +196,7 @@ export const snippetTextToAudio = (model: ModelDataMinimal, accessToken: string)
 			"https://api-inference.huggingface.co/models/${model.id}",
 			{
 				headers: {
-					Authorization: "Bearer ${accessToken || `{API_TOKEN}`}"
+					Authorization: "Bearer ${accessToken || `{API_TOKEN}`}",
 					"Content-Type": "application/json",
 				},
 				method: "POST",
@@ -238,7 +238,7 @@ export const snippetFile = (model: ModelDataMinimal, accessToken: string): Infer
 		"https://api-inference.huggingface.co/models/${model.id}",
 		{
 			headers: {
-				Authorization: "Bearer ${accessToken || `{API_TOKEN}`}"
+				Authorization: "Bearer ${accessToken || `{API_TOKEN}`}",
 				"Content-Type": "application/json",
 			},
 			method: "POST",

package/src/tasks/audio-classification/inference.ts

@@ -13,14 +13,12 @@ export interface AudioClassificationInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Audio Classification
 	 */
 	parameters?: AudioClassificationParameters;
 	[property: string]: unknown;
 }
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Audio Classification
  */
 export interface AudioClassificationParameters {

package/src/tasks/audio-classification/spec/input.json

@@ -10,14 +10,13 @@
 			"type": "string"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Audio Classification",
 			"$ref": "#/$defs/AudioClassificationParameters"
 		}
 	},
 	"$defs": {
 		"AudioClassificationParameters": {
 			"title": "AudioClassificationParameters",
-			"description": "Additional inference parameters for Audio Classification",
 			"type": "object",
 			"properties": {
 				"function_to_apply": {

package/src/tasks/automatic-speech-recognition/inference.ts

@@ -14,15 +14,13 @@ export interface AutomaticSpeechRecognitionInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Automatic Speech Recognition
 	 */
 	parameters?: AutomaticSpeechRecognitionParameters;
 	[property: string]: unknown;
 }
 
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Automatic Speech Recognition
  */
 export interface AutomaticSpeechRecognitionParameters {
@@ -39,8 +37,6 @@ export interface AutomaticSpeechRecognitionParameters {
 
 /**
  * Parametrization of the text generation process
- *
- * Ad-hoc parametrization of the text generation process
  */
 export interface GenerationParameters {
 	/**

package/src/tasks/automatic-speech-recognition/spec/input.json

@@ -10,14 +10,13 @@
 			"type": "string"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Automatic Speech Recognition",
 			"$ref": "#/$defs/AutomaticSpeechRecognitionParameters"
 		}
 	},
 	"$defs": {
 		"AutomaticSpeechRecognitionParameters": {
 			"title": "AutomaticSpeechRecognitionParameters",
-			"description": "Additional inference parameters for Automatic Speech Recognition",
 			"type": "object",
 			"properties": {
 				"return_timestamps": {

package/src/tasks/chat-completion/inference.ts

@@ -79,7 +79,7 @@ export interface ChatCompletionInput {
 	 * We generally recommend altering this or `top_p` but not both.
 	 */
 	temperature?: number;
-	tool_choice?: ChatCompletionInputTool;
+	tool_choice?: ChatCompletionInputToolChoice;
 	/**
 	 * A prompt to be appended before the tools
 	 */
@@ -89,7 +89,7 @@ export interface ChatCompletionInput {
 	 * Use this to provide a list of
 	 * functions the model may generate JSON inputs for.
 	 */
-	tools?: ToolElement[];
+	tools?: ChatCompletionInputTool[];
 	/**
 	 * An integer between 0 and 5 specifying the number of most likely tokens to return at each
 	 * token position, each with
@@ -154,10 +154,23 @@ export interface ChatCompletionInputStreamOptions {
 	[property: string]: unknown;
 }
 
-export type ChatCompletionInputTool = ChatCompletionInputToolType | string;
+/**
+ *
+ * <https://platform.openai.com/docs/guides/function-calling/configuring-function-calling-behavior-using-the-tool_choice-parameter>
+ */
+export type ChatCompletionInputToolChoice = ChatCompletionInputToolChoiceEnum | ChatCompletionInputToolChoiceObject;
+
+/**
+ * Means the model can pick between generating a message or calling one or more tools.
+ *
+ * Means the model will not call any tool and instead generates a message.
+ *
+ * Means the model must call one or more tools.
+ */
+export type ChatCompletionInputToolChoiceEnum = "auto" | "none" | "required";
 
-export interface ChatCompletionInputToolType {
-	function?: ChatCompletionInputFunctionName;
+export interface ChatCompletionInputToolChoiceObject {
+	function: ChatCompletionInputFunctionName;
 	[property: string]: unknown;
 }
 
@@ -166,7 +179,7 @@ export interface ChatCompletionInputFunctionName {
 	[property: string]: unknown;
 }
 
-export interface ToolElement {
+export interface ChatCompletionInputTool {
 	function: ChatCompletionInputFunctionDefinition;
 	type: string;
 	[property: string]: unknown;

package/src/tasks/chat-completion/spec/input.json

@@ -114,6 +114,7 @@
 					"$ref": "#/$defs/ChatCompletionInputToolChoice"
 				}
 			],
+			"default": "auto",
 			"nullable": true
 		},
 		"tool_prompt": {
@@ -272,23 +273,21 @@
 			"title": "ChatCompletionInputStreamOptions"
 		},
 		"ChatCompletionInputToolChoice": {
-			"allOf": [
-				{
-					"$ref": "#/$defs/ChatCompletionInputToolType"
-				}
-			],
-			"nullable": true,
-			"title": "ChatCompletionInputToolChoice"
-		},
-		"ChatCompletionInputToolType": {
 			"oneOf": [
 				{
-					"type": "object",
-					"default": null,
-					"nullable": true
+					"type": "string",
+					"description": "Means the model can pick between generating a message or calling one or more tools.",
+					"enum": ["auto"]
 				},
 				{
-					"type": "string"
+					"type": "string",
+					"description": "Means the model will not call any tool and instead generates a message.",
+					"enum": ["none"]
+				},
+				{
+					"type": "string",
+					"description": "Means the model must call one or more tools.",
+					"enum": ["required"]
 				},
 				{
 					"type": "object",
@@ -298,14 +297,10 @@
 							"$ref": "#/$defs/ChatCompletionInputFunctionName"
 						}
 					}
-				},
-				{
-					"type": "object",
-					"default": null,
-					"nullable": true
 				}
 			],
-			"title": "ChatCompletionInputToolType"
+			"description": "<https://platform.openai.com/docs/guides/function-calling/configuring-function-calling-behavior-using-the-tool_choice-parameter>",
+			"title": "ChatCompletionInputToolChoice"
 		},
 		"ChatCompletionInputFunctionName": {
 			"type": "object",

package/src/tasks/common-definitions.json

@@ -26,7 +26,6 @@
 		},
 		"GenerationParameters": {
 			"title": "GenerationParameters",
-			"description": "Ad-hoc parametrization of the text generation process",
 			"type": "object",
 			"properties": {
 				"temperature": {

package/src/tasks/depth-estimation/inference.ts

@@ -13,7 +13,7 @@ export interface DepthEstimationInput {
 	 */
 	inputs: unknown;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Depth Estimation
 	 */
 	parameters?: { [key: string]: unknown };
 	[property: string]: unknown;

package/src/tasks/depth-estimation/spec/input.json

@@ -9,14 +9,13 @@
 			"description": "The input image data"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Depth Estimation",
 			"$ref": "#/$defs/DepthEstimationParameters"
 		}
 	},
 	"$defs": {
 		"DepthEstimationParameters": {
 			"title": "DepthEstimationParameters",
-			"description": "Additional inference parameters for Depth Estimation",
 			"type": "object",
 			"properties": {}
 		}

package/src/tasks/document-question-answering/inference.ts

@@ -12,7 +12,7 @@ export interface DocumentQuestionAnsweringInput {
 	 */
 	inputs: DocumentQuestionAnsweringInputData;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Document Question Answering
 	 */
 	parameters?: DocumentQuestionAnsweringParameters;
 	[property: string]: unknown;
@@ -32,8 +32,6 @@ export interface DocumentQuestionAnsweringInputData {
 	[property: string]: unknown;
 }
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Document Question Answering
  */
 export interface DocumentQuestionAnsweringParameters {

package/src/tasks/document-question-answering/spec/input.json

@@ -21,14 +21,13 @@
 			"required": ["image", "question"]
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Document Question Answering",
 			"$ref": "#/$defs/DocumentQuestionAnsweringParameters"
 		}
 	},
 	"$defs": {
 		"DocumentQuestionAnsweringParameters": {
 			"title": "DocumentQuestionAnsweringParameters",
-			"description": "Additional inference parameters for Document Question Answering",
 			"type": "object",
 			"properties": {
 				"doc_stride": {

package/src/tasks/feature-extraction/inference.ts

@@ -23,7 +23,7 @@ export interface FeatureExtractionInput {
 	 * The name of the prompt that should be used by for encoding. If not set, no prompt
 	 * will be applied.
 	 *
-	 * Must be a key in the `Sentence Transformers` configuration `prompts` dictionary.
+	 * Must be a key in the `sentence-transformers` configuration `prompts` dictionary.
 	 *
 	 * For example if ``prompt_name`` is "query" and the ``prompts`` is {"query": "query: ",
 	 * ...},

package/src/tasks/feature-extraction/spec/input.json

@@ -17,7 +17,7 @@
 		},
 		"prompt_name": {
 			"type": "string",
-			"description": "The name of the prompt that should be used by for encoding. If not set, no prompt\nwill be applied.\n\nMust be a key in the `Sentence Transformers` configuration `prompts` dictionary.\n\nFor example if ``prompt_name`` is \"query\" and the ``prompts`` is {\"query\": \"query: \", ...},\nthen the sentence \"What is the capital of France?\" will be encoded as\n\"query: What is the capital of France?\" because the prompt text will be prepended before\nany text to encode.",
+			"description": "The name of the prompt that should be used by for encoding. If not set, no prompt\nwill be applied.\n\nMust be a key in the `sentence-transformers` configuration `prompts` dictionary.\n\nFor example if ``prompt_name`` is \"query\" and the ``prompts`` is {\"query\": \"query: \", ...},\nthen the sentence \"What is the capital of France?\" will be encoded as\n\"query: What is the capital of France?\" because the prompt text will be prepended before\nany text to encode.",
 			"default": "null",
 			"example": "null",
 			"nullable": true

package/src/tasks/fill-mask/inference.ts

@@ -12,14 +12,12 @@ export interface FillMaskInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Fill Mask
 	 */
 	parameters?: FillMaskParameters;
 	[property: string]: unknown;
 }
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Fill Mask
  */
 export interface FillMaskParameters {

package/src/tasks/fill-mask/spec/input.json

@@ -10,14 +10,13 @@
 			"type": "string"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Fill Mask",
 			"$ref": "#/$defs/FillMaskParameters"
 		}
 	},
 	"$defs": {
 		"FillMaskParameters": {
 			"title": "FillMaskParameters",
-			"description": "Additional inference parameters for Fill Mask",
 			"type": "object",
 			"properties": {
 				"top_k": {

package/src/tasks/image-classification/inference.ts

@@ -13,14 +13,12 @@ export interface ImageClassificationInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Image Classification
 	 */
 	parameters?: ImageClassificationParameters;
 	[property: string]: unknown;
 }
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Image Classification
  */
 export interface ImageClassificationParameters {

package/src/tasks/image-classification/spec/input.json

@@ -10,14 +10,13 @@
 			"description": "The input image data as a base64-encoded string. If no `parameters` are provided, you can also provide the image data as a raw bytes payload."
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Image Classification",
 			"$ref": "#/$defs/ImageClassificationParameters"
 		}
 	},
 	"$defs": {
 		"ImageClassificationParameters": {
 			"title": "ImageClassificationParameters",
-			"description": "Additional inference parameters for Image Classification",
 			"type": "object",
 			"properties": {
 				"function_to_apply": {

package/src/tasks/image-segmentation/inference.ts

@@ -13,14 +13,12 @@ export interface ImageSegmentationInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Image Segmentation
 	 */
 	parameters?: ImageSegmentationParameters;
 	[property: string]: unknown;
 }
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Image Segmentation
  */
 export interface ImageSegmentationParameters {

package/src/tasks/image-segmentation/spec/input.json

@@ -10,14 +10,13 @@
 			"description": "The input image data as a base64-encoded string. If no `parameters` are provided, you can also provide the image data as a raw bytes payload."
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Image Segmentation",
 			"$ref": "#/$defs/ImageSegmentationParameters"
 		}
 	},
 	"$defs": {
 		"ImageSegmentationParameters": {
 			"title": "ImageSegmentationParameters",
-			"description": "Additional inference parameters for Image Segmentation",
 			"type": "object",
 			"properties": {
 				"mask_threshold": {

package/src/tasks/image-to-image/inference.ts

@@ -14,15 +14,13 @@ export interface ImageToImageInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Image To Image
 	 */
 	parameters?: ImageToImageParameters;
 	[property: string]: unknown;
 }
 
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Image To Image
  */
 export interface ImageToImageParameters {

package/src/tasks/image-to-image/spec/input.json

@@ -10,14 +10,13 @@
 			"description": "The input image data as a base64-encoded string. If no `parameters` are provided, you can also provide the image data as a raw bytes payload."
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Image To Image",
 			"$ref": "#/$defs/ImageToImageParameters"
 		}
 	},
 	"$defs": {
 		"ImageToImageParameters": {
 			"title": "ImageToImageParameters",
-			"description": "Additional inference parameters for Image To Image",
 			"type": "object",
 			"properties": {
 				"guidance_scale": {

package/src/tasks/image-to-text/inference.ts

@@ -13,15 +13,13 @@ export interface ImageToTextInput {
 	 */
 	inputs: unknown;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Image To Text
 	 */
 	parameters?: ImageToTextParameters;
 	[property: string]: unknown;
 }
 
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Image To Text
  */
 export interface ImageToTextParameters {
@@ -38,8 +36,6 @@ export interface ImageToTextParameters {
 
 /**
  * Parametrization of the text generation process
- *
- * Ad-hoc parametrization of the text generation process
  */
 export interface GenerationParameters {
 	/**

package/src/tasks/image-to-text/spec/input.json

@@ -9,14 +9,13 @@
 			"description": "The input image data"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Image To Text",
 			"$ref": "#/$defs/ImageToTextParameters"
 		}
 	},
 	"$defs": {
 		"ImageToTextParameters": {
 			"title": "ImageToTextParameters",
-			"description": "Additional inference parameters for Image To Text",
 			"type": "object",
 			"properties": {
 				"max_new_tokens": {

package/src/tasks/object-detection/inference.ts

@@ -13,14 +13,12 @@ export interface ObjectDetectionInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Object Detection
 	 */
 	parameters?: ObjectDetectionParameters;
 	[property: string]: unknown;
 }
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Object Detection
  */
 export interface ObjectDetectionParameters {

package/src/tasks/object-detection/spec/input.json

@@ -10,14 +10,13 @@
 			"description": "The input image data as a base64-encoded string. If no `parameters` are provided, you can also provide the image data as a raw bytes payload."
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Object Detection",
 			"$ref": "#/$defs/ObjectDetectionParameters"
 		}
 	},
 	"$defs": {
 		"ObjectDetectionParameters": {
 			"title": "ObjectDetectionParameters",
-			"description": "Additional inference parameters for Object Detection",
 			"type": "object",
 			"properties": {
 				"threshold": {

package/src/tasks/placeholder/spec/input.json

@@ -10,14 +10,13 @@
 			"type": "string"
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "TODO: describe additional parameters here.",
 			"$ref": "#/$defs/<TASK_ID>Parameters"
 		}
 	},
 	"$defs": {
 		"<TASK_ID>Parameters": {
 			"title": "<TASK_ID>Parameters",
-			"description": "TODO: describe additional parameters here.",
 			"type": "object",
 			"properties": {
 				"dummy_parameter_name": {

package/src/tasks/question-answering/inference.ts

@@ -12,7 +12,7 @@ export interface QuestionAnsweringInput {
 	 */
 	inputs: QuestionAnsweringInputData;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Question Answering
 	 */
 	parameters?: QuestionAnsweringParameters;
 	[property: string]: unknown;
@@ -32,8 +32,6 @@ export interface QuestionAnsweringInputData {
 	[property: string]: unknown;
 }
 /**
- * Additional inference parameters
- *
  * Additional inference parameters for Question Answering
  */
 export interface QuestionAnsweringParameters {

package/src/tasks/question-answering/spec/input.json

@@ -22,14 +22,13 @@
 			"required": ["question", "context"]
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Question Answering",
 			"$ref": "#/$defs/QuestionAnsweringParameters"
 		}
 	},
 	"$defs": {
 		"QuestionAnsweringParameters": {
 			"title": "QuestionAnsweringParameters",
-			"description": "Additional inference parameters for Question Answering",
 			"type": "object",
 			"properties": {
 				"top_k": {

package/src/tasks/sentence-similarity/inference.ts

@@ -12,7 +12,7 @@ export type SentenceSimilarityOutput = number[];
 export interface SentenceSimilarityInput {
 	inputs: SentenceSimilarityInputData;
 	/**
-	 * Additional inference parameters
+	 * Additional inference parameters for Sentence Similarity
 	 */
 	parameters?: { [key: string]: unknown };
 	[property: string]: unknown;

package/src/tasks/sentence-similarity/spec/input.json

@@ -24,14 +24,13 @@
 			"required": ["sourceSentence", "sentences"]
 		},
 		"parameters": {
-			"description": "Additional inference parameters",
+			"description": "Additional inference parameters for Sentence Similarity",
 			"$ref": "#/$defs/SentenceSimilarityParameters"
 		}
 	},
 	"$defs": {
 		"SentenceSimilarityParameters": {
 			"title": "SentenceSimilarityParameters",
-			"description": "Additional inference parameters for Sentence Similarity",
 			"type": "object",
 			"properties": {}
 		}

package/src/tasks/summarization/inference.ts

@@ -13,15 +13,13 @@ export interface SummarizationInput {
 	 */
 	inputs: string;
 	/**
-	 * Additional inference parameters.
+	 * Additional inference parameters for summarization.
 	 */
 	parameters?: SummarizationParameters;
 	[property: string]: unknown;
 }
 
 /**
- * Additional inference parameters.
- *
  * Additional inference parameters for summarization.
  */
 export interface SummarizationParameters {

package/src/tasks/summarization/spec/input.json

@@ -10,14 +10,13 @@
 			"type": "string"
 		},
 		"parameters": {
-			"description": "Additional inference parameters.",
+			"description": "Additional inference parameters for summarization.",
 			"$ref": "#/$defs/SummarizationParameters"
 		}
 	},
 	"$defs": {
 		"SummarizationParameters": {
 			"title": "SummarizationParameters",
-			"description": "Additional inference parameters for summarization.",
 			"type": "object",
 			"properties": {
 				"clean_up_tokenization_spaces": {