@huggingface/tasks 0.9.1 → 0.10.1

package/src/tasks/text-generation/spec/output.json

@@ -1,165 +1,179 @@
 {
 	"$id": "/inference/schemas/text-generation/output.json",
 	"$schema": "http://json-schema.org/draft-06/schema#",
-	"description": "Outputs for Text Generation inference",
+	"description": "Text Generation Output.\n\nAuto-generated from TGI specs.\nFor more details, check out https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tgi-import.ts.",
 	"title": "TextGenerationOutput",
 	"type": "object",
+	"required": ["generated_text"],
 	"properties": {
+		"details": {
+			"allOf": [
+				{
+					"$ref": "#/$defs/TextGenerationOutputDetails"
+				}
+			],
+			"nullable": true
+		},
 		"generated_text": {
 			"type": "string",
-			"description": "The generated text"
-		},
-		"details": {
-			"$ref": "#/$defs/Details",
-			"description": "When enabled, details about the generation"
+			"example": "test"
 		}
 	},
-	"required": ["generated_text"],
 	"$defs": {
-		"FinishReason": {
-			"type": "string",
-			"title": "TextGenerationFinishReason",
-			"description": "The reason why the generation was stopped.",
-			"oneOf": [
-				{ "const": "length", "description": "length: The generated sequence reached the maximum allowed length" },
-				{ "const": "eos_token", "description": "eos_token: The model generated an end-of-sentence (EOS) token" },
-				{
-					"const": "stop_sequence",
-					"description": "stop_sequence: One of the sequence in stop_sequences was generated"
-				}
-			]
-		},
-		"PrefillToken": {
-			"title": "TextGenerationPrefillToken",
+		"TextGenerationOutputDetails": {
 			"type": "object",
+			"required": ["finish_reason", "generated_tokens", "prefill", "tokens"],
 			"properties": {
-				"id": {
-					"type": "integer"
-				},
-				"logprob": {
-					"type": "number"
-				},
-				"text": {
-					"type": "string",
-					"description": "The text associated with that token"
-				}
-			},
-			"required": ["id", "logprob", "text"]
-		},
-		"Token": {
-			"type": "object",
-			"title": "TextGenerationOutputToken",
-			"properties": {
-				"id": {
-					"type": "integer"
-				},
-				"logprob": {
-					"type": "number"
-				},
-				"special": {
-					"type": "boolean",
-					"description": "Whether or not that token is a special one"
+				"best_of_sequences": {
+					"type": "array",
+					"items": {
+						"$ref": "#/$defs/TextGenerationOutputBestOfSequence"
+					},
+					"nullable": true
 				},
-				"text": {
-					"type": "string",
-					"description": "The text associated with that token"
-				}
-			},
-			"required": ["id", "special", "text"]
-		},
-		"Details": {
-			"type": "object",
-			"title": "TextGenerationOutputDetails",
-			"properties": {
 				"finish_reason": {
-					"$ref": "#/$defs/FinishReason",
-					"description": "The reason why the generation was stopped."
+					"$ref": "#/$defs/TextGenerationOutputFinishReason"
 				},
 				"generated_tokens": {
 					"type": "integer",
-					"description": "The number of generated tokens"
+					"format": "int32",
+					"example": 1,
+					"minimum": 0
 				},
 				"prefill": {
 					"type": "array",
 					"items": {
-						"$ref": "#/$defs/PrefillToken"
+						"$ref": "#/$defs/TextGenerationOutputPrefillToken"
 					}
 				},
 				"seed": {
 					"type": "integer",
-					"description": "The random seed used for generation"
+					"format": "int64",
+					"example": 42,
+					"nullable": true,
+					"minimum": 0
 				},
 				"tokens": {
 					"type": "array",
-					"description": "The generated tokens and associated details",
 					"items": {
-						"$ref": "#/$defs/Token"
+						"$ref": "#/$defs/TextGenerationOutputToken"
 					}
 				},
 				"top_tokens": {
 					"type": "array",
-					"description": "Most likely tokens",
 					"items": {
 						"type": "array",
 						"items": {
-							"$ref": "#/$defs/Token"
+							"$ref": "#/$defs/TextGenerationOutputToken"
 						}
 					}
-				},
-				"best_of_sequences": {
-					"type": "array",
-					"description": "Details about additional sequences when best_of is provided",
-					"items": {
-						"$ref": "#/$defs/SequenceDetails"
-					}
 				}
 			},
-			"required": ["finish_reason", "generated_tokens", "prefill", "tokens"]
+			"title": "TextGenerationOutputDetails"
 		},
-		"SequenceDetails": {
+		"TextGenerationOutputBestOfSequence": {
 			"type": "object",
-			"title": "TextGenerationOutputSequenceDetails",
+			"required": ["generated_text", "finish_reason", "generated_tokens", "prefill", "tokens"],
 			"properties": {
+				"finish_reason": {
+					"$ref": "#/$defs/TextGenerationOutputFinishReason"
+				},
 				"generated_text": {
 					"type": "string",
-					"description": "The generated text"
-				},
-				"finish_reason": {
-					"$ref": "#/$defs/FinishReason"
+					"example": "test"
 				},
 				"generated_tokens": {
 					"type": "integer",
-					"description": "The number of generated tokens"
+					"format": "int32",
+					"example": 1,
+					"minimum": 0
 				},
 				"prefill": {
 					"type": "array",
 					"items": {
-						"$ref": "#/$defs/PrefillToken"
+						"$ref": "#/$defs/TextGenerationOutputPrefillToken"
 					}
 				},
 				"seed": {
 					"type": "integer",
-					"description": "The random seed used for generation"
+					"format": "int64",
+					"example": 42,
+					"nullable": true,
+					"minimum": 0
 				},
 				"tokens": {
 					"type": "array",
-					"description": "The generated tokens and associated details",
 					"items": {
-						"$ref": "#/$defs/Token"
+						"$ref": "#/$defs/TextGenerationOutputToken"
 					}
 				},
 				"top_tokens": {
 					"type": "array",
-					"description": "Most likely tokens",
 					"items": {
 						"type": "array",
 						"items": {
-							"$ref": "#/$defs/Token"
+							"$ref": "#/$defs/TextGenerationOutputToken"
 						}
 					}
 				}
 			},
-			"required": ["generated_text", "finish_reason", "generated_tokens", "prefill", "tokens"]
+			"title": "TextGenerationOutputBestOfSequence"
+		},
+		"TextGenerationOutputFinishReason": {
+			"type": "string",
+			"enum": ["length", "eos_token", "stop_sequence"],
+			"example": "Length",
+			"title": "TextGenerationOutputFinishReason"
+		},
+		"TextGenerationOutputPrefillToken": {
+			"type": "object",
+			"required": ["id", "text", "logprob"],
+			"properties": {
+				"id": {
+					"type": "integer",
+					"format": "int32",
+					"example": 0,
+					"minimum": 0
+				},
+				"logprob": {
+					"type": "number",
+					"format": "float",
+					"example": -0.34,
+					"nullable": true
+				},
+				"text": {
+					"type": "string",
+					"example": "test"
+				}
+			},
+			"title": "TextGenerationOutputPrefillToken"
+		},
+		"TextGenerationOutputToken": {
+			"type": "object",
+			"required": ["id", "text", "logprob", "special"],
+			"properties": {
+				"id": {
+					"type": "integer",
+					"format": "int32",
+					"example": 0,
+					"minimum": 0
+				},
+				"logprob": {
+					"type": "number",
+					"format": "float",
+					"example": -0.34,
+					"nullable": true
+				},
+				"special": {
+					"type": "boolean",
+					"example": "false"
+				},
+				"text": {
+					"type": "string",
+					"example": "test"
+				}
+			},
+			"title": "TextGenerationOutputToken"
 		}
 	}
 }

package/src/tasks/text-generation/spec/stream_output.json

@@ -0,0 +1,97 @@
+{
+	"$id": "/inference/schemas/text-generation/stream_output.json",
+	"$schema": "http://json-schema.org/draft-06/schema#",
+	"description": "Text Generation Stream Output.\n\nAuto-generated from TGI specs.\nFor more details, check out https://github.com/huggingface/huggingface.js/blob/main/packages/tasks/scripts/inference-tgi-import.ts.",
+	"title": "TextGenerationStreamOutput",
+	"type": "object",
+	"required": ["index", "token"],
+	"properties": {
+		"details": {
+			"allOf": [
+				{
+					"$ref": "#/$defs/TextGenerationStreamOutputStreamDetails"
+				}
+			],
+			"default": "null",
+			"nullable": true
+		},
+		"generated_text": {
+			"type": "string",
+			"default": "null",
+			"example": "test",
+			"nullable": true
+		},
+		"index": {
+			"type": "integer",
+			"format": "int32",
+			"minimum": 0
+		},
+		"token": {
+			"$ref": "#/$defs/TextGenerationStreamOutputToken"
+		},
+		"top_tokens": {
+			"type": "array",
+			"items": {
+				"$ref": "#/$defs/TextGenerationStreamOutputToken"
+			}
+		}
+	},
+	"$defs": {
+		"TextGenerationStreamOutputStreamDetails": {
+			"type": "object",
+			"required": ["finish_reason", "generated_tokens"],
+			"properties": {
+				"finish_reason": {
+					"$ref": "#/$defs/TextGenerationStreamOutputFinishReason"
+				},
+				"generated_tokens": {
+					"type": "integer",
+					"format": "int32",
+					"example": 1,
+					"minimum": 0
+				},
+				"seed": {
+					"type": "integer",
+					"format": "int64",
+					"example": 42,
+					"nullable": true,
+					"minimum": 0
+				}
+			},
+			"title": "TextGenerationStreamOutputStreamDetails"
+		},
+		"TextGenerationStreamOutputFinishReason": {
+			"type": "string",
+			"enum": ["length", "eos_token", "stop_sequence"],
+			"example": "Length",
+			"title": "TextGenerationStreamOutputFinishReason"
+		},
+		"TextGenerationStreamOutputToken": {
+			"type": "object",
+			"required": ["id", "text", "logprob", "special"],
+			"properties": {
+				"id": {
+					"type": "integer",
+					"format": "int32",
+					"example": 0,
+					"minimum": 0
+				},
+				"logprob": {
+					"type": "number",
+					"format": "float",
+					"example": -0.34,
+					"nullable": true
+				},
+				"special": {
+					"type": "boolean",
+					"example": "false"
+				},
+				"text": {
+					"type": "string",
+					"example": "test"
+				}
+			},
+			"title": "TextGenerationStreamOutputToken"
+		}
+	}
+}

package/tsconfig.json

@@ -11,7 +11,9 @@
 		"strictNullChecks": true,
 		"skipLibCheck": true,
 		"noImplicitOverride": true,
-		"outDir": "./dist"
+		"outDir": "./dist",
+		"declaration": true,
+		"declarationMap": true
 	},
 	"include": ["src", "scripts"],
 	"exclude": ["dist"]