@squidcloud/client 1.0.370 → 1.0.371

package/dist/typescript-client/src/agent/ai-agent-client-reference.d.ts

@@ -93,16 +93,18 @@ export declare class AiAgentReference {
      * Sends a prompt to the agent and receives streamed text responses.
      * @param prompt The text prompt to send to the agent.
      * @param options Optional parameters for the AI ask request.
-     * @param jobId Optional job ID for tracking the request using `squid.jobs().awaitJob(jobId)` or
-     *   `squid.jobs().getJob(jobId)`.
+     * @param jobId (Optional) A unique identifier for this request. Use it with `squid.jobs().awaitJob(jobId)` or
+     *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
+     *   knows it can look up the job’s status.
      */
     chat<T extends AiChatModelName | undefined>(prompt: string, options?: AiChatOptionsWithoutVoice<T>, jobId?: JobId): Observable<string>;
     /**
      * Transcribes the given file and performs a chat interaction.
      * @param fileToTranscribe The audio file to transcribe and send to the agent.
      * @param options Optional parameters for the AI ask request.
-     * @param jobId Optional job ID for tracking the request using `squid.jobs().awaitJob(jobId)` or
-     *   `squid.jobs().getJob(jobId)`.
+     * @param jobId (Optional) A unique identifier for this request. Use it with `squid.jobs().awaitJob(jobId)` or
+     *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
+     *   knows it can look up the job’s status.
      */
     transcribeAndChat(fileToTranscribe: File, options?: AiChatOptionsWithoutVoice, jobId?: JobId): Promise<TranscribeAndChatResponse>;
     /**
@@ -113,10 +115,21 @@ export declare class AiAgentReference {
      * Sends a prompt and receives a full string response.
      * @param prompt The text prompt to send to the agent.
      * @param options Optional parameters for the AI ask request.
-     * @param jobId Optional job ID for tracking the request using `squid.jobs().awaitJob(jobId)` or
-     *   `squid.jobs().getJob(jobId)`.
+     * @param jobId (Optional) A unique identifier for this request. Use it with `squid.jobs().awaitJob(jobId)` or
+     *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
+     *   knows it can look up the job’s status.
      */
     ask<T extends AiChatModelName | undefined = undefined>(prompt: string, options?: AiAskOptions<T>, jobId?: JobId): Promise<string>;
+    /**
+     * Sends a prompt and not wait for the result - the result can be tracked using the job ID
+     * (`squid.jobs().awaitJob(jobId)` or `squid.jobs().getJob(jobId)).
+     * @param prompt The text prompt to send to the agent.
+     * @param jobId A unique identifier for this request. Use it with `squid.jobs().awaitJob(jobId)` or
+     *   `squid.jobs().getJob(jobId)`
+     to track progress. Make sure each job ID is both unique and kept private—anyone who knows it can look up the job’s status.
+     * @param options Optional parameters for the AI ask request.
+     */
+    askAsync<T extends AiChatModelName | undefined = undefined>(prompt: string, jobId: JobId, options?: AiAskOptions<T>): Promise<void>;
     /**
      * Observes live status messages from the agent.
      */
@@ -125,24 +138,27 @@ export declare class AiAgentReference {
      * Transcribes audio and sends it to the agent for response.
      * @param fileToTranscribe The audio file to transcribe and send to the agent.
      * @param options Optional parameters for the AI ask request.
-     * @param jobId Optional job ID for tracking the request using `squid.jobs().awaitJob(jobId)` or
-     *   `squid.jobs().getJob(jobId)`.
+     * @param jobId (Optional) A unique identifier for this request. Use it with `squid.jobs().awaitJob(jobId)` or
+     *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
+     *   knows it can look up the job’s status.
      */
     transcribeAndAsk<T extends AiChatModelName | undefined>(fileToTranscribe: File, options?: AiAskOptions<T>, jobId?: JobId): Promise<AiTranscribeAndAskResponse>;
     /**
      * Transcribes audio and gets both text and voice response from the agent.
      * @param fileToTranscribe The audio file to transcribe and send to the agent.
      * @param options Optional parameters for the AI ask request.
-     * @param jobId Optional job ID for tracking the request using `squid.jobs().awaitJob(jobId)` or
-     *   `squid.jobs().getJob(jobId)`.
+     * @param jobId (Optional) A unique identifier for this request. Use it with `squid.jobs().awaitJob(jobId)` or
+     *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
+     *   knows it can look up the job’s status.
      */
     transcribeAndAskWithVoiceResponse<T extends AiChatModelName | undefined>(fileToTranscribe: File, options?: AiAskOptionsWithVoice<T>, jobId?: JobId): Promise<TranscribeAndAskWithVoiceResponse>;
     /**
      * Sends a prompt and gets both text and voice response from the agent.
      * @param prompt The text prompt to send to the agent.
      * @param options Optional parameters for the AI ask request.
-     * @param jobId Optional job ID for tracking the request using `squid.jobs().awaitJob(jobId)` or
-     *   `squid.jobs().getJob(jobId)`.
+     * @param jobId (Optional) A unique identifier for this request. Use it with `squid.jobs().awaitJob(jobId)` or
+     *   `squid.jobs().getJob(jobId)` to track progress. Make sure each job ID is both unique and kept private—anyone who
+     *   knows it can look up the job’s status.
      */
     askWithVoiceResponse<T extends AiChatModelName | undefined>(prompt: string, options?: AiAskOptionsWithVoice<T>, jobId?: JobId): Promise<AskWithVoiceResponse>;
     private askInternal;

package/dist/typescript-client/src/job-client.d.ts

@@ -1,6 +1,9 @@
 import { AsyncJob, JobId } from '../../internal-common/src/public-types/job.public-types';
 /**
- * JobService is responsible for managing job subscriptions and notifications.
+ * Handles job subscriptions and notifications.
+ *
+ * **Important:** Each `jobId` must be globally unique and kept private.
+ * Anyone who knows a job’s ID can query its status or result.
  */
 export declare class JobClient {
     private readonly socketManager;
@@ -8,13 +11,20 @@ export declare class JobClient {
     private isListening;
     private readonly listeners;
     /**
-     * Returns the job with the given ID.
-     * @param jobId used to identify the job.
+     * Retrieves the current status (and, if completed, the result) of a job.
+     *
+     * @param jobId A unique, private identifier for the job.
+     *              Do **not** reuse a `jobId` across clients—possessing the ID
+     *              allows anyone to inspect the job’s state.
      */
     getJob<T = any>(jobId: JobId): Promise<AsyncJob<T> | undefined>;
     /**
-     * Waits for a job to complete and returns its result or throws an error.
-     * @param jobId used to identify the job.
+     * Waits until the specified job finishes, then resolves with its result or
+     * throws if the job fails.
+     *
+     * @param jobId A unique, private identifier for the job.
+     *              Do **not** reuse a `jobId` across clients—possessing the ID
+     *              allows anyone to inspect the job’s state.
      */
     awaitJob<T = any>(jobId: JobId): Promise<T>;
     private maybeListenToJobs;

package/dist/typescript-client/src/version.d.ts

@@ -2,4 +2,4 @@
  * The current version of the SquidCloud client package.
  * @category Platform
  */
-export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.370";
+export declare const SQUIDCLOUD_CLIENT_PACKAGE_VERSION = "1.0.371";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@squidcloud/client",
-  "version": "1.0.370",
+  "version": "1.0.371",
   "description": "A typescript implementation of the Squid client",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",