@basetenlabs/client - v0.2.0
    Preparing search index...

    Class ApiClient

    Index
    constructor
    asyncPredict asyncPredictDeployment asyncPredictDevelopment asyncPredictProduction asyncPredictRegional asyncRunRemote asyncRunRemoteDeployment asyncRunRemoteDevelopment asyncRunRemoteProduction asyncRunRemoteRegional cancelAsyncRequest getAsyncQueueStatus getAsyncQueueStatusDeployment getAsyncQueueStatusDevelopment getAsyncQueueStatusProduction getAsyncQueueStatusRegional getAsyncRequestStatus predict predictDeployment predictDevelopment predictProduction predictRegional runRemote runRemoteDeployment runRemoteDevelopment runRemoteProduction runRemoteRegional wake wakeDeployment wakeDevelopment wakeProduction wakeRegional

    • Parameters

      • options: {
            baseUrl: string;
            fetch?: {
                (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
                (input: string | URL | Request, init?: RequestInit): Promise<Response>;
            };
            headers: Record<string, string>;
        }
        • baseUrl: string
        • Optionalfetch?: {
              (input: URL | RequestInfo, init?: RequestInit): Promise<Response>;
              (input: string | URL | Request, init?: RequestInit): Promise<Response>;
          }
        • headers: Record<string, string>

      Returns ApiClient

    • Asynchronously call a named environment of a model.

      Parameters

      • params: {
            env_name: string;
            request: {
                inference_retry_config?: {
                    initial_delay_ms?: number;
                    max_attempts?: number;
                    max_delay_ms?: number;
                };
                max_time_in_queue_seconds?: number;
                model_input: Record<string, unknown>;
                priority?: number;
                webhook_endpoint?: string;
            };
        }

      Returns Promise<{ request_id: string }>

    • Asynchronously call a specific deployment of a model.

      Parameters

      • params: {
            deployment_id: string;
            request: {
                inference_retry_config?: {
                    initial_delay_ms?: number;
                    max_attempts?: number;
                    max_delay_ms?: number;
                };
                max_time_in_queue_seconds?: number;
                model_input: Record<string, unknown>;
                priority?: number;
                webhook_endpoint?: string;
            };
        }

      Returns Promise<{ request_id: string }>

    • Asynchronously call the development deployment of a model.

      Parameters

      • params: {
            request: {
                inference_retry_config?: {
                    initial_delay_ms?: number;
                    max_attempts?: number;
                    max_delay_ms?: number;
                };
                max_time_in_queue_seconds?: number;
                model_input: Record<string, unknown>;
                priority?: number;
                webhook_endpoint?: string;
            };
        }

      Returns Promise<{ request_id: string }>

    • Asynchronously call the production environment of a model.

      Parameters

      • params: {
            request: {
                inference_retry_config?: {
                    initial_delay_ms?: number;
                    max_attempts?: number;
                    max_delay_ms?: number;
                };
                max_time_in_queue_seconds?: number;
                model_input: Record<string, unknown>;
                priority?: number;
                webhook_endpoint?: string;
            };
        }

      Returns Promise<{ request_id: string }>

    • Asynchronously call a regional environment of a model.

      Parameters

      • params: {
            request: {
                inference_retry_config?: {
                    initial_delay_ms?: number;
                    max_attempts?: number;
                    max_delay_ms?: number;
                };
                max_time_in_queue_seconds?: number;
                model_input: Record<string, unknown>;
                priority?: number;
                webhook_endpoint?: string;
            };
        }

      Returns Promise<{ request_id: string }>

    • Cancel a queued async request.

      Parameters

      • params: { request_id: string }

      Returns Promise<{ canceled: boolean; message: string; request_id: string }>

    • Get async queue status for a named environment.

      Parameters

      • params: { env_name: string }

      Returns Promise<
          {
              deployment_id: string;
              model_id: string;
              num_in_progress_requests: number;
              num_queued_requests: number;
          },
      >

    • Get async queue status for a specific deployment.

      Parameters

      • params: { deployment_id: string }

      Returns Promise<
          {
              deployment_id: string;
              model_id: string;
              num_in_progress_requests: number;
              num_queued_requests: number;
          },
      >

    • Get async queue status for the development deployment.

      Returns Promise<
          {
              deployment_id: string;
              model_id: string;
              num_in_progress_requests: number;
              num_queued_requests: number;
          },
      >

    • Get async queue status for the production environment.

      Returns Promise<
          {
              deployment_id: string;
              model_id: string;
              num_in_progress_requests: number;
              num_queued_requests: number;
          },
      >

    • Get async queue status for a regional environment.

      Returns Promise<
          {
              deployment_id: string;
              model_id: string;
              num_in_progress_requests: number;
              num_queued_requests: number;
          },
      >

    • Get the status of an async request.

      Parameters

      • params: { request_id: string }

      Returns Promise<
          {
              chain_id?: string;
              created_at: string;
              deployment_id: string;
              errors: {
                  code: | "MODEL_PREDICT_ERROR"
                  | "MODEL_PREDICT_TIMEOUT"
                  | "MODEL_NOT_READY"
                  | "MODEL_DOES_NOT_EXIST"
                  | "MODEL_UNAVAILABLE"
                  | "MODEL_INVALID_INPUT"
                  | "ASYNC_REQUEST_NOT_SUPPORTED"
                  | "INTERNAL_SERVER_ERROR";
                  message: string;
              }[];
              model_id?: string;
              request_id: string;
              status: | "FAILED"
              | "SUCCEEDED"
              | "CANCELED"
              | "QUEUED"
              | "IN_PROGRESS"
              | "EXPIRED"
              | "WEBHOOK_FAILED";
              status_at: string;
              webhook_status: | "FAILED"
              | "SUCCEEDED"
              | "CANCELED"
              | "PENDING"
              | "NO_WEBHOOK_PROVIDED";
          },
      >

    • Wake a specific deployment of a model by deployment ID.

      Parameters

      • params: { deployment_id: string }

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Constructors
    Methods