honeyhive 0.3.0

package/dist/sdk/sdk.d.ts

@@ -0,0 +1,163 @@
+import * as utils from "../internal/utils";
+import * as operations from "./models/operations";
+import * as shared from "./models/shared";
+import { AxiosInstance, AxiosRequestConfig } from "axios";
+/**
+ * Contains the list of servers available to the SDK
+ */
+export declare const ServerList: readonly ["https://api.honeyhive.ai"];
+/**
+ * The available configuration options for the SDK
+ */
+export type SDKProps = {
+    bearerAuth?: string;
+    /**
+     * Allows overriding the default axios client used by the SDK
+     */
+    defaultClient?: AxiosInstance;
+    /**
+     * Allows overriding the default server used by the SDK
+     */
+    serverIdx?: number;
+    /**
+     * Allows overriding the default server URL used by the SDK
+     */
+    serverURL?: string;
+    /**
+     * Allows overriding the default retry config used by the SDK
+     */
+    retryConfig?: utils.RetryConfig;
+};
+export declare class SDKConfiguration {
+    defaultClient: AxiosInstance;
+    security?: shared.Security | (() => Promise<shared.Security>);
+    serverURL: string;
+    serverDefaults: any;
+    language: string;
+    openapiDocVersion: string;
+    sdkVersion: string;
+    genVersion: string;
+    userAgent: string;
+    retryConfig?: utils.RetryConfig;
+    constructor(init?: Partial<SDKConfiguration>);
+}
+export declare class HoneyHive {
+    private sdkConfiguration;
+    constructor(props?: SDKProps);
+    /**
+     * Delete a dataset
+     */
+    deleteDatasetsName(req: operations.DeleteDatasetsNameRequest, config?: AxiosRequestConfig): Promise<operations.DeleteDatasetsNameResponse>;
+    /**
+     * Delete a metric
+     */
+    deleteMetrics(req: operations.DeleteMetricsRequest, config?: AxiosRequestConfig): Promise<operations.DeleteMetricsResponse>;
+    /**
+     * Delete a prompt
+     */
+    deletePromptsId(req: operations.DeletePromptsIdRequest, config?: AxiosRequestConfig): Promise<operations.DeletePromptsIdResponse>;
+    /**
+     * Delete a task
+     */
+    deleteTasks(req: operations.DeleteTasksRequest, config?: AxiosRequestConfig): Promise<operations.DeleteTasksResponse>;
+    /**
+     * Get datasets
+     */
+    getDatasets(req: operations.GetDatasetsRequest, config?: AxiosRequestConfig): Promise<operations.GetDatasetsResponse>;
+    /**
+     * Get all fine-tuned models
+     */
+    getFineTunedModels(req: operations.GetFineTunedModelsRequest, config?: AxiosRequestConfig): Promise<operations.GetFineTunedModelsResponse>;
+    /**
+     * Get a fine-tuned model
+     */
+    getFineTunedModelsId(req: operations.GetFineTunedModelsIdRequest, config?: AxiosRequestConfig): Promise<operations.GetFineTunedModelsIdResponse>;
+    /**
+     * Get all generations
+     */
+    getGenerations(req: operations.GetGenerationsRequest, config?: AxiosRequestConfig): Promise<operations.GetGenerationsResponse>;
+    /**
+     * Get all metrics
+     */
+    getMetrics(req: operations.GetMetricsRequest, config?: AxiosRequestConfig): Promise<operations.GetMetricsResponse>;
+    /**
+     * Get all prompts
+     */
+    getPrompts(req: operations.GetPromptsRequest, config?: AxiosRequestConfig): Promise<operations.GetPromptsResponse>;
+    /**
+     * Get all sessions
+     */
+    getSession(req: operations.GetSessionRequest, config?: AxiosRequestConfig): Promise<operations.GetSessionResponse>;
+    /**
+     * Get a session
+     */
+    getSessionSessionId(req: operations.GetSessionSessionIdRequest, config?: AxiosRequestConfig): Promise<operations.GetSessionSessionIdResponse>;
+    /**
+     * Get a session in Trace Event format
+     */
+    getSessionSessionIdExport(req: operations.GetSessionSessionIdExportRequest, config?: AxiosRequestConfig): Promise<operations.GetSessionSessionIdExportResponse>;
+    /**
+     * Get all tasks
+     */
+    getTasks(req: operations.GetTasksRequest, config?: AxiosRequestConfig): Promise<operations.GetTasksResponse>;
+    /**
+     * Create a dataset
+     */
+    postDatasets(req: shared.UploadDataset, config?: AxiosRequestConfig): Promise<operations.PostDatasetsResponse>;
+    /**
+     * Log an evaluation
+     */
+    postEvaluations(req: shared.EvaluationLoggingQuery, config?: AxiosRequestConfig): Promise<operations.PostEvaluationsResponse>;
+    /**
+     * Send feedback
+     */
+    postFeedback(req: shared.FeedbackQuery, config?: AxiosRequestConfig): Promise<operations.PostFeedbackResponse>;
+    /**
+     * Generate a text
+     */
+    postGenerations(req: shared.GenerateQuery, config?: AxiosRequestConfig): Promise<operations.PostGenerationsResponse>;
+    /**
+     * Log a generation
+     */
+    postGenerationsLog(req: shared.GenerationLoggingQuery, config?: AxiosRequestConfig): Promise<operations.PostGenerationsLogResponse>;
+    /**
+     * Create a metric
+     */
+    postMetrics(req: shared.MetricRequest, config?: AxiosRequestConfig): Promise<operations.PostMetricsResponse>;
+    /**
+     * Create a prompt
+     */
+    postPrompts(req: shared.PromptCreationQuery, config?: AxiosRequestConfig): Promise<operations.PostPromptsResponse>;
+    /**
+     * Start a session
+     */
+    postSessionStart(req: shared.SessionStartQuery, config?: AxiosRequestConfig): Promise<operations.PostSessionStartResponse>;
+    /**
+     * End a session
+     */
+    postSessionSessionIdEnd(req: operations.PostSessionSessionIdEndRequest, config?: AxiosRequestConfig): Promise<operations.PostSessionSessionIdEndResponse>;
+    /**
+     * Log an event
+     */
+    postSessionSessionIdEvent(req: operations.PostSessionSessionIdEventRequest, config?: AxiosRequestConfig): Promise<operations.PostSessionSessionIdEventResponse>;
+    /**
+     * Log session feedback
+     */
+    postSessionSessionIdFeedback(req: operations.PostSessionSessionIdFeedbackRequest, config?: AxiosRequestConfig): Promise<operations.PostSessionSessionIdFeedbackResponse>;
+    /**
+     * Log a trace
+     */
+    postSessionsSessionIdTraces(req: operations.PostSessionsSessionIdTracesRequest, config?: AxiosRequestConfig): Promise<operations.PostSessionsSessionIdTracesResponse>;
+    /**
+     * Create a task
+     */
+    postTasks(req: shared.TaskCreationQuery, config?: AxiosRequestConfig): Promise<operations.PostTasksResponse>;
+    /**
+     * Update a prompt
+     */
+    putPromptsId(req: operations.PutPromptsIdRequest, config?: AxiosRequestConfig): Promise<operations.PutPromptsIdResponse>;
+    /**
+     * Update a task
+     */
+    putTasks(req: shared.TaskUpdateQuery, config?: AxiosRequestConfig): Promise<operations.PutTasksResponse>;
+}