Skip to content

Commit e6c538c

Browse files
hanouticelinahanouticelina
committed
deprecate request and streamingRequest
1 parent 83f8b96 commit e6c538c

33 files changed

+235
-329
lines changed

‎packages/inference/README.md‎

Lines changed: 0 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -572,31 +572,6 @@ await hf.tabularClassification({
572572
})
573573
```
574574

575-
## Custom Calls
576-
577-
For models with custom parameters / outputs.
578-
579-
```typescript
580-
await hf.request({
581-
model: 'my-custom-model',
582-
inputs: 'hello world',
583-
parameters: {
584-
custom_param: 'some magic',
585-
}
586-
})
587-
588-
// Custom streaming call, for models with custom parameters / outputs
589-
for await (const output of hf.streamingRequest({
590-
model: 'my-custom-model',
591-
inputs: 'hello world',
592-
parameters: {
593-
custom_param: 'some magic',
594-
}
595-
})) {
596-
...
597-
}
598-
```
599-
600575
You can use any Chat Completion API-compatible provider with the `chatCompletion` method.
601576

602577
```typescript

‎packages/inference/src/tasks/audio/audioClassification.ts‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import type { AudioClassificationInput, AudioClassificationOutput } from "@huggingface/tasks";
22
import { InferenceOutputError } from "../../lib/InferenceOutputError";
33
import type { BaseArgs, Options } from "../../types";
4-
import { request } from "../custom/request";
4+
import { innerRequest } from "../../utils/request";
55
import type { LegacyAudioInput } from "./utils";
66
import { preparePayload } from "./utils";
77

