[Bot] Update tasks specs (#1030)

This PR updates the @huggingface/tasks specs. It has been generated by running: ```sh pnpm run inference-tgi-import pnpm run inference-tei-import pnpm run inference-codegen ``` This PR was automatically created by the [Tasks - Update specs workflow](https://github.com/huggingface/huggingface.js/blob/main/.github/update-specs.yml). Make sure the changes are correct before merging. Co-authored-by: Wauplin <[email protected]>
huggingface · Nov 22, 2024 · afdfb0b · afdfb0b
1 parent 0ebf911
commit afdfb0b
Show file tree

Hide file tree

Showing 4 changed files with 35 additions and 27 deletions.
diff --git a/packages/tasks/src/tasks/chat-completion/inference.ts b/packages/tasks/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;

diff --git a/packages/tasks/src/tasks/chat-completion/spec/input.json b/packages/tasks/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",

diff --git a/packages/tasks/src/tasks/feature-extraction/inference.ts b/packages/tasks/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: ",
 	 * ...},

diff --git a/packages/tasks/src/tasks/feature-extraction/spec/input.json b/packages/tasks/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