liferay-headless-rest-client
Version:
A collection of Headless Clients used in Liferay Portal
27 lines (26 loc) • 2.78 kB
TypeScript
import type { Options as ClientOptions, TDataShape, Client } from '@hey-api/client-fetch';
import type { GetEmbeddingEmbeddingModelsPageData, GetEmbeddingEmbeddingModelsPageResponses, PostEmbeddingValidateProviderConfigurationData, PostEmbeddingValidateProviderConfigurationResponses, GetSearchPageData, GetSearchPageResponses, PostSearchPageData, PostSearchPageResponses, PostSuggestionsPageData, PostSuggestionsPageResponses } from './types.gen';
export type Options<TData extends TDataShape = TDataShape, ThrowOnError extends boolean = boolean> = ClientOptions<TData, ThrowOnError> & {
/**
* You can provide a client instance returned by `createClient()` instead of
* individual options. This might be also useful if you want to implement a
* custom client.
*/
client?: Client;
/**
* You can pass arbitrary values through the `meta` object. This can be
* used to access values that aren't defined as part of the SDK function.
*/
meta?: Record<string, unknown>;
};
export declare const getEmbeddingEmbeddingModelsPage: <ThrowOnError extends boolean = false>(options?: Options<GetEmbeddingEmbeddingModelsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetEmbeddingEmbeddingModelsPageResponses, unknown, ThrowOnError, "fields">;
export declare const postEmbeddingValidateProviderConfiguration: <ThrowOnError extends boolean = false>(options?: Options<PostEmbeddingValidateProviderConfigurationData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostEmbeddingValidateProviderConfigurationResponses, unknown, ThrowOnError, "fields">;
/**
* Search the company index for matching content. This endpoint is development and requires setting the portal property 'feature.flag.LPD-11232' to true or enabling via Instance Settings > Feature Flags: Developer.
*/
export declare const getSearchPage: <ThrowOnError extends boolean = false>(options?: Options<GetSearchPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<GetSearchPageResponses, unknown, ThrowOnError, "fields">;
/**
* Search the company index for matching content. This endpoint requires setting the portal property 'feature.flag.LPS-179669' to true or enabling via Instance Settings > Feature Flags: Release.
*/
export declare const postSearchPage: <ThrowOnError extends boolean = false>(options?: Options<PostSearchPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSearchPageResponses, unknown, ThrowOnError, "fields">;
export declare const postSuggestionsPage: <ThrowOnError extends boolean = false>(options?: Options<PostSuggestionsPageData, ThrowOnError>) => import("@hey-api/client-fetch").RequestResult<PostSuggestionsPageResponses, unknown, ThrowOnError, "fields">;