@@ -16,10 +16,12 @@ export async function audioClassification(
1616
options?: Options
1717
): Promise<AudioClassificationOutput> {
1818
const payload = preparePayload(args);
19-
const res = await request<AudioClassificationOutput>(payload, {
20-
...options,
21-
task: "audio-classification",
22-
});
19+
const res = (
20+
await innerRequest<AudioClassificationOutput>(payload, {
21+
...options,
22+
task: "audio-classification",
23+
})
24+
).data;
2325
const isValidOutput =
2426
Array.isArray(res) && res.every((x) => typeof x.label === "string" && typeof x.score === "number");
2527
if (!isValidOutput) {

‎packages/inference/src/tasks/audio/audioToAudio.ts‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
import { InferenceOutputError } from "../../lib/InferenceOutputError";
22
import type { BaseArgs, Options } from "../../types";
3-
import { request } from "../custom/request";
3+
import { innerRequest } from "../../utils/request";
44
import type { LegacyAudioInput } from "./utils";
55
import { preparePayload } from "./utils";
66

@@ -37,10 +37,12 @@ export interface AudioToAudioOutput {
3737
*/
3838
export async function audioToAudio(args: AudioToAudioArgs, options?: Options): Promise<AudioToAudioOutput[]> {
3939
const payload = preparePayload(args);
40-
const res = await request<AudioToAudioOutput>(payload, {
41-
...options,
42-
task: "audio-to-audio",
43-
});
40+
const res = (
41+
await innerRequest<AudioToAudioOutput>(payload, {
42+
...options,
43+
task: "audio-to-audio",
44+
})
45+
).data;
4446

4547
return validateOutput(res);
4648
}

‎packages/inference/src/tasks/audio/automaticSpeechRecognition.ts‎

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,10 @@ import type { AutomaticSpeechRecognitionInput, AutomaticSpeechRecognitionOutput
22
import { InferenceOutputError } from "../../lib/InferenceOutputError";
33
import type { BaseArgs, Options, RequestArgs } from "../../types";
44
import { base64FromBytes } from "../../utils/base64FromBytes";
5-
import { request } from "../custom/request";
5+
import { omit } from "../../utils/omit";
6+
import { innerRequest } from "../../utils/request";
67
import type { LegacyAudioInput } from "./utils";
78
import { preparePayload } from "./utils";
8-
import { omit } from "../../utils/omit";
99

1010
export type AutomaticSpeechRecognitionArgs = BaseArgs & (AutomaticSpeechRecognitionInput | LegacyAudioInput);
1111
/**
@@ -17,10 +17,12 @@ export async function automaticSpeechRecognition(
1717
options?: Options
1818
): Promise<AutomaticSpeechRecognitionOutput> {
1919
const payload = await buildPayload(args);
20-
const res = await request<AutomaticSpeechRecognitionOutput>(payload, {
21-
...options,
22-
task: "automatic-speech-recognition",
23-
});
20+
const res = (
21+
await innerRequest<AutomaticSpeechRecognitionOutput>(payload, {
22+
...options,
23+
task: "automatic-speech-recognition",
24+
})
25+
).data;
2426
const isValidOutput = typeof res?.text === "string";
2527
if (!isValidOutput) {
2628
throw new InferenceOutputError("Expected {text: string}");

‎packages/inference/src/tasks/audio/textToSpeech.ts‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import type { TextToSpeechInput } from "@huggingface/tasks";
22
import { InferenceOutputError } from "../../lib/InferenceOutputError";
33
import type { BaseArgs, Options } from "../../types";
44
import { omit } from "../../utils/omit";
5-
import { request } from "../custom/request";
5+
import { innerRequest } from "../../utils/request";
66
type TextToSpeechArgs = BaseArgs & TextToSpeechInput;
77

88
interface OutputUrlTextToSpeechGeneration {
@@ -22,10 +22,12 @@ export async function textToSpeech(args: TextToSpeechArgs, options?: Options): P
2222
text: args.inputs,
2323
}
2424
: args;
25-
const res = await request<Blob | OutputUrlTextToSpeechGeneration>(payload, {
26-
...options,
27-
task: "text-to-speech",
28-
});
25+
const res = (
26+
await innerRequest<Blob | OutputUrlTextToSpeechGeneration>(payload, {
27+
...options,
28+
task: "text-to-speech",
29+
})
30+
).data;
2931
if (res instanceof Blob) {
3032
return res;
3133
}

‎packages/inference/src/tasks/custom/request.ts‎

Lines changed: 5 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,9 @@
1-
import { makeRequestOptions } from "../../lib/makeRequestOptions";
21
import type { InferenceTask, Options, RequestArgs } from "../../types";
3-
4-
export interface ResponseWrapper<T> {
5-
data: T;
6-
requestContext: {
7-
url: string;
8-
headers: Record<string, string>;
9-
};
10-
}
2+
import { innerRequest } from "../../utils/request";
113

124
/**
135
* Primitive to make custom calls to the inference provider
6+
* @deprecated Use specific task functions instead. This function will be removed in a future version.
147
*/
158
export async function request<T>(
169
args: RequestArgs,
@@ -19,43 +12,8 @@ export async function request<T>(
1912
task?: InferenceTask;
2013
/** Is chat completion compatible */
2114
chatCompletion?: boolean;
22-
/** Whether to include request context in the response */
23-
withRequestContext?: boolean;
24-
}
25-
): Promise<Options extends { withRequestContext: true } ? ResponseWrapper<T> : T> {
26-
const { url, info } = await makeRequestOptions(args, options);
27-
const response = await (options?.fetch ?? fetch)(url, info);
28-
29-
if (options?.retry_on_error !== false && response.status === 503) {
30-
return request(args, options);
31-
}
32-
33-
if (!response.ok) {
34-
const contentType = response.headers.get("Content-Type");
35-
if (["application/json", "application/problem+json"].some((ct) => contentType?.startsWith(ct))) {
36-
const output = await response.json();
37-
if ([400, 422, 404, 500].includes(response.status) && options?.chatCompletion) {
38-
throw new Error(
39-
`Server ${args.model} does not seem to support chat completion. Error: ${JSON.stringify(output.error)}`
40-
);
41-
}
42-
if (output.error || output.detail) {
43-
throw new Error(JSON.stringify(output.error ?? output.detail));
44-
} else {
45-
throw new Error(output);
46-
}
47-
}
48-
const message = contentType?.startsWith("text/plain;") ? await response.text() : undefined;
49-
throw new Error(message ?? "An error occurred while fetching the blob");
5015
}
51-
52-
const requestContext = { url, headers: info.headers as Record<string, string> };
53-
54-
if (response.headers.get("Content-Type")?.startsWith("application/json")) {
55-
const data = await response.json();
56-
return options?.withRequestContext ? ({ data, requestContext } as unknown as T) : (data as T);
57-
}
58-
59-
const blob = await response.blob();
60-
return options?.withRequestContext ? ({ data: blob, requestContext } as unknown as T) : (blob as T);
16+
): Promise<T> {
17+
const result = await innerRequest<T>(args, options);
18+
return result.data;
6119
}

‎packages/inference/src/tasks/custom/streamingRequest.ts‎

Lines changed: 3 additions & 86 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,8 @@
11
import type { InferenceTask, Options, RequestArgs } from "../../types";
2-
import { makeRequestOptions } from "../../lib/makeRequestOptions";
3-
import type { EventSourceMessage } from "../../vendor/fetch-event-source/parse";
4-
import { getLines, getMessages } from "../../vendor/fetch-event-source/parse";
5-
2+
import { innerStreamingRequest } from "../../utils/request";
63
/**
74
* Primitive to make custom inference calls that expect server-sent events, and returns the response through a generator
5+
* @deprecated Use specific task functions instead. This function will be removed in a future version.
86
*/
97
export async function* streamingRequest<T>(
108
args: RequestArgs,
@@ -15,86 +13,5 @@ export async function* streamingRequest<T>(
1513
chatCompletion?: boolean;
1614
}
1715
): AsyncGenerator<T> {
18-
const { url, info } = await makeRequestOptions({ ...args, stream: true }, options);
19-
const response = await (options?.fetch ?? fetch)(url, info);
20-
21-
if (options?.retry_on_error !== false && response.status === 503) {
22-
return yield* streamingRequest(args, options);
23-
}
24-
if (!response.ok) {
25-
if (response.headers.get("Content-Type")?.startsWith("application/json")) {
26-
const output = await response.json();
27-
if ([400, 422, 404, 500].includes(response.status) && options?.chatCompletion) {
28-
throw new Error(`Server ${args.model} does not seem to support chat completion. Error: ${output.error}`);
29-
}
30-
if (typeof output.error === "string") {
31-
throw new Error(output.error);
32-
}
33-
if (output.error && "message" in output.error && typeof output.error.message === "string") {
34-
/// OpenAI errors
35-
throw new Error(output.error.message);
36-
}
37-
}
38-
39-
throw new Error(`Server response contains error: ${response.status}`);
40-
}
41-
if (!response.headers.get("content-type")?.startsWith("text/event-stream")) {
42-
throw new Error(
43-
`Server does not support event stream content type, it returned ` + response.headers.get("content-type")
44-
);
45-
}
46-
47-
if (!response.body) {
48-
return;
49-
}
50-
51-
const reader = response.body.getReader();
52-
let events: EventSourceMessage[] = [];
53-
54-
const onEvent = (event: EventSourceMessage) => {
55-
// accumulate events in array
56-
events.push(event);
57-
};
58-
59-
const onChunk = getLines(
60-
getMessages(
61-
() => {},
62-
() => {},
63-
onEvent
64-
)
65-
);
66-
67-
try {
68-
while (true) {
69-
const { done, value } = await reader.read();
70-
if (done) {
71-
return;
72-
}
73-
onChunk(value);
74-
for (const event of events) {
75-
if (event.data.length > 0) {
76-
if (event.data === "[DONE]") {
77-
return;
78-
}
79-
const data = JSON.parse(event.data);
80-
if (typeof data === "object" && data !== null && "error" in data) {
81-
const errorStr =
82-
typeof data.error === "string"
83-
? data.error
84-
: typeof data.error === "object" &&
85-
data.error &&
86-
"message" in data.error &&
87-
typeof data.error.message === "string"
88-
? data.error.message
89-
: JSON.stringify(data.error);
90-
throw new Error(`Error forwarded from backend: ` + errorStr);
91-
}
92-
yield data as T;
93-
}
94-
}
95-
events = [];
96-
}
97-
} finally {
98-
reader.releaseLock();
99-
}
16+
yield* innerStreamingRequest(args, options);
10017
}

‎packages/inference/src/tasks/cv/imageClassification.ts‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import type { ImageClassificationInput, ImageClassificationOutput } from "@huggingface/tasks";
22
import { InferenceOutputError } from "../../lib/InferenceOutputError";
33
import type { BaseArgs, Options } from "../../types";
4-
import { request } from "../custom/request";
4+
import { innerRequest } from "../../utils/request";
55
import { preparePayload, type LegacyImageInput } from "./utils";
66

77
export type ImageClassificationArgs = BaseArgs & (ImageClassificationInput | LegacyImageInput);
@@ -15,10 +15,12 @@ export async function imageClassification(
1515
options?: Options
1616
): Promise<ImageClassificationOutput> {
1717
const payload = preparePayload(args);
18-
const res = await request<ImageClassificationOutput>(payload, {
19-
...options,
20-
task: "image-classification",
21-
});
18+
const res = (
19+
await innerRequest<ImageClassificationOutput>(payload, {
20+
...options,
21+
task: "image-classification",
22+
})
23+
).data;
2224
const isValidOutput =
2325
Array.isArray(res) && res.every((x) => typeof x.label === "string" && typeof x.score === "number");
2426
if (!isValidOutput) {

‎packages/inference/src/tasks/cv/imageSegmentation.ts‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
import type { ImageSegmentationInput, ImageSegmentationOutput } from "@huggingface/tasks";
22
import { InferenceOutputError } from "../../lib/InferenceOutputError";
33
import type { BaseArgs, Options } from "../../types";
4-
import { request } from "../custom/request";
4+
import { innerRequest } from "../../utils/request";
55
import { preparePayload, type LegacyImageInput } from "./utils";
66

77
export type ImageSegmentationArgs = BaseArgs & (ImageSegmentationInput | LegacyImageInput);
@@ -15,10 +15,12 @@ export async function imageSegmentation(
1515
options?: Options
1616
): Promise<ImageSegmentationOutput> {
1717
const payload = preparePayload(args);
18-
const res = await request<ImageSegmentationOutput>(payload, {
19-
...options,
20-
task: "image-segmentation",
21-
});
18+
const res = (
19+
await innerRequest<ImageSegmentationOutput>(payload, {
20+
...options,
21+
task: "image-segmentation",
22+
})
23+
).data;
2224
const isValidOutput =
2325
Array.isArray(res) &&
2426
res.every((x) => typeof x.label === "string" && typeof x.mask === "string" && typeof x.score === "number");

‎packages/inference/src/tasks/cv/imageToImage.ts‎

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import type { ImageToImageInput } from "@huggingface/tasks";
22
import { InferenceOutputError } from "../../lib/InferenceOutputError";
33
import type { BaseArgs, Options, RequestArgs } from "../../types";
44
import { base64FromBytes } from "../../utils/base64FromBytes";
5-
import { request } from "../custom/request";
5+
import { innerRequest } from "../../utils/request";
66

77
export type ImageToImageArgs = BaseArgs & ImageToImageInput;
88

@@ -26,10 +26,12 @@ export async function imageToImage(args: ImageToImageArgs, options?: Options): P
2626
),
2727
};
2828
}
29-
const res = await request<Blob>(reqArgs, {
30-
...options,
31-
task: "image-to-image",
32-
});
29+
const res = (
30+
await innerRequest<Blob>(reqArgs, {
31+
...options,
32+
task: "image-to-image",
33+
})
34+
).data;
3335
const isValidOutput = res && res instanceof Blob;
3436
if (!isValidOutput) {
3537
throw new InferenceOutputError("Expected Blob");

0 commit comments

Comments
 (0)