/** * This file was auto-generated by Fern from our API Definition. */ import * as environments from "../../../../environments"; import * as core from "../../../../core"; import * as Vellum from "../../../index"; export declare namespace Deployments { interface Options { environment?: core.Supplier; /** Specify a custom URL to connect the client to. */ baseUrl?: core.Supplier; apiKey: core.Supplier; /** Override the X-API-Version header */ apiVersion?: core.Supplier; } interface RequestOptions { /** The maximum time to wait for a response in seconds. */ timeoutInSeconds?: number; /** The number of times to retry the request. Defaults to 2. */ maxRetries?: number; /** A hook to abort the request. */ abortSignal?: AbortSignal; /** Override the X-API-Version header */ apiVersion?: Vellum.ApiVersionEnum | undefined; /** Additional headers to include in the request. */ headers?: Record; } } export declare class Deployments { protected readonly _options: Deployments.Options; constructor(_options: Deployments.Options); /** * Used to list all Prompt Deployments. * * @param {Vellum.DeploymentsListRequest} request * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.deployments.list() */ list(request?: Vellum.DeploymentsListRequest, requestOptions?: Deployments.RequestOptions): core.HttpResponsePromise; private __list; /** * Used to retrieve a Prompt Deployment given its ID or name. * * @param {string} id - Either the Prompt Deployment's ID or its unique name * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.deployments.retrieve("id") */ retrieve(id: string, requestOptions?: Deployments.RequestOptions): core.HttpResponsePromise; private __retrieve; /** * DEPRECATED: This endpoint is deprecated and will be removed in a future release. Please use the * `retrieve_prompt_deployment_release` xendpoint instead. * * @param {string} historyIdOrReleaseTag - Either the UUID of Deployment History Item you'd like to retrieve, or the name of a Release Tag that's pointing to the Deployment History Item you'd like to retrieve. * @param {string} id - Either the Prompt Deployment's ID or its unique name * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.deployments.deploymentHistoryItemRetrieve("history_id_or_release_tag", "id") */ deploymentHistoryItemRetrieve(historyIdOrReleaseTag: string, id: string, requestOptions?: Deployments.RequestOptions): core.HttpResponsePromise; private __deploymentHistoryItemRetrieve; /** * List Release Tags associated with the specified Prompt Deployment * * @param {string} id - Either the Prompt Deployment's ID or its unique name * @param {Vellum.ListDeploymentReleaseTagsRequest} request * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.deployments.listDeploymentReleaseTags("id") */ listDeploymentReleaseTags(id: string, request?: Vellum.ListDeploymentReleaseTagsRequest, requestOptions?: Deployments.RequestOptions): core.HttpResponsePromise; private __listDeploymentReleaseTags; /** * Retrieve a Deployment Release Tag by tag name, associated with a specified Deployment. * * @param {string} id - Either the Prompt Deployment's ID or its unique name * @param {string} name - The name of the Release Tag associated with this Deployment that you'd like to retrieve. * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.deployments.retrieveDeploymentReleaseTag("id", "name") */ retrieveDeploymentReleaseTag(id: string, name: string, requestOptions?: Deployments.RequestOptions): core.HttpResponsePromise; private __retrieveDeploymentReleaseTag; /** * Updates an existing Release Tag associated with the specified Prompt Deployment. * * @param {string} id - Either the Prompt Deployment's ID or its unique name * @param {string} name - The name of the Release Tag associated with this Deployment that you'd like to update. * @param {Vellum.PatchedDeploymentReleaseTagUpdateRequest} request * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.deployments.updateDeploymentReleaseTag("id", "name") */ updateDeploymentReleaseTag(id: string, name: string, request?: Vellum.PatchedDeploymentReleaseTagUpdateRequest, requestOptions?: Deployments.RequestOptions): core.HttpResponsePromise; private __updateDeploymentReleaseTag; /** * Retrieve a specific Prompt Deployment Release by either its UUID or the name of a Release Tag that points to it. * * @param {string} id - Either the Prompt Deployment's ID or its unique name * @param {string} releaseIdOrReleaseTag - Either the UUID of Prompt Deployment Release you'd like to retrieve, or the name of a Release Tag that's pointing to the Prompt Deployment Release you'd like to retrieve. * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration. * * @example * await client.deployments.retrievePromptDeploymentRelease("id", "release_id_or_release_tag") */ retrievePromptDeploymentRelease(id: string, releaseIdOrReleaseTag: string, requestOptions?: Deployments.RequestOptions): core.HttpResponsePromise; private __retrievePromptDeploymentRelease; /** * Given a set of input variable values, compile the exact payload that Vellum would send to the configured model provider * for execution if the execute-prompt endpoint had been invoked. Note that this endpoint does not actually execute the * prompt or make an API call to the model provider. * * This endpoint is useful if you don't want to proxy LLM provider requests through Vellum and prefer to send them directly * to the provider yourself. Note that no guarantees are made on the format of this API's response schema, other than * that it will be a valid payload for the configured model provider. It's not recommended that you try to parse or * derive meaning from the response body and instead, should simply pass it directly to the model provider as is. * * We encourage you to seek advise from Vellum Support before integrating with this API for production use. * * @param {Vellum.DeploymentProviderPayloadRequest} request * @param {Deployments.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link Vellum.BadRequestError} * @throws {@link Vellum.ForbiddenError} * @throws {@link Vellum.NotFoundError} * @throws {@link Vellum.InternalServerError} * * @example * await client.deployments.retrieveProviderPayload({ * inputs: [{ * name: "x", * type: "STRING", * value: "value" * }, { * name: "x", * type: "STRING", * value: "value" * }] * }) */ retrieveProviderPayload(request: Vellum.DeploymentProviderPayloadRequest, requestOptions?: Deployments.RequestOptions): core.HttpResponsePromise; private __retrieveProviderPayload; protected _getCustomAuthorizationHeaders(): Promise<{ "X-API-KEY": string; }>; }