vellum-ai 0.0.44 → 0.1.0

package/Client.d.ts

@@ -13,64 +13,61 @@ import { Sandboxes } from "./api/resources/sandboxes/client/Client";
 import { TestSuites } from "./api/resources/testSuites/client/Client";
 export declare namespace VellumClient {
     interface Options {
-        environment?: environments.VellumEnvironment | environments.VellumEnvironmentUrls;
+        environment?: core.Supplier<environments.VellumEnvironment | environments.VellumEnvironmentUrls>;
         apiKey: core.Supplier<string>;
     }
+    interface RequestOptions {
+        timeoutInSeconds?: number;
+        maxRetries?: number;
+    }
 }
 export declare class VellumClient {
-    protected readonly options: VellumClient.Options;
-    constructor(options: VellumClient.Options);
+    protected readonly _options: VellumClient.Options;
+    constructor(_options: VellumClient.Options);
     /**
      * Executes a deployed Workflow and streams back its results.
-     * @throws {Vellum.BadRequestError}
-     * @throws {Vellum.NotFoundError}
-     * @throws {Vellum.InternalServerError}
      */
-    executeWorkflowStream(request: Vellum.ExecuteWorkflowStreamRequest, cb: (data: Vellum.WorkflowStreamEvent) => void, opts?: Pick<core.StreamingFetcher.Args, "onError" | "onFinish" | "abortController" | "timeoutMs">): Promise<void>;
+    executeWorkflowStream(request: Vellum.ExecuteWorkflowStreamRequest, requestOptions?: VellumClient.RequestOptions): Promise<core.Stream<Vellum.WorkflowStreamEvent>>;
     /**
      * Generate a completion using a previously defined deployment.
      *
      * **Note:** Uses a base url of `https://predict.vellum.ai`.
-     * @throws {Vellum.BadRequestError}
-     * @throws {Vellum.ForbiddenError}
-     * @throws {Vellum.NotFoundError}
-     * @throws {Vellum.InternalServerError}
+     * @throws {@link Vellum.BadRequestError}
+     * @throws {@link Vellum.ForbiddenError}
+     * @throws {@link Vellum.NotFoundError}
+     * @throws {@link Vellum.InternalServerError}
      */
-    generate(request: Vellum.GenerateBodyRequest): Promise<Vellum.GenerateResponse>;
+    generate(request: Vellum.GenerateBodyRequest, requestOptions?: VellumClient.RequestOptions): Promise<Vellum.GenerateResponse>;
     /**
      * Generate a stream of completions using a previously defined deployment.
      *
      * **Note:** Uses a base url of `https://predict.vellum.ai`.
-     * @throws {Vellum.BadRequestError}
-     * @throws {Vellum.ForbiddenError}
-     * @throws {Vellum.NotFoundError}
-     * @throws {Vellum.InternalServerError}
      */
-    generateStream(request: Vellum.GenerateStreamBodyRequest, cb: (data: Vellum.GenerateStreamResponse) => void, opts?: Pick<core.StreamingFetcher.Args, "onError" | "onFinish" | "abortController" | "timeoutMs">): Promise<void>;
+    generateStream(request: Vellum.GenerateStreamBodyRequest, requestOptions?: VellumClient.RequestOptions): Promise<core.Stream<Vellum.GenerateStreamResponse>>;
     /**
      * Perform a search against a document index.
      *
      * **Note:** Uses a base url of `https://predict.vellum.ai`.
-     * @throws {Vellum.BadRequestError}
-     * @throws {Vellum.NotFoundError}
-     * @throws {Vellum.InternalServerError}
+     * @throws {@link Vellum.BadRequestError}
+     * @throws {@link Vellum.NotFoundError}
+     * @throws {@link Vellum.InternalServerError}
      */
-    search(request: Vellum.SearchRequestBodyRequest): Promise<Vellum.SearchResponse>;
+    search(request: Vellum.SearchRequestBodyRequest, requestOptions?: VellumClient.RequestOptions): Promise<Vellum.SearchResponse>;
     /**
      * Used to submit feedback regarding the quality of previously generated completions.
      *
      * **Note:** Uses a base url of `https://predict.vellum.ai`.
-     * @throws {Vellum.BadRequestError}
-     * @throws {Vellum.NotFoundError}
-     * @throws {Vellum.InternalServerError}
+     * @throws {@link Vellum.BadRequestError}
+     * @throws {@link Vellum.NotFoundError}
+     * @throws {@link Vellum.InternalServerError}
      */
-    submitCompletionActuals(request: Vellum.SubmitCompletionActualsRequest): Promise<void>;
+    submitCompletionActuals(request: Vellum.SubmitCompletionActualsRequest, requestOptions?: VellumClient.RequestOptions): Promise<void>;
     /**
      *     Used to submit feedback regarding the quality of previous workflow execution and its outputs.
      *
      *     **Note:** Uses a base url of `https://predict.vellum.ai`.
      */
-    submitWorkflowExecutionActuals(request: Vellum.SubmitWorkflowExecutionActualsRequest): Promise<void>;
+    submitWorkflowExecutionActuals(request: Vellum.SubmitWorkflowExecutionActualsRequest, requestOptions?: VellumClient.RequestOptions): Promise<void>;
     protected _deployments: Deployments | undefined;
     get deployments(): Deployments;
     protected _documentIndexes: DocumentIndexes | undefined;