import { type Agent } from "./_shims/index.js"; import * as Core from "./core.js"; import * as Errors from "./error.js"; import * as Uploads from "./uploads.js"; import * as API from "./resources/index.js"; import { IndexCreateParams, IndexCreateResponse, IndexDeleteResponse, IndexFinetuneParams, IndexFinetuneResponse, IndexGetResponse, IndexListResponse, IndexSearchParams, IndexSearchResponse, IndexStatusByTypeResponse, IndexStatusResponse, Indexes } from "./resources/indexes.js"; import { ObjectBatchParams, ObjectBatchResponse, ObjectCreateParams, ObjectCreateResponse, ObjectDeleteAllResponse, ObjectDeleteResponse, ObjectGetResponse, ObjectListParams, ObjectListResponse, ObjectStatusParams, ObjectStatusResponse, ObjectUpdateParams, ObjectUpdateResponse, Objects } from "./resources/objects.js"; export interface ClientOptions { /** * Defaults to process.env['OBJECTIVE_API_KEY']. */ apiKey?: string | undefined; /** * Override the default base URL for the API, e.g., "https://api.example.com/v2/" * * Defaults to process.env['OBJECTIVE_BASE_URL']. */ baseURL?: string | null | undefined; /** * The maximum amount of time (in milliseconds) that the client should wait for a response * from the server before timing out a single request. * * Note that request timeouts are retried by default, so in a worst-case scenario you may wait * much longer than this timeout before the promise succeeds or fails. */ timeout?: number | undefined; /** * An HTTP agent used to manage HTTP(S) connections. * * If not provided, an agent will be constructed by default in the Node.js environment, * otherwise no agent is used. */ httpAgent?: Agent | undefined; /** * Specify a custom `fetch` function implementation. * * If not provided, we use `node-fetch` on Node.js and otherwise expect that `fetch` is * defined globally. */ fetch?: Core.Fetch | undefined; /** * The maximum number of times that the client will retry a request in case of a * temporary failure, like a network error or a 5XX error from the server. * * @default 3 */ maxRetries?: number | undefined; /** * Default headers to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * header to `undefined` or `null` in request options. */ defaultHeaders?: Core.Headers | undefined; /** * Default query parameters to include with every request to the API. * * These can be removed in individual requests by explicitly setting the * param to `undefined` in request options. */ defaultQuery?: Core.DefaultQuery | undefined; } /** * API Client for interfacing with the Objective API. */ export declare class Objective extends Core.APIClient { apiKey: string; private _options; /** * API Client for interfacing with the Objective API. * * @param {string | undefined} [opts.apiKey=process.env['OBJECTIVE_API_KEY'] ?? undefined] * @param {string} [opts.baseURL=process.env['OBJECTIVE_BASE_URL'] ?? https://api.objective.inc/v1] - Override the default base URL for the API. * @param {number} [opts.timeout=10 seconds] - The maximum amount of time (in milliseconds) the client will wait for a response before timing out. * @param {number} [opts.httpAgent] - An HTTP agent used to manage HTTP(s) connections. * @param {Core.Fetch} [opts.fetch] - Specify a custom `fetch` function implementation. * @param {number} [opts.maxRetries=3] - The maximum number of times the client will retry a request. * @param {Core.Headers} opts.defaultHeaders - Default headers to include with every request to the API. * @param {Core.DefaultQuery} opts.defaultQuery - Default query parameters to include with every request to the API. */ constructor({ baseURL, apiKey, ...opts }?: ClientOptions); indexes: API.Indexes; objects: API.Objects; protected defaultQuery(): Core.DefaultQuery | undefined; protected defaultHeaders(opts: Core.FinalRequestOptions): Core.Headers; protected authHeaders(opts: Core.FinalRequestOptions): Core.Headers; static Objective: typeof Objective; static DEFAULT_TIMEOUT: number; static ObjectiveError: typeof Errors.ObjectiveError; static APIError: typeof Errors.APIError; static APIConnectionError: typeof Errors.APIConnectionError; static APIConnectionTimeoutError: typeof Errors.APIConnectionTimeoutError; static APIUserAbortError: typeof Errors.APIUserAbortError; static NotFoundError: typeof Errors.NotFoundError; static ConflictError: typeof Errors.ConflictError; static RateLimitError: typeof Errors.RateLimitError; static BadRequestError: typeof Errors.BadRequestError; static AuthenticationError: typeof Errors.AuthenticationError; static InternalServerError: typeof Errors.InternalServerError; static PermissionDeniedError: typeof Errors.PermissionDeniedError; static UnprocessableEntityError: typeof Errors.UnprocessableEntityError; static toFile: typeof Uploads.toFile; static fileFromPath: typeof Uploads.fileFromPath; } export declare namespace Objective { export type RequestOptions = Core.RequestOptions; export { Indexes as Indexes, type IndexCreateResponse as IndexCreateResponse, type IndexListResponse as IndexListResponse, type IndexDeleteResponse as IndexDeleteResponse, type IndexFinetuneResponse as IndexFinetuneResponse, type IndexGetResponse as IndexGetResponse, type IndexSearchResponse as IndexSearchResponse, type IndexStatusResponse as IndexStatusResponse, type IndexStatusByTypeResponse as IndexStatusByTypeResponse, type IndexCreateParams as IndexCreateParams, type IndexFinetuneParams as IndexFinetuneParams, type IndexSearchParams as IndexSearchParams, }; export { Objects as Objects, type ObjectCreateResponse as ObjectCreateResponse, type ObjectUpdateResponse as ObjectUpdateResponse, type ObjectListResponse as ObjectListResponse, type ObjectDeleteResponse as ObjectDeleteResponse, type ObjectBatchResponse as ObjectBatchResponse, type ObjectDeleteAllResponse as ObjectDeleteAllResponse, type ObjectGetResponse as ObjectGetResponse, type ObjectStatusResponse as ObjectStatusResponse, type ObjectCreateParams as ObjectCreateParams, type ObjectUpdateParams as ObjectUpdateParams, type ObjectListParams as ObjectListParams, type ObjectBatchParams as ObjectBatchParams, type ObjectStatusParams as ObjectStatusParams, }; } export { toFile, fileFromPath } from "./uploads.js"; export { ObjectiveError, APIError, APIConnectionError, APIConnectionTimeoutError, APIUserAbortError, NotFoundError, ConflictError, RateLimitError, BadRequestError, AuthenticationError, InternalServerError, PermissionDeniedError, UnprocessableEntityError, } from "./error.js"; export default Objective; //# sourceMappingURL=index.d.ts.map