• The main api composable

    Parameters

    • initParams: GoinferParams

    Returns {
        abort: (() => Promise<void>);
        executeTask: ((name, prompt) => Promise<void>);
        infer: ((prompt, template?, params?) => Promise<InferResult>);
        loadModel: ((modelConf) => Promise<void>);
        loadTask: ((path) => Promise<Task>);
        loadTasks: (() => Promise<Record<string, any>[]>);
        modelsState: (() => Promise<ModelState>);
        state: {
            isLoadingModel: boolean;
            isModelLoaded: boolean;
            isRunning: boolean;
            isStreaming: boolean;
        };
        unloadModel: (() => Promise<void>);
        get api(): {
            addHeader: ((key, val) => void);
            csrfToken: (() => null | string);
            del: (<T_4>(uri, verbose?) => Promise<ApiResponse<T_4>>);
            get: (<T>(uri, verbose?) => Promise<ApiResponse<T>>);
            hasCsrfCookie: (() => boolean);
            onResponse: ((hook) => void);
            patch: (<T_3>(uri, payload, verbose?) => Promise<ApiResponse<T_3>>);
            post: (<T_1>(uri, payload, multipart?, verbose?) => Promise<ApiResponse<T_1>>);
            postSse: (<T_5>(uri, payload, onChunk, abortController, multipart?, verbose?) => Promise<void>);
            put: (<T_2>(uri, payload, verbose?) => Promise<ApiResponse<T_2>>);
            removeHeader: ((key) => void);
            setCsrfToken: ((token) => void);
            setCsrfTokenFromCookie: ((verbose?) => boolean);
        };
        get model(): ModelConf;
        set onError(t: undefined | ((t) => void));
        set onStartEmit(t: undefined | ((s) => void));
        set onToken(t: undefined | ((t) => void));
    }

    • abort: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    • executeTask: ((name, prompt) => Promise<void>)
        • (name, prompt): Promise<void>
        • Parameters

          • name: string
          • prompt: string

          Returns Promise<void>

    • infer: ((prompt, template?, params?) => Promise<InferResult>)
        • (prompt, template?, params?): Promise<InferResult>
        • Parameters

          • prompt: string
          • Optional template: string
          • Optional params: InferParams

          Returns Promise<InferResult>

    • loadModel: ((modelConf) => Promise<void>)
        • (modelConf): Promise<void>
        • Parameters

          • modelConf: ModelConf

          Returns Promise<void>

    • loadTask: ((path) => Promise<Task>)
        • (path): Promise<Task>
        • Parameters

          • path: string

          Returns Promise<Task>

    • loadTasks: (() => Promise<Record<string, any>[]>)
        • (): Promise<Record<string, any>[]>
        • Returns Promise<Record<string, any>[]>

    • modelsState: (() => Promise<ModelState>)
        • (): Promise<ModelState>
        • Returns Promise<ModelState>

    • state: {
          isLoadingModel: boolean;
          isModelLoaded: boolean;
          isRunning: boolean;
          isStreaming: boolean;
      }

      The reactive state

      reactive({ isRunning: false, isStreaming: false, isModelLoaded: false, isLoadingModel: false, })

      • isLoadingModel: boolean
      • isModelLoaded: boolean
      • isRunning: boolean
      • isStreaming: boolean
    • unloadModel: (() => Promise<void>)
        • (): Promise<void>
        • Returns Promise<void>

    • get api(): {
          addHeader: ((key, val) => void);
          csrfToken: (() => null | string);
          del: (<T_4>(uri, verbose?) => Promise<ApiResponse<T_4>>);
          get: (<T>(uri, verbose?) => Promise<ApiResponse<T>>);
          hasCsrfCookie: (() => boolean);
          onResponse: ((hook) => void);
          patch: (<T_3>(uri, payload, verbose?) => Promise<ApiResponse<T_3>>);
          post: (<T_1>(uri, payload, multipart?, verbose?) => Promise<ApiResponse<T_1>>);
          postSse: (<T_5>(uri, payload, onChunk, abortController, multipart?, verbose?) => Promise<void>);
          put: (<T_2>(uri, payload, verbose?) => Promise<ApiResponse<T_2>>);
          removeHeader: ((key) => void);
          setCsrfToken: ((token) => void);
          setCsrfTokenFromCookie: ((verbose?) => boolean);
      }

      Get the Restmix api object

    • get model(): ModelConf

      Get the model conf

    • set onError(t: undefined | ((t) => void)): void
    • set onStartEmit(t: undefined | ((s) => void)): void
    • set onToken(t: undefined | ((t) => void)): void

Generated using TypeDoc