@magda/semantic-indexer-sdk 5.2.0

package/dist/index.d.ts

@@ -0,0 +1,1033 @@
+import { DeleteByQuery_Request } from '@opensearch-project/opensearch/api/_core/deleteByQuery.js';
+import { DeleteByQuery_Response } from '@opensearch-project/opensearch/api/_core/deleteByQuery.js';
+import { Search_Response } from '@opensearch-project/opensearch/api/index.js';
+import { TransportRequestOptions } from '@opensearch-project/opensearch/lib/Transport.js';
+import { default as URI_2 } from 'urijs';
+import urijs from 'urijs';
+
+declare interface ApiClientBaseConfig {
+    baseApiUrl?: string;
+}
+
+declare interface ApiKeyBasedConfigOptions extends ApiClientBaseConfig {
+    apiKeyId?: string;
+    apiKey?: string;
+}
+
+/**
+ * A type of aspect in the registry, unique for a tenant.
+ */
+declare class AspectDefinition {
+    /**
+     * The identifier for the aspect type.
+     */
+    "id": string;
+    /**
+     * The name of the aspect.
+     */
+    "name": string;
+    /**
+     * The JSON Schema of this aspect.
+     */
+    "jsonSchema": any;
+}
+
+declare class AspectDefinitionsApi {
+    protected basePath: string;
+    protected defaultHeaders: any;
+    protected authentications: any;
+    constructor(basePath?: string);
+    setApiKey(key: AspectDefinitionsApiApiKeys, value: string): void;
+    /**
+     * Create a new aspect
+     *
+     * @param xMagdaTenantId 0
+     * @param aspect The definition of the new aspect.
+     * @param xMagdaSession Magda internal session id
+     */
+    create(xMagdaTenantId: number, aspect: AspectDefinition, xMagdaSession: string): Promise<{
+        response: Response;
+        body: AspectDefinition;
+    }>;
+    /**
+     * Get a list of all aspects
+     *
+     * @param xMagdaTenantId 0
+     * @param xMagdaSession Magda internal session id
+     */
+    getAll(xMagdaTenantId: number, xMagdaSession?: string): Promise<{
+        response: Response;
+        body: Array<AspectDefinition>;
+    }>;
+    /**
+     * Get an aspect by ID
+     *
+     * @param xMagdaTenantId 0
+     * @param id ID of the aspect to be fetched.
+     * @param xMagdaSession Magda internal session id
+     */
+    getById(xMagdaTenantId: number, id: string, xMagdaSession?: string): Promise<{
+        response: Response;
+        body: AspectDefinition;
+    }>;
+    /**
+     * Modify an aspect by applying a JSON Patch
+     * The patch should follow IETF RFC 6902 (https://tools.ietf.org/html/rfc6902).
+     * @param xMagdaTenantId 0
+     * @param id ID of the aspect to be saved.
+     * @param aspectPatch The RFC 6902 patch to apply to the aspect.
+     * @param xMagdaSession Magda internal session id
+     */
+    patchById(xMagdaTenantId: number, id: string, aspectPatch: Array<Operation>, xMagdaSession: string): Promise<{
+        response: Response;
+        body: AspectDefinition;
+    }>;
+    /**
+     * Modify an aspect by ID
+     * Modifies the aspect with a given ID.  If an aspect with the ID does not yet exist, it is created.
+     * @param xMagdaTenantId 0
+     * @param id ID of the aspect to be saved.
+     * @param aspect The aspect to save.
+     * @param xMagdaSession Magda internal session id
+     */
+    putById(xMagdaTenantId: number, id: string, aspect: AspectDefinition, xMagdaSession: string): Promise<{
+        response: Response;
+        body: AspectDefinition;
+    }>;
+}
+
+declare enum AspectDefinitionsApiApiKeys {
+}
+
+export declare class AuthorizedRegistryClient extends RegistryClient {
+    protected jwt: string;
+    constructor(options: AuthorizedRegistryOptions);
+    getAspectDefinition(aspectId: string): Promise<AspectDefinition>;
+    putAspectDefinition(aspectDefinition: AspectDefinition, tenantId?: number): Promise<AspectDefinition | ServerError>;
+    postHook(hook: WebHook): Promise<WebHook | ServerError>;
+    putHook(hook: WebHook): Promise<WebHook | ServerError>;
+    getHook(hookId: string): Promise<Maybe<WebHook> | ServerError>;
+    getHooks(): Promise<WebHook[] | ServerError>;
+    resumeHook(webhookId: string, succeeded?: boolean, lastEventIdReceived?: string, active?: boolean): Promise<WebHookAcknowledgementResponse | ServerError>;
+    creatRecord(record: Record_2, tenantId?: number): Promise<Record_2 | ServerError>;
+    putRecord(record: Record_2, tenantId?: number): Promise<Record_2 | ServerError>;
+    patchRecord(recordId: string, recordPatch: Operation[], tenantId?: number): Promise<Record_2 | ServerError>;
+    patchRecords(recordIds: string[], recordPatch: Operation[], tenantId?: number): Promise<string[] | ServerError>;
+    putRecordAspect(recordId: string, aspectId: string, aspect: any, merge?: boolean, tenantId?: number): Promise<any | ServerError>;
+    putRecordsAspect(recordIds: string[], aspectId: string, aspectData: any, merge?: boolean, tenantId?: number): Promise<string[] | ServerError>;
+    deleteRecordsAspectArrayItems(recordIds: string[], aspectId: string, jsonPath: string, items: (string | number)[], tenantId?: number): Promise<string[] | ServerError>;
+    deleteRecordAspect(recordId: string, aspectId: string, tenantId?: number): Promise<DeleteResult | ServerError>;
+    patchRecordAspect(recordId: string, aspectId: string, aspectPatch: Operation[], tenantId?: number): Promise<Record_2 | ServerError>;
+    deleteBySource(sourceTagToPreserve: string, sourceId: string, tenantId?: number): Promise<MultipleDeleteResult | "Processing" | ServerError>;
+    deleteRecord(id: string, tenantId?: number): Promise<DeleteResult | ServerError>;
+    getRecordHistory(id: string, pageToken?: string, start?: number, limit?: number): Promise<EventsPage | ServerError>;
+}
+
+declare interface AuthorizedRegistryOptions extends RegistryOptions {
+    jwt?: string;
+    userId?: string;
+    jwtSecret?: string;
+}
+
+declare abstract class BaseApiClient {
+    readonly authMode: "jwtToken" | "apiKey" | "noAuth";
+    protected baseApiUrl: string;
+    private readonly baseApiUri;
+    protected jwtSecret: string;
+    readonly apiKeyId: string;
+    protected apiKey: string;
+    readonly userId: string;
+    constructor(options: BaseApiClientConfig);
+    protected getBaseApiUri(): urijs;
+    protected setHeader(headers: HeadersInit | undefined | null, headerName: string, headerValue: string): [string, string][] | Record<string, string> | Headers;
+    protected addAuthHeader(config?: RequestInit): {
+        body?: BodyInit;
+        cache?: RequestCache;
+        credentials?: RequestCredentials;
+        headers?: HeadersInit;
+        integrity?: string;
+        keepalive?: boolean;
+        method?: string;
+        mode?: RequestMode;
+        redirect?: RequestRedirect;
+        referrer?: string;
+        referrerPolicy?: ReferrerPolicy;
+        signal?: AbortSignal;
+        window?: null;
+    };
+}
+
+declare type BaseApiClientConfig = JWTBasedConfigOptions & ApiKeyBasedConfigOptions;
+
+declare class Chunker {
+    private strategy;
+    constructor(strategy: ChunkStrategy);
+    chunk(text: string): Promise<ChunkResult[]>;
+}
+
+export declare interface ChunkResult {
+    text: string;
+    position: number;
+    length: number;
+    overlap: number;
+}
+
+declare interface ChunkStrategy {
+    chunk: ChunkStrategyType;
+}
+
+export declare type ChunkStrategyType = (text: string) => Promise<ChunkResult[]>;
+
+export declare function commonYargs(defaultPort: number, defaultInternalUrl: string): SemanticIndexerArguments;
+
+declare class CountResponse {
+    "count": number;
+}
+
+export declare type CreateEmbeddingText = (params: CreateEmbeddingTextParams) => Promise<EmbeddingText>;
+
+export declare type CreateEmbeddingTextParams = {
+    record: Record_2;
+    format: string | null;
+    filePath: string | null;
+    url: string | null;
+    readonlyRegistry: AuthorizedRegistryClient;
+};
+
+declare class DeleteRecordsAspectArrayItemsRequest {
+    "recordIds": Array<string>;
+    "jsonPath": string;
+    "items": Array<JsValue>;
+}
+
+declare class DeleteResult {
+    "deleted": boolean;
+}
+
+declare class EmbeddingApiClient extends BaseApiClient {
+    taskSize: number;
+    constructor(options: EmbeddingApiClientConfig);
+    testConnection(): Promise<boolean>;
+    get(text: string): Promise<number[]>;
+    get(textList: string[]): Promise<number[][]>;
+}
+
+declare interface EmbeddingApiClientConfig extends BaseApiClientConfig {
+    taskSize?: number;
+}
+
+export declare type EmbeddingText = {
+    text: string;
+    subObjects?: Array<{
+        subObjectId?: string;
+        subObjectType?: string;
+        text: string;
+    }>;
+};
+
+declare interface Eq<T> {
+    equals(t: T): boolean;
+}
+
+/**
+ * A page of events.
+ */
+declare class EventsPage {
+    /**
+     * Whether there are more events available.
+     */
+    "hasMore": boolean;
+    /**
+     * A token to be used to get the next page of events.
+     */
+    "nextPageToken": string;
+    /**
+     * The events in this page.
+     */
+    "events": Array<RegistryEvent>;
+}
+
+/**
+ * The type of a registry modification event.
+ */
+declare type EventType = "CreateRecord" | "CreateAspectDefinition" | "CreateRecordAspect" | "PatchRecord" | "PatchAspectDefinition" | "PatchRecordAspect" | "DeleteRecord" | "DeleteAspectDefinition" | "DeleteRecordAspect";
+
+declare interface Functor<T> {
+    fmap<U>(f: (t: T) => U): Functor<U>;
+    lift<U>(f: (t: T) => U): Functor<U>;
+    map<U>(f: (t: T) => U): Functor<U>;
+}
+
+export declare function indexEmbeddingText({ options, chunker, embeddingApiClient, opensearchApiClient, embeddingText, metadata
+
+
+
+
+
+
+}: {options: SemanticIndexerOptions;chunker: Chunker;embeddingApiClient: EmbeddingApiClient;opensearchApiClient: OpensearchApiClient;embeddingText: EmbeddingText;metadata: Metadata;}): Promise<void>;
+
+export declare type ItemType = "registryRecord" | "storageObject";
+
+declare class JsObject {
+    "fields": {
+        [key: string]: JsValue;
+    };
+}
+
+declare class JsonPatch {
+    "ops": Array<Operation>;
+}
+
+declare class JsValue {
+}
+
+declare interface JWTBasedConfigOptions extends ApiClientBaseConfig {
+    jwtSecret?: string;
+    userId?: string;
+}
+
+declare class Maybe<T> implements Monad<T>, Functor<T>, Eq<Maybe<T>> {
+    private type;
+    private value?;
+    constructor(type: MaybeType, value?: T);
+    static sequence<T>(t: {
+        [k: string]: Maybe<T>;
+    }): Maybe<{
+        [k: string]: T;
+    }>;
+    static all: (t: {
+        [k: string]: Maybe<any>;
+    }) => Maybe<{
+        [k: string]: any;
+    }>;
+    static maybe<T>(t?: T | null): Maybe<T>;
+    static just<T>(t: T): Maybe<T>;
+    static nothing<T>(): Maybe<T>;
+    static isJust<T>(t: Maybe<T>): boolean;
+    static isNothing<T>(t: Maybe<T>): boolean;
+    unit<U>(u: U): Maybe<U>;
+    bind<U>(f: (t: T) => Maybe<U>): Maybe<U>;
+    of: <U>(u: U) => Maybe<U>;
+    chain: <U>(f: (t: T) => Maybe<U>) => Maybe<U>;
+    fmap<U>(f: (t: T) => U): Maybe<U>;
+    lift: <U>(f: (t: T) => U) => Maybe<U>;
+    map: <U>(f: (t: T) => U) => Maybe<U>;
+    caseOf<U>(patterns: MaybePatterns<T, U>): U;
+    defaulting(defaultValue: T): Maybe<T>;
+    equals(other: Maybe<T>): any;
+    valueOr<U extends T>(defaultValue: U): T | U;
+    valueOrCompute<U extends T>(defaultValueFunction: () => U): T | U;
+    valueOrThrow(error?: Error): T;
+    do(patterns?: Partial<MaybePatterns<T, void>>): Maybe<T>;
+}
+
+declare interface MaybePatterns<T, U> {
+    just: (t: T) => U;
+    nothing: () => U;
+}
+
+declare enum MaybeType {
+    Nothing = 0,
+    Just = 1
+}
+
+declare interface Metadata {
+    recordId: string;
+    parentRecordId?: string;
+    aspectId?: string;
+    fileFormat?: string;
+    subObjectId?: string;
+    subObjectType?: string;
+}
+
+declare interface MinioConfig {
+    endPoint: string;
+    port: number;
+    useSSL: boolean;
+    region: string;
+    defaultDatasetBucket: string;
+}
+
+declare type MinionArguments = {
+    listenPort: string | number;
+    internalUrl: string;
+    jwtSecret: string;
+    userId: string;
+    registryUrl: string;
+    enableMultiTenant: boolean;
+    tenantUrl: string;
+    retries: string | number;
+    crawlerRecordFetchNumber?: string | number;
+};
+
+declare interface Monad<T> {
+    unit<U>(t: U): Monad<U>;
+    bind<U>(f: (t: T) => Monad<U>): Monad<U>;
+    of<U>(t: U): Monad<U>;
+    chain<U>(f: (t: T) => Monad<U>): Monad<U>;
+}
+
+declare class MultipleDeleteResult {
+    "count": number;
+}
+
+declare class OpensearchApiClient {
+    private client;
+    constructor(config: OpensearchConfig);
+    static getOpensearchApiClient(openSearchConfig: OpensearchConfig): Promise<OpensearchApiClient>;
+    ping(): Promise<void>;
+    createIndex(indexDefinition: {
+        indexName: string;
+        settings?: any;
+        mappings?: any;
+    }): Promise<void>;
+    deleteIndex(indexName: string): Promise<void>;
+    indexExists(indexName: string): Promise<boolean>;
+    indexDocument(indexName: string, document: any): Promise<void>;
+    bulkIndexDocument(indexName: string, documents: any[]): Promise<void>;
+    deleteDocument(indexName: string, documentId: string): Promise<void>;
+    deleteByQuery(params: DeleteByQuery_Request, options?: TransportRequestOptions): Promise<DeleteByQuery_Response>;
+    search(indexName: string, searchBody: Record<string, unknown>): Promise<Search_Response>;
+}
+
+declare interface OpensearchConfig {
+    url?: string;
+}
+
+declare class Operation {
+}
+
+declare class PatchRecordsRequest {
+    "recordIds": Array<string>;
+    "jsonPath": JsonPatch;
+}
+
+declare class PutRecordsAspectRequest {
+    "recordIds": Array<string>;
+    "data": JsObject;
+}
+
+/**
+ * A record in the registry, usually including data for one or more aspects, unique for a tenant.
+ */
+declare class Record_2 {
+    /**
+     * The identifier of the record
+     */
+    "id": string;
+    /**
+     * The name of the record
+     */
+    "name": string;
+    /**
+     * The aspects included in this record
+     */
+    "aspects": any;
+    /**
+     * A tag representing the action by the source of this record (e.g. an id for a individual crawl of a data portal).
+     */
+    "sourceTag": string;
+    /**
+     * The identifier of a tenant
+     */
+    "tenantId": number;
+}
+export { Record_2 as Record }
+
+declare class RecordAspectsApi {
+    protected basePath: string;
+    protected defaultHeaders: any;
+    protected authentications: any;
+    constructor(basePath?: string);
+    setApiKey(key: RecordAspectsApiApiKeys, value: string): void;
+    /**
+     * Delete a record aspect by ID
+     * Deletes a record aspect.
+     * @param recordId ID of the record for which to delete an aspect.
+     * @param aspectId ID of the aspect to delete.
+     * @param xMagdaSession Magda internal session id
+     * @param xMagdaTenantId 0
+     */
+    deleteById(recordId: string, aspectId: string, xMagdaSession: string, xMagdaTenantId: number): Promise<{
+        response: Response;
+        body: DeleteResult;
+    }>;
+    /**
+     * Get a list of a record&#39;s aspects
+     *
+     * @param xMagdaTenantId 0
+     * @param recordId ID of the record for which to fetch aspects.
+     * @param keyword Specify the keyword to search in the all aspects&#39; aspectId &amp; data fields.
+     * @param aspectIdOnly When set to true, will respond only an array contains aspect id only.
+     * @param start The index of the first record to retrieve.
+     * @param limit The maximum number of records to receive.
+     * @param xMagdaSession Magda internal session id
+     */
+    getAspects(xMagdaTenantId: number, recordId: string, keyword?: string, aspectIdOnly?: boolean, start?: number, limit?: number, xMagdaSession?: string): Promise<{
+        response: Response;
+        body: Array<any>;
+    }>;
+    /**
+     * Get the number of aspects that a record has
+     *
+     * @param xMagdaTenantId 0
+     * @param recordId ID of the record for which to fetch an aspect.
+     * @param keyword Specify the keyword to search in the all aspects&#39; aspectId &amp; data fields.
+     * @param xMagdaSession Magda internal session id
+     */
+    getAspectsCount(xMagdaTenantId: number, recordId: string, keyword?: string, xMagdaSession?: string): Promise<{
+        response: Response;
+        body: CountResponse;
+    }>;
+    /**
+     * Get a record aspect by ID
+     *
+     * @param xMagdaTenantId 0
+     * @param recordId ID of the record for which to fetch an aspect.
+     * @param aspectId ID of the aspect to fetch.
+     * @param xMagdaSession Magda internal session id
+     */
+    getById(xMagdaTenantId: number, recordId: string, aspectId: string, xMagdaSession?: string): Promise<{
+        response: Response;
+        body: any;
+    }>;
+    /**
+     * Modify a record aspect by applying a JSON Patch
+     * The patch should follow IETF RFC 6902 (https://tools.ietf.org/html/rfc6902).
+     * @param recordId ID of the record for which to fetch an aspect.
+     * @param aspectId ID of the aspect to fetch.
+     * @param aspectPatch The RFC 6902 patch to apply to the aspect.
+     * @param xMagdaSession Magda internal session id
+     * @param xMagdaTenantId 0
+     */
+    patchById(recordId: string, aspectId: string, aspectPatch: Array<Operation>, xMagdaSession: string, xMagdaTenantId: number): Promise<{
+        response: Response;
+        body: any;
+    }>;
+    /**
+     * Modify a record aspect by ID
+     * Modifies a record aspect.  If the aspect does not yet exist on this record, it is created.
+     * @param recordId ID of the record for which to update an aspect.
+     * @param aspectId ID of the aspect to update.
+     * @param aspect The record aspect to save.
+     * @param xMagdaSession Magda internal session id
+     * @param xMagdaTenantId 0
+     * @param merge Whether merge the supplied aspect data to existing aspect data or replace it
+     */
+    putById(recordId: string, aspectId: string, aspect: any, xMagdaSession: string, xMagdaTenantId: number, merge?: boolean): Promise<{
+        response: Response;
+        body: any;
+    }>;
+}
+
+declare enum RecordAspectsApiApiKeys {
+}
+
+declare class RecordHistoryApi {
+    protected basePath: string;
+    protected defaultHeaders: any;
+    protected authentications: any;
+    constructor(basePath?: string);
+    setApiKey(key: RecordHistoryApiApiKeys, value: string): void;
+    /**
+     * Get a list of all events affecting this record
+     *
+     * @param xMagdaTenantId 0
+     * @param recordId ID of the record for which to fetch history.
+     * @param xMagdaSession Magda internal session id
+     * @param pageToken A token that identifies the start of a page of events.  This token should not be interpreted as having any meaning, but it can be obtained from a previous page of results.
+     * @param start The index of the first event to retrieve.  When possible, specify pageToken instead as it will result in better performance.  If this parameter and pageToken are both specified, this parameter is interpreted as the index after the pageToken of the first record to retrieve.
+     * @param limit The maximum number of events to receive.  The response will include a token that can be passed as the pageToken parameter to a future request to continue receiving results where this query leaves off.
+     * @param aspect The aspects for which to included in event history, specified as multiple occurrences of this query parameter.
+     * @param dereference true to automatically dereference links to other records; false to leave them as links.  Dereferencing a link means including the record itself where the link would be.  Dereferencing only happens one level deep, regardless of the value of this parameter.
+     * @param reversePageTokenOrder When pagination via pageToken, by default, records with smaller pageToken (i.e. older records) will be returned first. When this parameter is set to &#x60;true&#x60;, higher pageToken records (newer records) will be returned.
+     */
+    history(xMagdaTenantId: number, recordId: string, xMagdaSession: string, pageToken?: string, start?: number, limit?: number, aspect?: Array<string>, dereference?: boolean, reversePageTokenOrder?: boolean): Promise<{
+        response: Response;
+        body: EventsPage;
+    }>;
+    /**
+     * Get the version of a record that existed after a given event was applied
+     *
+     * @param xMagdaTenantId 0
+     * @param recordId ID of the record to fetch.
+     * @param eventId The ID of the last event to be applied to the record.  The event with this ID need not actually apply to the record, in which case that last event prior to this even that does apply will be used.
+     */
+    version(xMagdaTenantId: number, recordId: string, eventId: string): Promise<{
+        response: Response;
+        body: Record_2;
+    }>;
+}
+
+declare enum RecordHistoryApiApiKeys {
+}
+
+declare class RecordsApi {
+    protected basePath: string;
+    protected defaultHeaders: any;
+    protected authentications: any;
+    constructor(basePath?: string);
+    setApiKey(key: RecordsApiApiKeys, value: string): void;
+    /**
+     * Create a new record
+     *
+     * @param xMagdaTenantId 0
+     * @param record The definition of the new record.
+     * @param xMagdaSession Magda internal session id
+     */
+    create(xMagdaTenantId: number, record: Record_2, xMagdaSession: string): Promise<{
+        response: Response;
+        body: Record_2;
+    }>;
+    /**
+     * Delete a record
+     *
+     * @param xMagdaTenantId 0
+     * @param recordId ID of the record to delete.
+     * @param xMagdaSession Magda internal session id
+     */
+    deleteById(xMagdaTenantId: number, recordId: string, xMagdaSession: string): Promise<{
+        response: Response;
+        body: DeleteResult;
+    }>;
+    /**
+     * Remove items from records&#39; aspect data
+     * Remove items from records&#39; aspect data
+     * @param xMagdaTenantId 0
+     * @param aspectId ID of the aspect to update.
+     * @param requestData An json object has key &#39;recordIds&#39;, &#39;jsonPath&#39;, &#39;items&#39;
+     * @param xMagdaSession Magda internal session id
+     */
+    deleteRecordsAspectArrayItems(xMagdaTenantId: number, aspectId: string, requestData: DeleteRecordsAspectArrayItemsRequest, xMagdaSession: string): Promise<{
+        response: Response;
+        body: Array<any>;
+    }>;
+    /**
+     * Get a list of all records
+     *
+     * @param xMagdaTenantId 0
+     * @param aspect The aspects for which to retrieve data, specified as multiple occurrences of this query parameter.  Only records that have all of these aspects will be included in the response.
+     * @param optionalAspect The optional aspects for which to retrieve data, specified as multiple occurrences of this query parameter.  These aspects will be included in a record if available, but a record will be included even if it is missing these aspects.
+     * @param pageToken A token that identifies the start of a page of results.  This token should not be interpreted as having any meaning, but it can be obtained from a previous page of results.
+     * @param start The index of the first record to retrieve.  When possible, specify pageToken instead as it will result in better performance.  If this parameter and pageToken are both specified, this parameter is interpreted as the index after the pageToken of the first record to retrieve.
+     * @param limit The maximum number of records to receive.  The response will include a token that can be passed as the pageToken parameter to a future request to continue receiving results where this query leaves off.
+     * @param dereference true to automatically dereference links to other records; false to leave them as links.  Dereferencing a link means including the record itself where the link would be.  Dereferencing only happens one level deep, regardless of the value of this parameter.
+     * @param aspectQuery Filter the records returned by a value within the aspect JSON. Expressed as &#39;aspectId.path.to.field:value&#39;, url encoded. NOTE: This is an early stage API and may change greatly in the future
+     * @param aspectOrQuery Filter the records returned by a value within the aspect JSON. Expressed as &#39;aspectId.path.to.field:value&#39;, url encoded. Queries passing via this parameter will be grouped with OR logic. NOTE: This is an early stage API and may change greatly in the future
+     * @param orderBy Specify the field to sort the result. Aspect field can be supported in a format like aspectId.path.to.field
+     * @param orderByDir Specify the order by direction. Either &#x60;asc&#x60; or &#x60;desc&#x60;
+     * @param orderNullFirst Specify whether nulls appear before (&#x60;true&#x60;) or after (&#x60;false&#x60;) non-null values in the sort ordering.
+     * @param reversePageTokenOrder When pagination via pageToken, by default, records with smaller pageToken (i.e. older records) will be returned first. When this parameter is set to &#x60;true&#x60;, higher pageToken records (newer records) will be returned.
+     * @param q full text search query
+     * @param xMagdaSession Magda internal session id
+     */
+    getAll(xMagdaTenantId: number, aspect?: Array<string>, optionalAspect?: Array<string>, pageToken?: string, start?: number, limit?: number, dereference?: boolean, aspectQuery?: Array<string>, aspectOrQuery?: Array<string>, orderBy?: string, orderByDir?: string, orderNullFirst?: boolean, reversePageTokenOrder?: boolean, q?: string, xMagdaSession?: string): Promise<{
+        response: Response;
+        body: Array<Record_2>;
+    }>;
+    /**
+     * Get a list of all records as summaries
+     *
+     * @param xMagdaTenantId 0
+     * @param pageToken A token that identifies the start of a page of results.  This token should not be interpreted as having any meaning, but it can be obtained from a previous page of results.
+     * @param start The index of the first record to retrieve.  When possible, specify pageToken instead as it will result in better performance.  If this parameter and pageToken are both specified, this parameter is interpreted as the index after the pageToken of the first record to retrieve.
+     * @param limit The maximum number of records to receive.  The response will include a token that can be passed as the pageToken parameter to a future request to continue receiving results where this query leaves off.
+     * @param reversePageTokenOrder When pagination via pageToken, by default, records with smaller pageToken (i.e. older records) will be returned first. When this parameter is set to &#x60;true&#x60;, higher pageToken records (newer records) will be returned.
+     * @param q full text search query
+     * @param xMagdaSession Magda internal session id
+     */
+    getAllSummary(xMagdaTenantId: number, pageToken?: string, start?: number, limit?: number, reversePageTokenOrder?: boolean, q?: string, xMagdaSession?: string): Promise<{
+        response: Response;
+        body: Array<RecordSummary>;
+    }>;
+    /**
+     * Get a record by ID
+     * Gets a complete record, including data for all aspects.
+     * @param id ID of the record to be fetched.
+     * @param xMagdaTenantId 0
+     * @param aspect The aspects for which to retrieve data, specified as multiple occurrences of this query parameter.  Only records that have all of these aspects will be included in the response.
+     * @param optionalAspect The optional aspects for which to retrieve data, specified as multiple occurrences of this query parameter.  These aspects will be included in a record if available, but a record will be included even if it is missing these aspects.
+     * @param dereference true to automatically dereference links to other records; false to leave them as links.  Dereferencing a link means including the record itself where the link would be.  Dereferencing only happens one level deep, regardless of the value of this parameter.
+     * @param xMagdaSession Magda internal session id
+     */
+    getById(id: string, xMagdaTenantId: number, aspect?: Array<string>, optionalAspect?: Array<string>, dereference?: boolean, xMagdaSession?: string): Promise<{
+        response: Response;
+        body: Record_2;
+    }>;
+    /**
+     * Get a record in full by ID
+     * Get a record with all attached aspects data by the record ID.
+     * @param id ID of the record to be fetched.
+     * @param xMagdaTenantId 0
+     * @param xMagdaSession Magda internal session id
+     */
+    getByIdInFull(id: string, xMagdaTenantId: number, xMagdaSession?: string): Promise<{
+        response: Response;
+        body: Record_2;
+    }>;
+    /**
+     * Get a summary record by ID
+     * Gets a summary record, including all the aspect ids for which this record has data.
+     * @param id ID of the record to be fetched.
+     * @param xMagdaTenantId 0
+     * @param xMagdaSession Magda internal session id
+     */
+    getByIdSummary(id: string, xMagdaTenantId: number, xMagdaSession?: string): Promise<{
+        response: Response;
+        body: RecordSummary;
+    }>;
+    /**
+     * Get the count of records matching the parameters. If no parameters are specified, the count will be approximate for performance reasons.
+     *
+     * @param xMagdaTenantId 0
+     * @param aspect The aspects for which to retrieve data, specified as multiple occurrences of this query parameter.  Only records that have all of these aspects will be included in the response.
+     * @param aspectQuery Filter the records returned by a value within the aspect JSON. Expressed as &#39;aspectId.path.to.field:value&#39;, url encoded. NOTE: This is an early stage API and may change greatly in the future
+     * @param aspectOrQuery Filter the records returned by a value within the aspect JSON. Expressed as &#39;aspectId.path.to.field:value&#39;, url encoded. Queries passing via this parameter will be grouped with OR logic.
+     * @param q full text search query
+     * @param xMagdaSession Magda internal session id
+     */
+    getCount(xMagdaTenantId: number, aspect?: Array<string>, aspectQuery?: Array<string>, aspectOrQuery?: Array<string>, q?: string, xMagdaSession?: string): Promise<{
+        response: Response;
+        body: CountResponse;
+    }>;
+    /**
+     * Get a list tokens for paging through the records
+     *
+     * @param xMagdaTenantId 0
+     * @param aspect The aspects for which to retrieve data, specified as multiple occurrences of this query parameter.  Only records that have all of these aspects will be included in the response.
+     * @param limit The size of each page to get tokens for.
+     * @param xMagdaSession Magda internal session id
+     */
+    getPageTokens(xMagdaTenantId: number, aspect?: Array<string>, limit?: number, xMagdaSession?: string): Promise<{
+        response: Response;
+        body: Array<string>;
+    }>;
+    /**
+     * Modify a record by applying a JSON Patch
+     * The patch should follow IETF RFC 6902 (https://tools.ietf.org/html/rfc6902).
+     * @param xMagdaTenantId 0
+     * @param id ID of the record to be pacthed.
+     * @param recordPatch The RFC 6902 patch to apply to the aspect.
+     * @param xMagdaSession Magda internal session id
+     */
+    patchById(xMagdaTenantId: number, id: string, recordPatch: Array<Operation>, xMagdaSession: string): Promise<{
+        response: Response;
+        body: Record_2;
+    }>;
+    /**
+     * Modify a list of records by applying the same JSON Patch
+     * The patch should follow IETF RFC 6902 (https://tools.ietf.org/html/rfc6902).
+     * @param xMagdaTenantId 0
+     * @param requestData An json object has key &#39;recordIds&#39; &amp; &#39;jsonPath&#39;
+     * @param xMagdaSession Magda internal session id
+     */
+    patchRecords(xMagdaTenantId: number, requestData: PatchRecordsRequest, xMagdaSession: string): Promise<{
+        response: Response;
+        body: Array<any>;
+    }>;
+    /**
+     * Modify a record by ID
+     * Modifies a record.  Aspects included in the request are created or updated, but missing aspects are not removed.
+     * @param xMagdaTenantId 0
+     * @param id ID of the record to be fetched.
+     * @param record The record to save.
+     * @param xMagdaSession Magda internal session id
+     * @param merge Whether merge the supplied aspect data to existing aspect data or replace it
+     */
+    putById(xMagdaTenantId: number, id: string, record: Record_2, xMagdaSession: string, merge?: boolean): Promise<{
+        response: Response;
+        body: Record_2;
+    }>;
+    /**
+     * Modify a list of records&#39;s aspect with same new data
+     * Modify a list of records&#39;s aspect with same new data
+     * @param xMagdaTenantId 0
+     * @param aspectId ID of the aspect to update.
+     * @param requestData An json object has key &#39;recordIds&#39; &amp; &#39;data&#39;
+     * @param xMagdaSession Magda internal session id
+     * @param merge Whether merge the supplied aspect data to existing aspect data or replace it
+     */
+    putRecordsAspect(xMagdaTenantId: number, aspectId: string, requestData: PutRecordsAspectRequest, xMagdaSession: string, merge?: boolean): Promise<{
+        response: Response;
+        body: Array<any>;
+    }>;
+    /**
+     * Trim by source tag
+     * Trims records with the provided source that DON&#39;T have the supplied source tag
+     * @param xMagdaTenantId 0
+     * @param sourceTagToPreserve Source tag of the records to PRESERVE.
+     * @param sourceId Source id of the records to delete.
+     * @param xMagdaSession Magda internal session id
+     */
+    trimBySourceTag(xMagdaTenantId: number, sourceTagToPreserve: string, sourceId: string, xMagdaSession: string): Promise<{
+        response: Response;
+        body: MultipleDeleteResult;
+    }>;
+}
+
+declare enum RecordsApiApiKeys {
+}
+
+declare interface RecordsPage<I extends Record_2> {
+    totalCount: number;
+    hasMore: boolean;
+    nextPageToken?: string;
+    records: I[];
+}
+
+/**
+ * A summary of a record in the registry.  Summaries specify which aspects are available, but do not include data for any aspects.
+ */
+declare class RecordSummary {
+    /**
+     * The identifier of the record
+     */
+    "id": string;
+    /**
+     * The name of the record
+     */
+    "name": string;
+    /**
+     * The list of aspect IDs for which this record has data
+     */
+    "aspects": Array<string>;
+    /**
+     * The identifier of the tenant
+     */
+    "tenantId": number;
+}
+
+declare class RegistryClient {
+    protected baseUri: URI_2;
+    protected aspectDefinitionsApi: AspectDefinitionsApi;
+    protected recordsApi: RecordsApi;
+    protected webHooksApi: WebHooksApi;
+    protected recordAspectsApi: RecordAspectsApi;
+    protected recordHistoryApi: RecordHistoryApi;
+    protected maxRetries: number;
+    protected secondsBetweenRetries: number;
+    protected tenantId: number;
+    protected jwt: string | undefined;
+    constructor({ baseUrl, maxRetries, secondsBetweenRetries, tenantId }: RegistryOptions);
+    getRecordUrl(id: string): string;
+    getAspectDefinitions(): Promise<AspectDefinition[] | ServerError>;
+    getAspectDefinition(aspectId: string, jwtToken?: string): Promise<AspectDefinition>;
+    getRecord(id: string, aspect?: Array<string>, optionalAspect?: Array<string>, dereference?: boolean): Promise<Record_2 | ServerError>;
+    getRecordAspect(id: string, aspectId: string): Promise<any | ServerError>;
+    getRecordInFull(id: string): Promise<Record_2>;
+    getRecords<I extends Record_2>(aspect?: Array<string>, optionalAspect?: Array<string>, pageToken?: string, dereference?: boolean, limit?: number, aspectQueries?: string[], aspectOrQuery?: string[], orderBy?: string, orderByDir?: string, orderNullFirst?: boolean, reversePageTokenOrder?: boolean, q?: string): Promise<RecordsPage<I> | ServerError>;
+    getRecordsPageTokens(aspect?: Array<string>, limit?: number): Promise<string[] | ServerError>;
+}
+
+declare class RegistryEvent {
+    "id": any;
+    "eventTime": Date;
+    "eventType": EventType;
+    "userId": string;
+    "data": JsObject;
+    "tenantId": number;
+}
+
+declare interface RegistryOptions {
+    baseUrl: string;
+    maxRetries?: number;
+    secondsBetweenRetries?: number;
+    tenantId: number;
+}
+
+declare function semanticIndexer(userConfig: SemanticIndexerOptions): Promise<void>;
+export default semanticIndexer;
+
+declare interface SemanticIndexerArguments extends MinionArguments {
+    opensearchApiURL: string;
+    embeddingApiURL: string;
+    semanticIndexerConfig: SemanticIndexerConfig;
+    minioConfig: MinioConfig;
+    minioAccessKey: string;
+    minioSecretKey: string;
+    registryReadonlyURL: string;
+}
+
+declare interface SemanticIndexerConfig {
+    numberOfShards: number;
+    numberOfReplicas: number;
+    indexName: string;
+    indexVersion: number;
+    chunkSizeLimit: number;
+    overlap: number;
+    bulkEmbeddingsSize: number;
+    bulkIndexSize: number;
+    fullIndexName?: string;
+    knnVectorFieldConfig: {
+        mode: string;
+        dimension: number;
+        spaceType: string;
+        efConstruction: number;
+        efSearch: number;
+        m: number;
+        encoder?: {
+            name: string;
+            type: string;
+            clip: boolean;
+        };
+        compressionLevel?: string;
+    };
+}
+
+export declare interface SemanticIndexerOptions {
+    argv: SemanticIndexerArguments;
+    id: string;
+    itemType: ItemType;
+    aspects?: string[];
+    optionalAspects?: string[];
+    formatTypes?: string[];
+    createEmbeddingText: CreateEmbeddingText;
+    chunkStrategy?: ChunkStrategyType;
+    chunkSizeLimit?: number;
+    overlap?: number;
+    autoDownloadFile?: boolean;
+    timeout?: string;
+}
+
+declare class ServerError extends Error {
+    statusCode: number;
+    constructor(message?: string, statusCode?: number);
+    toData(): {
+        isError: boolean;
+        errorCode: number;
+        errorMessage: string;
+    };
+}
+
+declare class WebHook {
+    "id": string;
+    "name": string;
+    "active": boolean;
+    "lastEvent": any;
+    "url": string;
+    "eventTypes": Array<EventType>;
+    "isWaitingForResponse": any;
+    "config": WebHookConfig;
+    "enabled": boolean;
+    "lastRetryTime": Date;
+    "retryCount": number;
+    "isRunning": any;
+    "isProcessing": any;
+    "ownerId": string;
+    "creatorId": string;
+    "editorId": string;
+    "createTime": Date;
+    "editTime": Date;
+}
+
+/**
+ * Asynchronously acknowledges receipt of a web hook notification.
+ */
+declare class WebHookAcknowledgement {
+    /**
+     * True if the web hook was received successfully and the listener is ready for further notifications.  False if the web hook was not received and the same notification should be repeated.
+     */
+    "succeeded": boolean;
+    /**
+     * The ID of the last event received by the listener.  This should be the value of the `lastEventId` property of the web hook payload that is being acknowledged.  This value is ignored if `succeeded` is false.
+     */
+    "lastEventIdReceived": any;
+    /**
+     * Should the webhook be active or inactive?
+     */
+    "active": any;
+}
+
+/**
+ * The response to an asynchronous web hook acknowledgement.
+ */
+declare class WebHookAcknowledgementResponse {
+    /**
+     * The ID of the last event successfully received by the listener.  Further notifications will start after this event.
+     */
+    "lastEventIdReceived": number;
+}
+
+declare class WebHookConfig {
+    "aspects": Array<string>;
+    "optionalAspects": Array<string>;
+    "includeEvents": any;
+    "includeRecords": any;
+    "includeAspectDefinitions": any;
+    "dereference": any;
+}
+
+declare class WebHooksApi {
+    protected basePath: string;
+    protected defaultHeaders: any;
+    protected authentications: any;
+    constructor(basePath?: string);
+    setApiKey(key: WebHooksApiApiKeys, value: string): void;
+    /**
+     * Acknowledge a previously-deferred web hook
+     * Acknowledges a previously-deferred web hook with a given ID.  Acknowledging a previously-POSTed web hook will cause the next, if any, to be sent.
+     * @param id ID of the web hook to be acknowledged.
+     * @param acknowledgement The details of the acknowledgement.
+     * @param xMagdaSession Magda internal session id
+     */
+    ack(id: string, acknowledgement: WebHookAcknowledgement, xMagdaSession: string): Promise<{
+        response: Response;
+        body: WebHookAcknowledgementResponse;
+    }>;
+    /**
+     * Create a new web hook
+     *
+     * @param hook The definition of the new web hook.
+     * @param xMagdaSession Magda internal session id
+     */
+    create(hook: WebHook, xMagdaSession: string): Promise<{
+        response: Response;
+        body: WebHook;
+    }>;
+    /**
+     * Delete a web hook
+     *
+     * @param hookId ID of the web hook to delete.
+     * @param xMagdaSession Magda internal session id
+     */
+    deleteById(hookId: string, xMagdaSession: string): Promise<{
+        response: Response;
+        body: DeleteResult;
+    }>;
+    /**
+     * Get a list of all web hooks
+     *
+     * @param xMagdaSession Magda internal session id
+     */
+    getAll(xMagdaSession: string): Promise<{
+        response: Response;
+        body: Array<WebHook>;
+    }>;
+    /**
+     * Get a web hook by ID
+     *
+     * @param id ID of the web hook to be fetched.
+     * @param xMagdaSession Magda internal session id
+     */
+    getById(id: string, xMagdaSession: string): Promise<{
+        response: Response;
+        body: WebHook;
+    }>;
+    /**
+     * Modify a web hook by ID
+     * Modifies the web hook with a given ID.  If a web hook with the ID does not yet exist, it is created.
+     * @param id ID of the aspect to be saved.
+     * @param hook The web hook to save.
+     * @param xMagdaSession Magda internal session id
+     */
+    putById(id: string, hook: WebHook, xMagdaSession: string): Promise<{
+        response: Response;
+        body: WebHook;
+    }>;
+}
+
+declare enum WebHooksApiApiKeys {
+}
+
+export { }