From a1f60a231be7338f5a433d2788cb929fca684e2f Mon Sep 17 00:00:00 2001 From: Daniel Rochetti Date: Wed, 16 Oct 2024 09:27:08 -0700 Subject: [PATCH 1/2] fix(client): auto request id on realtime client Removed since some endpoints may fail when that field is present. Fallback to user provided request id when needed. --- libs/client/package.json | 2 +- libs/client/src/realtime.ts | 11 +---------- 2 files changed, 2 insertions(+), 11 deletions(-) diff --git a/libs/client/package.json b/libs/client/package.json index d38a21f..5a2f8f3 100644 --- a/libs/client/package.json +++ b/libs/client/package.json @@ -1,7 +1,7 @@ { "name": "@fal-ai/client", "description": "The fal.ai client for JavaScript and TypeScript", - "version": "1.0.1", + "version": "1.0.2", "license": "MIT", "repository": { "type": "git", diff --git a/libs/client/src/realtime.ts b/libs/client/src/realtime.ts index ff7edeb..f7cef8d 100644 --- a/libs/client/src/realtime.ts +++ b/libs/client/src/realtime.ts @@ -511,18 +511,9 @@ export function createRealtimeClient({ const send = (input: Input & Partial) => { // Use throttled send to avoid sending too many messages - - const message = - input instanceof Uint8Array - ? input - : { - ...input, - request_id: input["request_id"] ?? crypto.randomUUID(), - }; - stateMachine.throttledSend({ type: "send", - message, + message: input, }); }; From 9eb78df328605bc4ca7a725f5e46c17be059736e Mon Sep 17 00:00:00 2001 From: Daniel Rochetti Date: Wed, 16 Oct 2024 09:27:55 -0700 Subject: [PATCH 2/2] chore(client): update reference docs --- docs/reference/classes/ApiError.html | 4 ++-- docs/reference/classes/ValidationError.html | 4 ++-- docs/reference/functions/createFalClient.html | 4 ++-- .../functions/isCompletedQueueStatus.html | 2 +- docs/reference/functions/isQueueStatus.html | 2 +- docs/reference/functions/parseEndpointId.html | 2 +- docs/reference/functions/withMiddleware.html | 4 ++-- docs/reference/functions/withProxy.html | 2 +- docs/reference/hierarchy.html | 2 +- docs/reference/index.html | 4 ++-- .../interfaces/CompletedQueueStatus.html | 4 ++-- docs/reference/interfaces/FalClient.html | 18 +++++++++--------- .../interfaces/InProgressQueueStatus.html | 4 ++-- .../interfaces/InQueueQueueStatus.html | 4 ++-- docs/reference/interfaces/QueueClient.html | 16 ++++++++-------- docs/reference/interfaces/RealtimeClient.html | 4 ++-- docs/reference/interfaces/StorageClient.html | 8 ++++---- docs/reference/interfaces/StreamingClient.html | 6 +++--- docs/reference/types/Metrics.html | 2 +- docs/reference/types/QueueStatus.html | 2 +- docs/reference/types/RequestLog.html | 2 +- docs/reference/types/RequestMiddleware.html | 2 +- docs/reference/types/ResponseHandler.html | 2 +- docs/reference/types/Result.html | 4 ++-- docs/reference/types/RunOptions.html | 4 ++-- docs/reference/types/UrlOptions.html | 4 ++-- docs/reference/types/ValidationErrorInfo.html | 2 +- docs/reference/types/WebHookResponse.html | 4 ++-- docs/reference/variables/fal.html | 4 ++-- 29 files changed, 63 insertions(+), 63 deletions(-) diff --git a/docs/reference/classes/ApiError.html b/docs/reference/classes/ApiError.html index 0caed4a..892ff66 100644 --- a/docs/reference/classes/ApiError.html +++ b/docs/reference/classes/ApiError.html @@ -1,4 +1,4 @@ -ApiError | @fal-ai/client - v1.0.1

Class ApiError<Body>

Type Parameters

  • Body

Hierarchy (view full)

Constructors

constructor +ApiError | @fal-ai/client - v1.0.2

Class ApiError<Body>

Type Parameters

  • Body

Hierarchy (view full)

Constructors

constructor

Properties

body status -

Constructors

constructor

Properties

Readonlybody

body: Body

Readonlystatus

status: number

Settings

Member Visibility

On This Page

Constructors
Properties
+

Constructors

constructor

Properties

Readonlybody

body: Body

Readonlystatus

status: number

Settings

Member Visibility

On This Page

Constructors
Properties
diff --git a/docs/reference/classes/ValidationError.html b/docs/reference/classes/ValidationError.html index ba38539..3aabf98 100644 --- a/docs/reference/classes/ValidationError.html +++ b/docs/reference/classes/ValidationError.html @@ -1,6 +1,6 @@ -ValidationError | @fal-ai/client - v1.0.1

Class ValidationError

Hierarchy (view full)

  • ApiError<ValidationErrorBody>
    • ValidationError

Constructors

constructor +ValidationError | @fal-ai/client - v1.0.2

Class ValidationError

Hierarchy (view full)

  • ApiError<ValidationErrorBody>
    • ValidationError

Constructors

constructor

Properties

body status

Accessors

fieldErrors

Methods

getFieldErrors -

Constructors

constructor

Properties

Readonlybody

body: ValidationErrorBody

Readonlystatus

status: number

Accessors

fieldErrors

Methods

getFieldErrors

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
+

Constructors

constructor

Properties

Readonlybody

body: ValidationErrorBody

Readonlystatus

status: number

Accessors

fieldErrors

Methods

getFieldErrors

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods
diff --git a/docs/reference/functions/createFalClient.html b/docs/reference/functions/createFalClient.html index 4438094..3f9cb92 100644 --- a/docs/reference/functions/createFalClient.html +++ b/docs/reference/functions/createFalClient.html @@ -1,4 +1,4 @@ -createFalClient | @fal-ai/client - v1.0.1

Function createFalClient

  • createFalClient(userConfig?): FalClient

  • Creates a new reference of the FalClient.

    +createFalClient | @fal-ai/client - v1.0.2

    Function createFalClient

    • createFalClient(userConfig?): FalClient

    • Creates a new reference of the FalClient.

      Parameters

      • userConfig: Config = {}

        Optional configuration to override the default settings.

      Returns FalClient

      a new instance of the FalClient.

      -

    Settings

    Member Visibility
    +

Settings

Member Visibility
diff --git a/docs/reference/functions/isCompletedQueueStatus.html b/docs/reference/functions/isCompletedQueueStatus.html index c8b1b58..be9c2ab 100644 --- a/docs/reference/functions/isCompletedQueueStatus.html +++ b/docs/reference/functions/isCompletedQueueStatus.html @@ -1 +1 @@ -isCompletedQueueStatus | @fal-ai/client - v1.0.1

Function isCompletedQueueStatus

Settings

Member Visibility
+isCompletedQueueStatus | @fal-ai/client - v1.0.2

Function isCompletedQueueStatus

Settings

Member Visibility
diff --git a/docs/reference/functions/isQueueStatus.html b/docs/reference/functions/isQueueStatus.html index e3d5694..412679d 100644 --- a/docs/reference/functions/isQueueStatus.html +++ b/docs/reference/functions/isQueueStatus.html @@ -1 +1 @@ -isQueueStatus | @fal-ai/client - v1.0.1

Function isQueueStatus

Settings

Member Visibility
+isQueueStatus | @fal-ai/client - v1.0.2

Function isQueueStatus

Settings

Member Visibility
diff --git a/docs/reference/functions/parseEndpointId.html b/docs/reference/functions/parseEndpointId.html index dc9c81c..2b9af68 100644 --- a/docs/reference/functions/parseEndpointId.html +++ b/docs/reference/functions/parseEndpointId.html @@ -1 +1 @@ -parseEndpointId | @fal-ai/client - v1.0.1

Function parseEndpointId

  • parseEndpointId(id): EndpointId

  • Parameters

    • id: string

    Returns EndpointId

Settings

Member Visibility
+parseEndpointId | @fal-ai/client - v1.0.2

Function parseEndpointId

  • parseEndpointId(id): EndpointId

  • Parameters

    • id: string

    Returns EndpointId

Settings

Member Visibility
diff --git a/docs/reference/functions/withMiddleware.html b/docs/reference/functions/withMiddleware.html index 0982405..10db3d0 100644 --- a/docs/reference/functions/withMiddleware.html +++ b/docs/reference/functions/withMiddleware.html @@ -1,4 +1,4 @@ -withMiddleware | @fal-ai/client - v1.0.1

Function withMiddleware

  • withMiddleware(...middlewares): RequestMiddleware

  • Setup a execution chain of middleware functions.

    +withMiddleware | @fal-ai/client - v1.0.2

    Function withMiddleware

    Settings

    Member Visibility
    +

Settings

Member Visibility
diff --git a/docs/reference/functions/withProxy.html b/docs/reference/functions/withProxy.html index dd98015..04e5a10 100644 --- a/docs/reference/functions/withProxy.html +++ b/docs/reference/functions/withProxy.html @@ -1 +1 @@ -withProxy | @fal-ai/client - v1.0.1

Function withProxy

Settings

Member Visibility
+withProxy | @fal-ai/client - v1.0.2

Function withProxy

Settings

Member Visibility
diff --git a/docs/reference/hierarchy.html b/docs/reference/hierarchy.html index dfcf5d1..7bc10bf 100644 --- a/docs/reference/hierarchy.html +++ b/docs/reference/hierarchy.html @@ -1 +1 @@ -@fal-ai/client - v1.0.1

@fal-ai/client - v1.0.1

Class Hierarchy

Settings

Member Visibility
+@fal-ai/client - v1.0.2

@fal-ai/client - v1.0.2

Class Hierarchy

Settings

Member Visibility
diff --git a/docs/reference/index.html b/docs/reference/index.html index f2fe726..645ff87 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -1,4 +1,4 @@ -@fal-ai/client - v1.0.1

@fal-ai/client - v1.0.1

Index

Classes

ApiError +@fal-ai/client - v1.0.2

@fal-ai/client - v1.0.2

Index

Classes

ApiError ValidationError

Interfaces

CompletedQueueStatus FalClient @@ -25,4 +25,4 @@ parseEndpointId withMiddleware withProxy -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/reference/interfaces/CompletedQueueStatus.html b/docs/reference/interfaces/CompletedQueueStatus.html index b7546e6..aec2b71 100644 --- a/docs/reference/interfaces/CompletedQueueStatus.html +++ b/docs/reference/interfaces/CompletedQueueStatus.html @@ -1,6 +1,6 @@ -CompletedQueueStatus | @fal-ai/client - v1.0.1

Interface CompletedQueueStatus

interface CompletedQueueStatus {
    logs: RequestLog[];
    metrics?: Metrics;
    request_id: string;
    response_url: string;
    status: "COMPLETED";
}

Hierarchy

  • BaseQueueStatus
    • CompletedQueueStatus

Properties

logs +CompletedQueueStatus | @fal-ai/client - v1.0.2

Interface CompletedQueueStatus

interface CompletedQueueStatus {
    logs: RequestLog[];
    metrics?: Metrics;
    request_id: string;
    response_url: string;
    status: "COMPLETED";
}

Hierarchy

  • BaseQueueStatus
    • CompletedQueueStatus

Properties

logs metrics? request_id response_url status -

Properties

logs

logs: RequestLog[]

Optionalmetrics

metrics?: Metrics

request_id

request_id: string

response_url

response_url: string

status

status: "COMPLETED"

Settings

Member Visibility

On This Page

Properties
+

Properties

logs

logs: RequestLog[]

Optionalmetrics

metrics?: Metrics

request_id

request_id: string

response_url

response_url: string

status

status: "COMPLETED"

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/FalClient.html b/docs/reference/interfaces/FalClient.html index 8b07453..6190df4 100644 --- a/docs/reference/interfaces/FalClient.html +++ b/docs/reference/interfaces/FalClient.html @@ -1,7 +1,7 @@ -FalClient | @fal-ai/client - v1.0.1

Interface FalClient

The main client type, it provides access to simple API model usage, +FalClient | @fal-ai/client - v1.0.2

Interface FalClient

The main client type, it provides access to simple API model usage, as well as access to the queue and storage APIs.

See

createFalClient

-
interface FalClient {
    queue: QueueClient;
    realtime: RealtimeClient;
    storage: StorageClient;
    stream: (<Output, Input>(endpointId: string, options: StreamOptions<Input>) => Promise<FalStream<Input, Output>>);
    streaming: StreamingClient;
    run<Output, Input>(endpointId: string, options: RunOptions<Input>): Promise<Result<Output>>;
    subscribe<Output, Input>(endpointId: string, options: RunOptions<Input> & QueueSubscribeOptions): Promise<Result<Output>>;
}

Properties

queue +
interface FalClient {
    queue: QueueClient;
    realtime: RealtimeClient;
    storage: StorageClient;
    stream: (<Output, Input>(endpointId: string, options: StreamOptions<Input>) => Promise<FalStream<Input, Output>>);
    streaming: StreamingClient;
    run<Output, Input>(endpointId: string, options: RunOptions<Input>): Promise<Result<Output>>;
    subscribe<Output, Input>(endpointId: string, options: RunOptions<Input> & QueueSubscribeOptions): Promise<Result<Output>>;
}

Properties

queue realtime storage stream @@ -9,14 +9,14 @@

Methods

run subscribe

Properties

Readonlyqueue

queue: QueueClient

The queue client to interact with the queue API.

-

Readonlyrealtime

realtime: RealtimeClient

The realtime client to interact with the realtime API +

Readonlyrealtime

realtime: RealtimeClient

The realtime client to interact with the realtime API and receive updates in real-time.

See

  • #RealtimeClient
  • #RealtimeClient.connect
-

Readonlystorage

storage: StorageClient

The storage client to interact with the storage API.

-

stream

stream: (<Output, Input>(endpointId: string, options: StreamOptions<Input>) => Promise<FalStream<Input, Output>>)

Calls a fal app that supports streaming and provides a streaming-capable +

Readonlystorage

storage: StorageClient

The storage client to interact with the storage API.

+

stream

stream: (<Output, Input>(endpointId: string, options: StreamOptions<Input>) => Promise<FalStream<Input, Output>>)

Calls a fal app that supports streaming and provides a streaming-capable object as a result, that can be used to get partial results through either AsyncIterator or through an event listener.

Type declaration

    • <Output, Input>(endpointId, options): Promise<FalStream<Input, Output>>

    • Calls a fal app that supports streaming and provides a streaming-capable @@ -28,13 +28,13 @@

Param: endpointId

the endpoint id, e.g. fal-ai/llavav15-13b.

Param: options

the request options, including the input payload.

Returns

the FalStream instance.

-

Readonlystreaming

streaming: StreamingClient

The streaming client to interact with the streaming API.

+

Readonlystreaming

streaming: StreamingClient

The streaming client to interact with the streaming API.

See

#stream

-

Methods

run

Methods

run

subscribe

subscribe

  • subscribe<Output, Input>(endpointId, options): Promise<Result<Output>>

  • Subscribes to updates for a specific request in the queue.

    Type Parameters

    • Output = any
    • Input = Record<string, any>

    Parameters

    • endpointId: string

      The ID of the API endpoint.

    • options: RunOptions<Input> & QueueSubscribeOptions

      Options to configure how the request is run and how updates are received.

    Returns Promise<Result<Output>>

    A promise that resolves to the result of the request once it's completed.

    -

Settings

Member Visibility

On This Page

Properties
Methods
+

Settings

Member Visibility

On This Page

Properties
Methods
diff --git a/docs/reference/interfaces/InProgressQueueStatus.html b/docs/reference/interfaces/InProgressQueueStatus.html index 8f975ef..f4f2e21 100644 --- a/docs/reference/interfaces/InProgressQueueStatus.html +++ b/docs/reference/interfaces/InProgressQueueStatus.html @@ -1,5 +1,5 @@ -InProgressQueueStatus | @fal-ai/client - v1.0.1

Interface InProgressQueueStatus

interface InProgressQueueStatus {
    logs: RequestLog[];
    request_id: string;
    response_url: string;
    status: "IN_PROGRESS";
}

Hierarchy

  • BaseQueueStatus
    • InProgressQueueStatus

Properties

logs +InProgressQueueStatus | @fal-ai/client - v1.0.2

Interface InProgressQueueStatus

interface InProgressQueueStatus {
    logs: RequestLog[];
    request_id: string;
    response_url: string;
    status: "IN_PROGRESS";
}

Hierarchy

  • BaseQueueStatus
    • InProgressQueueStatus

Properties

logs request_id response_url status -

Properties

logs

logs: RequestLog[]

request_id

request_id: string

response_url

response_url: string

status

status: "IN_PROGRESS"

Settings

Member Visibility

On This Page

Properties
+

Properties

logs

logs: RequestLog[]

request_id

request_id: string

response_url

response_url: string

status

status: "IN_PROGRESS"

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/InQueueQueueStatus.html b/docs/reference/interfaces/InQueueQueueStatus.html index d141f82..50d68b6 100644 --- a/docs/reference/interfaces/InQueueQueueStatus.html +++ b/docs/reference/interfaces/InQueueQueueStatus.html @@ -1,5 +1,5 @@ -InQueueQueueStatus | @fal-ai/client - v1.0.1

Interface InQueueQueueStatus

interface InQueueQueueStatus {
    queue_position: number;
    request_id: string;
    response_url: string;
    status: "IN_QUEUE";
}

Hierarchy

  • BaseQueueStatus
    • InQueueQueueStatus

Properties

queue_position +InQueueQueueStatus | @fal-ai/client - v1.0.2

Interface InQueueQueueStatus

interface InQueueQueueStatus {
    queue_position: number;
    request_id: string;
    response_url: string;
    status: "IN_QUEUE";
}

Hierarchy

  • BaseQueueStatus
    • InQueueQueueStatus

Properties

queue_position request_id response_url status -

Properties

queue_position

queue_position: number

request_id

request_id: string

response_url

response_url: string

status

status: "IN_QUEUE"

Settings

Member Visibility

On This Page

Properties
+

Properties

queue_position

queue_position: number

request_id

request_id: string

response_url

response_url: string

status

status: "IN_QUEUE"

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/QueueClient.html b/docs/reference/interfaces/QueueClient.html index 1317e91..0f8fa1e 100644 --- a/docs/reference/interfaces/QueueClient.html +++ b/docs/reference/interfaces/QueueClient.html @@ -1,6 +1,6 @@ -QueueClient | @fal-ai/client - v1.0.1

Interface QueueClient

Represents a request queue with methods for submitting requests, +QueueClient | @fal-ai/client - v1.0.2

Interface QueueClient

Represents a request queue with methods for submitting requests, checking their status, retrieving results, and subscribing to updates.

-
interface QueueClient {
    cancel(endpointId: string, options: BaseQueueOptions): Promise<void>;
    result<Output>(endpointId: string, options: BaseQueueOptions): Promise<Result<Output>>;
    status(endpointId: string, options: QueueStatusOptions): Promise<QueueStatus>;
    streamStatus(endpointId: string, options: QueueStatusStreamOptions): Promise<FalStream<unknown, QueueStatus>>;
    submit<Input>(endpointId: string, options: SubmitOptions<Input>): Promise<InQueueQueueStatus>;
    subscribeToStatus(endpointId: string, options: QueueStatusSubscriptionOptions): Promise<CompletedQueueStatus>;
}

Methods

cancel +
interface QueueClient {
    cancel(endpointId: string, options: BaseQueueOptions): Promise<void>;
    result<Output>(endpointId: string, options: BaseQueueOptions): Promise<Result<Output>>;
    status(endpointId: string, options: QueueStatusOptions): Promise<QueueStatus>;
    streamStatus(endpointId: string, options: QueueStatusStreamOptions): Promise<FalStream<unknown, QueueStatus>>;
    submit<Input>(endpointId: string, options: SubmitOptions<Input>): Promise<InQueueQueueStatus>;
    subscribeToStatus(endpointId: string, options: QueueStatusSubscriptionOptions): Promise<CompletedQueueStatus>;
}

Methods

cancel result status streamStatus @@ -12,25 +12,25 @@ is run and how updates are received.

Returns Promise<void>

A promise that resolves once the request is cancelled.

Throws

If the request cannot be cancelled.

-

result

result

  • result<Output>(endpointId, options): Promise<Result<Output>>

  • Retrieves the result of a specific request from the queue.

    Type Parameters

    • Output

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

    • options: BaseQueueOptions

      Options to configure how the request is run.

    Returns Promise<Result<Output>>

    A promise that resolves to the result of the request.

    -

status

status

  • status(endpointId, options): Promise<QueueStatus>

  • Retrieves the status of a specific request in the queue.

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

    • options: QueueStatusOptions

      Options to configure how the request is run.

    Returns Promise<QueueStatus>

    A promise that resolves to the status of the request.

    -

streamStatus

  • streamStatus(endpointId, options): Promise<FalStream<unknown, QueueStatus>>

  • Subscribes to updates for a specific request in the queue using HTTP streaming events.

    +

streamStatus

  • streamStatus(endpointId, options): Promise<FalStream<unknown, QueueStatus>>

  • Subscribes to updates for a specific request in the queue using HTTP streaming events.

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

    • options: QueueStatusStreamOptions

      Options to configure how the request is run and how updates are received.

    Returns Promise<FalStream<unknown, QueueStatus>>

    The streaming object that can be used to listen for updates.

    -

submit

submit

  • submit<Input>(endpointId, options): Promise<InQueueQueueStatus>

  • Submits a request to the queue.

    Type Parameters

    • Input

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

    • options: SubmitOptions<Input>

      Options to configure how the request is run.

    Returns Promise<InQueueQueueStatus>

    A promise that resolves to the result of enqueuing the request.

    -

subscribeToStatus

subscribeToStatus

  • subscribeToStatus(endpointId, options): Promise<CompletedQueueStatus>

  • Subscribes to updates for a specific request in the queue using polling or streaming. See options.mode for more details.

    Parameters

    • endpointId: string

      The ID of the function web endpoint.

    • options: QueueStatusSubscriptionOptions

      Options to configure how the request is run and how updates are received.

    Returns Promise<CompletedQueueStatus>

    A promise that resolves to the final status of the request.

    -

Settings

Member Visibility

On This Page

Methods
+

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/reference/interfaces/RealtimeClient.html b/docs/reference/interfaces/RealtimeClient.html index d6b95fa..4bb619f 100644 --- a/docs/reference/interfaces/RealtimeClient.html +++ b/docs/reference/interfaces/RealtimeClient.html @@ -1,6 +1,6 @@ -RealtimeClient | @fal-ai/client - v1.0.1

Interface RealtimeClient

interface RealtimeClient {
    connect<Input, Output>(app: string, handler: RealtimeConnectionHandler<Output>): RealtimeConnection<Input>;
}

Methods

connect +RealtimeClient | @fal-ai/client - v1.0.2

Interface RealtimeClient

interface RealtimeClient {
    connect<Input, Output>(app: string, handler: RealtimeConnectionHandler<Output>): RealtimeConnection<Input>;
}

Methods

connect

Methods

connect

  • connect<Input, Output>(app, handler): RealtimeConnection<Input>

  • Connect to the realtime endpoint. The default implementation uses WebSockets to connect to fal function endpoints that support WSS.

    Type Parameters

    • Input = any
    • Output = any

    Parameters

    • app: string

      the app alias or identifier.

    • handler: RealtimeConnectionHandler<Output>

      the connection handler.

      -

    Returns RealtimeConnection<Input>

Settings

Member Visibility

On This Page

Methods
+

Returns RealtimeConnection<Input>

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/reference/interfaces/StorageClient.html b/docs/reference/interfaces/StorageClient.html index eb6b343..445d8dc 100644 --- a/docs/reference/interfaces/StorageClient.html +++ b/docs/reference/interfaces/StorageClient.html @@ -1,14 +1,14 @@ -StorageClient | @fal-ai/client - v1.0.1

Interface StorageClient

File support for the client. This interface establishes the contract for +StorageClient | @fal-ai/client - v1.0.2

Interface StorageClient

File support for the client. This interface establishes the contract for uploading files to the server and transforming the input to replace file objects with URLs.

-
interface StorageClient {
    transformInput: ((input: Record<string, any>) => Promise<Record<string, any>>);
    upload: ((file: Blob) => Promise<string>);
}

Properties

transformInput +
interface StorageClient {
    transformInput: ((input: Record<string, any>) => Promise<Record<string, any>>);
    upload: ((file: Blob) => Promise<string>);
}

Properties

transformInput upload

Properties

transformInput

transformInput: ((input: Record<string, any>) => Promise<Record<string, any>>)

Transform the input to replace file objects with URLs. This is used to transform the input before sending it to the server and ensures that the server receives URLs instead of file objects.

Type declaration

upload

upload: ((file: Blob) => Promise<string>)

Upload a file to the server. Returns the URL of the uploaded file.

+

upload

upload: ((file: Blob) => Promise<string>)

Upload a file to the server. Returns the URL of the uploaded file.

Type declaration

    • (file): Promise<string>

    • Parameters

      • file: Blob

        the file to upload

      Returns Promise<string>

      the URL of the uploaded file

      -

Settings

Member Visibility

On This Page

Properties
+

Settings

Member Visibility

On This Page

Properties
diff --git a/docs/reference/interfaces/StreamingClient.html b/docs/reference/interfaces/StreamingClient.html index a4b5990..f471074 100644 --- a/docs/reference/interfaces/StreamingClient.html +++ b/docs/reference/interfaces/StreamingClient.html @@ -1,9 +1,9 @@ -StreamingClient | @fal-ai/client - v1.0.1

Interface StreamingClient

The streaming client interface.

-
interface StreamingClient {
    stream<Output, Input>(endpointId: string, options: StreamOptions<Input>): Promise<FalStream<Input, Output>>;
}

Methods

stream +StreamingClient | @fal-ai/client - v1.0.2

Interface StreamingClient

The streaming client interface.

+
interface StreamingClient {
    stream<Output, Input>(endpointId: string, options: StreamOptions<Input>): Promise<FalStream<Input, Output>>;
}

Methods

stream

Methods

stream

  • stream<Output, Input>(endpointId, options): Promise<FalStream<Input, Output>>

  • Calls a fal app that supports streaming and provides a streaming-capable object as a result, that can be used to get partial results through either AsyncIterator or through an event listener.

    Type Parameters

    • Output = any
    • Input = Record<string, any>

    Parameters

    • endpointId: string

      the endpoint id, e.g. fal-ai/llavav15-13b.

    • options: StreamOptions<Input>

      the request options, including the input payload.

    Returns Promise<FalStream<Input, Output>>

    the FalStream instance.

    -

Settings

Member Visibility

On This Page

Methods
+

Settings

Member Visibility

On This Page

Methods
diff --git a/docs/reference/types/Metrics.html b/docs/reference/types/Metrics.html index 326b9c9..2a62245 100644 --- a/docs/reference/types/Metrics.html +++ b/docs/reference/types/Metrics.html @@ -1 +1 @@ -Metrics | @fal-ai/client - v1.0.1

Type Alias Metrics

Metrics: {
    inference_time: number | null;
}

Settings

Member Visibility
+Metrics | @fal-ai/client - v1.0.2

Type Alias Metrics

Metrics: {
    inference_time: number | null;
}

Settings

Member Visibility
diff --git a/docs/reference/types/QueueStatus.html b/docs/reference/types/QueueStatus.html index 793d120..cfa4766 100644 --- a/docs/reference/types/QueueStatus.html +++ b/docs/reference/types/QueueStatus.html @@ -1 +1 @@ -QueueStatus | @fal-ai/client - v1.0.1

Type Alias QueueStatus

QueueStatus: InProgressQueueStatus | CompletedQueueStatus | InQueueQueueStatus

Settings

Member Visibility
+QueueStatus | @fal-ai/client - v1.0.2

Type Alias QueueStatus

QueueStatus: InProgressQueueStatus | CompletedQueueStatus | InQueueQueueStatus

Settings

Member Visibility
diff --git a/docs/reference/types/RequestLog.html b/docs/reference/types/RequestLog.html index b7e9549..5eda4b0 100644 --- a/docs/reference/types/RequestLog.html +++ b/docs/reference/types/RequestLog.html @@ -1 +1 @@ -RequestLog | @fal-ai/client - v1.0.1

Type Alias RequestLog

RequestLog: {
    level:
        | "STDERR"
        | "STDOUT"
        | "ERROR"
        | "INFO"
        | "WARN"
        | "DEBUG";
    message: string;
    source: "USER";
    timestamp: string;
}

Settings

Member Visibility
+RequestLog | @fal-ai/client - v1.0.2

Type Alias RequestLog

RequestLog: {
    level:
        | "STDERR"
        | "STDOUT"
        | "ERROR"
        | "INFO"
        | "WARN"
        | "DEBUG";
    message: string;
    source: "USER";
    timestamp: string;
}

Settings

Member Visibility
diff --git a/docs/reference/types/RequestMiddleware.html b/docs/reference/types/RequestMiddleware.html index cf3d781..84ae2d6 100644 --- a/docs/reference/types/RequestMiddleware.html +++ b/docs/reference/types/RequestMiddleware.html @@ -1 +1 @@ -RequestMiddleware | @fal-ai/client - v1.0.1

Type Alias RequestMiddleware

RequestMiddleware: ((request: RequestConfig) => Promise<RequestConfig>)

Settings

Member Visibility
+RequestMiddleware | @fal-ai/client - v1.0.2

Type Alias RequestMiddleware

RequestMiddleware: ((request: RequestConfig) => Promise<RequestConfig>)

Settings

Member Visibility
diff --git a/docs/reference/types/ResponseHandler.html b/docs/reference/types/ResponseHandler.html index 48533b2..36e564d 100644 --- a/docs/reference/types/ResponseHandler.html +++ b/docs/reference/types/ResponseHandler.html @@ -1 +1 @@ -ResponseHandler | @fal-ai/client - v1.0.1

Type Alias ResponseHandler<Output>

ResponseHandler<Output>: ((response: Response) => Promise<Output>)

Type Parameters

  • Output

Settings

Member Visibility
+ResponseHandler | @fal-ai/client - v1.0.2

Type Alias ResponseHandler<Output>

ResponseHandler<Output>: ((response: Response) => Promise<Output>)

Type Parameters

  • Output

Settings

Member Visibility
diff --git a/docs/reference/types/Result.html b/docs/reference/types/Result.html index b21e0ba..362e913 100644 --- a/docs/reference/types/Result.html +++ b/docs/reference/types/Result.html @@ -1,3 +1,3 @@ -Result | @fal-ai/client - v1.0.1

Type Alias Result<T>

Result<T>: {
    data: T;
    requestId: string;
}

Represents an API result, containing the data, +Result | @fal-ai/client - v1.0.2

Type Alias Result<T>

Result<T>: {
    data: T;
    requestId: string;
}

Represents an API result, containing the data, the request ID and any other relevant information.

-

Type Parameters

  • T

Settings

Member Visibility
+

Type Parameters

  • T

Settings

Member Visibility
diff --git a/docs/reference/types/RunOptions.html b/docs/reference/types/RunOptions.html index 25ee3c8..41e6b8d 100644 --- a/docs/reference/types/RunOptions.html +++ b/docs/reference/types/RunOptions.html @@ -1,6 +1,6 @@ -RunOptions | @fal-ai/client - v1.0.1

Type Alias RunOptions<Input>

RunOptions<Input>: {
    input?: Input;
    method?:
        | "get"
        | "post"
        | "put"
        | "delete"
        | string;
}

The function input and other configuration when running +RunOptions | @fal-ai/client - v1.0.2

Type Alias RunOptions<Input>

RunOptions<Input>: {
    input?: Input;
    method?:
        | "get"
        | "post"
        | "put"
        | "delete"
        | string;
}

The function input and other configuration when running the function, such as the HTTP method to use.

Type Parameters

  • Input

Type declaration

  • Optional Readonlyinput?: Input

    The function input. It will be submitted either as query params or the body payload, depending on the method.

  • Optional Readonlymethod?:
        | "get"
        | "post"
        | "put"
        | "delete"
        | string

    The HTTP method, defaults to post;

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/reference/types/UrlOptions.html b/docs/reference/types/UrlOptions.html index 59d88f9..45ccc2a 100644 --- a/docs/reference/types/UrlOptions.html +++ b/docs/reference/types/UrlOptions.html @@ -1,6 +1,6 @@ -UrlOptions | @fal-ai/client - v1.0.1

Type Alias UrlOptions

UrlOptions: {
    path?: string;
    query?: Record<string, string>;
    subdomain?: string;
}

Type declaration

  • Optionalpath?: string

    The path to append to the function URL.

    +UrlOptions | @fal-ai/client - v1.0.2

    Type Alias UrlOptions

    UrlOptions: {
        path?: string;
        query?: Record<string, string>;
        subdomain?: string;
    }

    Type declaration

    • Optionalpath?: string

      The path to append to the function URL.

    • Optional Readonlyquery?: Record<string, string>

      The query parameters to include in the URL.

    • Optional Readonlysubdomain?: string

      If true, the function will use the queue to run the function asynchronously and return the result in a separate call. This influences how the URL is built.

      -

    Settings

    Member Visibility
    +

Settings

Member Visibility
diff --git a/docs/reference/types/ValidationErrorInfo.html b/docs/reference/types/ValidationErrorInfo.html index 00e720c..7cffd70 100644 --- a/docs/reference/types/ValidationErrorInfo.html +++ b/docs/reference/types/ValidationErrorInfo.html @@ -1 +1 @@ -ValidationErrorInfo | @fal-ai/client - v1.0.1

Type Alias ValidationErrorInfo

ValidationErrorInfo: {
    loc: (string | number)[];
    msg: string;
    type: string;
}

Settings

Member Visibility
+ValidationErrorInfo | @fal-ai/client - v1.0.2

Type Alias ValidationErrorInfo

ValidationErrorInfo: {
    loc: (string | number)[];
    msg: string;
    type: string;
}

Settings

Member Visibility
diff --git a/docs/reference/types/WebHookResponse.html b/docs/reference/types/WebHookResponse.html index 3477985..fa04c7a 100644 --- a/docs/reference/types/WebHookResponse.html +++ b/docs/reference/types/WebHookResponse.html @@ -1,4 +1,4 @@ -WebHookResponse | @fal-ai/client - v1.0.1

Type Alias WebHookResponse<Payload>

WebHookResponse<Payload>: {
    error: never;
    payload: Payload;
    request_id: string;
    status: "OK";
} | {
    error: string;
    payload: Payload;
    request_id: string;
    status: "ERROR";
}

Represents the response from a WebHook request. +WebHookResponse | @fal-ai/client - v1.0.2

Type Alias WebHookResponse<Payload>

WebHookResponse<Payload>: {
    error: never;
    payload: Payload;
    request_id: string;
    status: "OK";
} | {
    error: string;
    payload: Payload;
    request_id: string;
    status: "ERROR";
}

Represents the response from a WebHook request. This is a union type that varies based on the status property.

Type Parameters

  • Payload = any

    The type of the payload in the response. It defaults to any, allowing for flexibility in specifying the structure of the payload.

    @@ -10,4 +10,4 @@
  • payload: Payload

    The payload of the response, structure determined by the Payload type.

  • request_id: string

    The unique identifier for the request.

  • status: "ERROR"

    Indicates an unsuccessful response.

    -

Settings

Member Visibility
+

Settings

Member Visibility
diff --git a/docs/reference/variables/fal.html b/docs/reference/variables/fal.html index d06ed81..81e5891 100644 --- a/docs/reference/variables/fal.html +++ b/docs/reference/variables/fal.html @@ -1,3 +1,3 @@ -fal | @fal-ai/client - v1.0.1

Variable falConst

fal: SingletonFalClient = ...

Creates a singleton instance of the client. This is useful as a compatibility +fal | @fal-ai/client - v1.0.2

Variable falConst

fal: SingletonFalClient = ...

Creates a singleton instance of the client. This is useful as a compatibility layer for existing code that uses the clients version prior to 1.0.0.

-

Settings

Member Visibility
+

Settings

Member Visibility