/** * This file was auto-generated by Fern from our API Definition. */ import * as environments from "../../../../environments.js"; import * as core from "../../../../core/index.js"; import * as FernAI from "../../../index.js"; export declare namespace Guidance { interface Options { environment?: core.Supplier; /** Specify a custom URL to connect the client to. */ baseUrl?: core.Supplier; token?: core.Supplier; /** Additional headers to include in requests. */ headers?: Record | undefined>; } 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; /** Additional query string parameters to include in the request. */ queryParams?: Record; /** Additional headers to include in the request. */ headers?: Record | undefined>; } } export declare class Guidance { protected readonly _options: Guidance.Options; constructor(_options?: Guidance.Options); /** * @param {string} domain * @param {FernAI.CreateGuidanceRequest} request * @param {Guidance.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link FernAI.UnprocessableEntityError} * * @example * await client.guidance.createGuidance("domain", { * context: ["context"], * document: "document" * }) */ createGuidance(domain: string, request: FernAI.CreateGuidanceRequest, requestOptions?: Guidance.RequestOptions): core.HttpResponsePromise; private __createGuidance; /** * @param {string} domain * @param {string} guidanceId * @param {Guidance.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link FernAI.UnprocessableEntityError} * * @example * await client.guidance.getGuidanceById("domain", "guidance_id") */ getGuidanceById(domain: string, guidanceId: string, requestOptions?: Guidance.RequestOptions): core.HttpResponsePromise; private __getGuidanceById; /** * @param {string} domain * @param {string} guidanceId * @param {Guidance.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link FernAI.UnprocessableEntityError} * * @example * await client.guidance.deleteGuidanceById("domain", "guidance_id") */ deleteGuidanceById(domain: string, guidanceId: string, requestOptions?: Guidance.RequestOptions): core.HttpResponsePromise; private __deleteGuidanceById; /** * @param {string} domain * @param {string} guidanceId * @param {FernAI.UpdateGuidanceRequest} request * @param {Guidance.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link FernAI.UnprocessableEntityError} * * @example * await client.guidance.update("domain", "guidance_id") */ update(domain: string, guidanceId: string, request?: FernAI.UpdateGuidanceRequest, requestOptions?: Guidance.RequestOptions): core.HttpResponsePromise; private __update; /** * @param {string} domain * @param {FernAI.GetGuidancesRequest} request * @param {Guidance.RequestOptions} requestOptions - Request-specific configuration. * * @throws {@link FernAI.UnprocessableEntityError} * * @example * await client.guidance.getGuidances("domain", { * page: 1, * limit: 1 * }) */ getGuidances(domain: string, request?: FernAI.GetGuidancesRequest, requestOptions?: Guidance.RequestOptions): core.HttpResponsePromise; private __getGuidances; protected _getAuthorizationHeader(): Promise; }