@layerum-team/rag-sdk 0.1.0

package/dist/index.d.cts

@@ -0,0 +1,282 @@
+type UUID = string;
+type Visibility = "self" | "self_and_descendants";
+type RequestMethod = "GET" | "POST" | "PATCH" | "DELETE";
+type Entity = {
+    id: UUID;
+    parentId?: UUID | null;
+    parent_id?: UUID | null;
+    entityTypeId?: UUID | null;
+    entity_type_id?: UUID | null;
+    name: string;
+    description?: string | null;
+    metadata?: Record<string, unknown>;
+    depth?: number;
+    children?: Entity[];
+};
+type EntityType = {
+    id: UUID;
+    name: string;
+    label: string;
+};
+type DataSource = {
+    id: UUID;
+    entityId: UUID;
+    entity_id?: UUID;
+    sourceType: "file" | "url" | "text" | "api";
+    source_type?: "file" | "url" | "text" | "api";
+    displayName: string;
+    display_name?: string;
+    visibility: Visibility;
+    status: "pending" | "processing" | "completed" | "failed";
+    mimeType?: string | null;
+    mime_type?: string | null;
+    fileSize?: number | null;
+    file_size?: number | null;
+    createdAt: string;
+    created_at?: string;
+    updatedAt: string;
+    updated_at?: string;
+};
+type SourceErrorDetails = {
+    sourceId: UUID;
+    status: DataSource["status"];
+    latestJob: {
+        id: UUID;
+        status: "pending" | "processing" | "completed" | "failed";
+        error_message?: string | null;
+        steps_completed?: string[];
+        updated_at?: string;
+        created_at?: string;
+        metadata?: Record<string, unknown> | null;
+    };
+};
+type ModelDefinition = {
+    id: UUID;
+    provider: string;
+    provider_key: string;
+    display_name: string;
+    model_type: "llm" | "embedding" | "reranker" | "speech";
+    context_window?: number | null;
+    max_output?: number | null;
+    capabilities?: string[];
+};
+type ModelConfig = {
+    id: UUID;
+    entityId?: UUID | null;
+    entity_id?: UUID | null;
+    name: string;
+};
+type QueryResponse = {
+    answer: string;
+    citations: Array<{
+        index: number;
+        documentTitle: string | null;
+        document_title?: string | null;
+        chunk_id?: UUID;
+        document_id?: UUID;
+        excerpt: string;
+        matchScoreRaw?: number;
+    }>;
+    meta?: {
+        resolvedEntityIds: UUID[];
+        topK: number;
+        latencyMs: number;
+        tokensUsed?: number;
+    };
+};
+type LayerumClientOptions = {
+    apiKey: string;
+    /**
+     * @deprecated Workspace is resolved from lyr_wk_* API key.
+     */
+    workspaceId?: UUID;
+    baseUrl?: string;
+    timeoutMs?: number;
+    maxRetries?: number;
+};
+type UploadFileInput = Blob | File | Buffer | Uint8Array | ArrayBuffer;
+type CreateEntityInput = {
+    entityTypeId: UUID;
+    name: string;
+    description?: string;
+    parentId?: UUID;
+    metadata?: Record<string, unknown>;
+};
+type CreateEntityTypeInput = {
+    name: string;
+    label: string;
+};
+type ListSourcesInput = {
+    entityId: UUID;
+    allInWorkspace?: boolean;
+};
+type UploadDocumentInput = {
+    entityId: UUID;
+    file: UploadFileInput;
+    fileName: string;
+    contentType?: string;
+    visibility?: Visibility;
+    modelConfigId?: UUID;
+};
+type UploadInitInput = {
+    entityId: UUID;
+    fileName: string;
+    fileSizeBytes: number;
+    contentType?: string;
+    visibility?: Visibility;
+    modelConfigId?: UUID;
+};
+type UploadInitResponse = {
+    uploadId: UUID;
+    objectKey: string;
+    uploadUrl: string;
+    method: "POST";
+    fields: Record<string, string>;
+    expiresInSeconds: number;
+};
+type CreateTextDocumentInput = {
+    entityId: UUID;
+    displayName: string;
+    rawText: string;
+    visibility?: Visibility;
+    modelConfigId?: UUID;
+};
+type CreateUrlDocumentInput = {
+    entityId: UUID;
+    displayName: string;
+    sourceUrl: string;
+    visibility?: Visibility;
+    modelConfigId?: UUID;
+};
+type DeleteDocumentInput = {
+    entityId: UUID;
+    sourceId: UUID;
+};
+type WaitUntilReadyInput = {
+    entityId: UUID;
+    sourceId: UUID;
+    timeoutMs?: number;
+    intervalMs?: number;
+};
+type QueryInput = {
+    entityId: UUID;
+    modelConfigId: UUID;
+    query: string;
+    topK?: number;
+    includeParentScopes?: boolean;
+};
+type ListModelDefinitionsInput = {
+    type?: string;
+};
+
+type HttpClientOptions = {
+    baseUrl: string;
+    apiKey: string;
+    timeoutMs: number;
+    maxRetries: number;
+};
+type RequestOptions = {
+    method?: RequestMethod;
+    body?: unknown;
+    isFormData?: boolean;
+};
+declare class HttpClient {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly timeoutMs;
+    private readonly maxRetries;
+    constructor(options: HttpClientOptions);
+    request<T>(path: string, options?: RequestOptions): Promise<T>;
+}
+
+declare class EntitiesApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(parentId?: UUID): Promise<Entity[]>;
+    tree(): Promise<Entity[]>;
+    create(input: CreateEntityInput): Promise<Entity>;
+    remove(entityId: UUID): Promise<{
+        success: boolean;
+    }>;
+}
+declare class EntityTypesApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(): Promise<EntityType[]>;
+    get(entityTypeId: UUID): Promise<EntityType>;
+    create(input: CreateEntityTypeInput): Promise<EntityType>;
+    remove(entityTypeId: UUID): Promise<{
+        success: boolean;
+    }>;
+}
+declare class DocumentsApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(input: ListSourcesInput): Promise<DataSource[]>;
+    get(entityId: UUID, sourceId: UUID): Promise<DataSource>;
+    upload(input: UploadDocumentInput): Promise<DataSource>;
+    uploadInit(input: UploadInitInput): Promise<UploadInitResponse>;
+    uploadComplete(input: {
+        entityId: UUID;
+        uploadId: UUID;
+        displayName?: string;
+        visibility?: Visibility;
+        modelConfigId?: UUID;
+        checksum?: string;
+    }): Promise<DataSource>;
+    uploadDirect(input: UploadDocumentInput): Promise<DataSource>;
+    createText(input: CreateTextDocumentInput): Promise<DataSource>;
+    createUrl(input: CreateUrlDocumentInput): Promise<DataSource>;
+    remove(input: DeleteDocumentInput): Promise<{
+        success: boolean;
+    }>;
+}
+declare class IngestionApi {
+    private readonly http;
+    private readonly documentsApi;
+    constructor(http: HttpClient, documentsApi: DocumentsApi);
+    retry(input: {
+        entityId: UUID;
+        sourceId: UUID;
+    }): Promise<{
+        success: boolean;
+        queued: boolean;
+        dataSourceId: UUID;
+    }>;
+    error(input: {
+        entityId: UUID;
+        sourceId: UUID;
+    }): Promise<SourceErrorDetails>;
+    waitUntilReady(input: WaitUntilReadyInput): Promise<DataSource>;
+}
+declare class QueryApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(input: QueryInput): Promise<QueryResponse>;
+    runDebug(input: QueryInput): Promise<QueryResponse>;
+}
+declare class ModelsApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    listConfigs(): Promise<ModelConfig[]>;
+    listDefinitions(input?: ListModelDefinitionsInput): Promise<ModelDefinition[]>;
+}
+declare class LayerumClient {
+    readonly entities: EntitiesApi;
+    readonly entityTypes: EntityTypesApi;
+    readonly documents: DocumentsApi;
+    readonly ingestion: IngestionApi;
+    readonly query: QueryApi;
+    readonly models: ModelsApi;
+    constructor(options: LayerumClientOptions);
+}
+
+declare class LayerumApiError extends Error {
+    status: number;
+    details?: unknown;
+    path?: string;
+    method?: string;
+    constructor(message: string, status: number, details?: unknown, method?: string, path?: string);
+}
+
+export { type CreateEntityInput, type CreateEntityTypeInput, type CreateTextDocumentInput, type CreateUrlDocumentInput, type DataSource, type DeleteDocumentInput, type Entity, type EntityType, LayerumApiError, LayerumClient, type LayerumClientOptions, type ListModelDefinitionsInput, type ListSourcesInput, type ModelConfig, type ModelDefinition, type QueryInput, type QueryResponse, type SourceErrorDetails, type UUID, type UploadDocumentInput, type UploadFileInput, type UploadInitInput, type UploadInitResponse, type Visibility, type WaitUntilReadyInput };

package/dist/index.d.ts

@@ -0,0 +1,282 @@
+type UUID = string;
+type Visibility = "self" | "self_and_descendants";
+type RequestMethod = "GET" | "POST" | "PATCH" | "DELETE";
+type Entity = {
+    id: UUID;
+    parentId?: UUID | null;
+    parent_id?: UUID | null;
+    entityTypeId?: UUID | null;
+    entity_type_id?: UUID | null;
+    name: string;
+    description?: string | null;
+    metadata?: Record<string, unknown>;
+    depth?: number;
+    children?: Entity[];
+};
+type EntityType = {
+    id: UUID;
+    name: string;
+    label: string;
+};
+type DataSource = {
+    id: UUID;
+    entityId: UUID;
+    entity_id?: UUID;
+    sourceType: "file" | "url" | "text" | "api";
+    source_type?: "file" | "url" | "text" | "api";
+    displayName: string;
+    display_name?: string;
+    visibility: Visibility;
+    status: "pending" | "processing" | "completed" | "failed";
+    mimeType?: string | null;
+    mime_type?: string | null;
+    fileSize?: number | null;
+    file_size?: number | null;
+    createdAt: string;
+    created_at?: string;
+    updatedAt: string;
+    updated_at?: string;
+};
+type SourceErrorDetails = {
+    sourceId: UUID;
+    status: DataSource["status"];
+    latestJob: {
+        id: UUID;
+        status: "pending" | "processing" | "completed" | "failed";
+        error_message?: string | null;
+        steps_completed?: string[];
+        updated_at?: string;
+        created_at?: string;
+        metadata?: Record<string, unknown> | null;
+    };
+};
+type ModelDefinition = {
+    id: UUID;
+    provider: string;
+    provider_key: string;
+    display_name: string;
+    model_type: "llm" | "embedding" | "reranker" | "speech";
+    context_window?: number | null;
+    max_output?: number | null;
+    capabilities?: string[];
+};
+type ModelConfig = {
+    id: UUID;
+    entityId?: UUID | null;
+    entity_id?: UUID | null;
+    name: string;
+};
+type QueryResponse = {
+    answer: string;
+    citations: Array<{
+        index: number;
+        documentTitle: string | null;
+        document_title?: string | null;
+        chunk_id?: UUID;
+        document_id?: UUID;
+        excerpt: string;
+        matchScoreRaw?: number;
+    }>;
+    meta?: {
+        resolvedEntityIds: UUID[];
+        topK: number;
+        latencyMs: number;
+        tokensUsed?: number;
+    };
+};
+type LayerumClientOptions = {
+    apiKey: string;
+    /**
+     * @deprecated Workspace is resolved from lyr_wk_* API key.
+     */
+    workspaceId?: UUID;
+    baseUrl?: string;
+    timeoutMs?: number;
+    maxRetries?: number;
+};
+type UploadFileInput = Blob | File | Buffer | Uint8Array | ArrayBuffer;
+type CreateEntityInput = {
+    entityTypeId: UUID;
+    name: string;
+    description?: string;
+    parentId?: UUID;
+    metadata?: Record<string, unknown>;
+};
+type CreateEntityTypeInput = {
+    name: string;
+    label: string;
+};
+type ListSourcesInput = {
+    entityId: UUID;
+    allInWorkspace?: boolean;
+};
+type UploadDocumentInput = {
+    entityId: UUID;
+    file: UploadFileInput;
+    fileName: string;
+    contentType?: string;
+    visibility?: Visibility;
+    modelConfigId?: UUID;
+};
+type UploadInitInput = {
+    entityId: UUID;
+    fileName: string;
+    fileSizeBytes: number;
+    contentType?: string;
+    visibility?: Visibility;
+    modelConfigId?: UUID;
+};
+type UploadInitResponse = {
+    uploadId: UUID;
+    objectKey: string;
+    uploadUrl: string;
+    method: "POST";
+    fields: Record<string, string>;
+    expiresInSeconds: number;
+};
+type CreateTextDocumentInput = {
+    entityId: UUID;
+    displayName: string;
+    rawText: string;
+    visibility?: Visibility;
+    modelConfigId?: UUID;
+};
+type CreateUrlDocumentInput = {
+    entityId: UUID;
+    displayName: string;
+    sourceUrl: string;
+    visibility?: Visibility;
+    modelConfigId?: UUID;
+};
+type DeleteDocumentInput = {
+    entityId: UUID;
+    sourceId: UUID;
+};
+type WaitUntilReadyInput = {
+    entityId: UUID;
+    sourceId: UUID;
+    timeoutMs?: number;
+    intervalMs?: number;
+};
+type QueryInput = {
+    entityId: UUID;
+    modelConfigId: UUID;
+    query: string;
+    topK?: number;
+    includeParentScopes?: boolean;
+};
+type ListModelDefinitionsInput = {
+    type?: string;
+};
+
+type HttpClientOptions = {
+    baseUrl: string;
+    apiKey: string;
+    timeoutMs: number;
+    maxRetries: number;
+};
+type RequestOptions = {
+    method?: RequestMethod;
+    body?: unknown;
+    isFormData?: boolean;
+};
+declare class HttpClient {
+    private readonly baseUrl;
+    private readonly apiKey;
+    private readonly timeoutMs;
+    private readonly maxRetries;
+    constructor(options: HttpClientOptions);
+    request<T>(path: string, options?: RequestOptions): Promise<T>;
+}
+
+declare class EntitiesApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(parentId?: UUID): Promise<Entity[]>;
+    tree(): Promise<Entity[]>;
+    create(input: CreateEntityInput): Promise<Entity>;
+    remove(entityId: UUID): Promise<{
+        success: boolean;
+    }>;
+}
+declare class EntityTypesApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(): Promise<EntityType[]>;
+    get(entityTypeId: UUID): Promise<EntityType>;
+    create(input: CreateEntityTypeInput): Promise<EntityType>;
+    remove(entityTypeId: UUID): Promise<{
+        success: boolean;
+    }>;
+}
+declare class DocumentsApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    list(input: ListSourcesInput): Promise<DataSource[]>;
+    get(entityId: UUID, sourceId: UUID): Promise<DataSource>;
+    upload(input: UploadDocumentInput): Promise<DataSource>;
+    uploadInit(input: UploadInitInput): Promise<UploadInitResponse>;
+    uploadComplete(input: {
+        entityId: UUID;
+        uploadId: UUID;
+        displayName?: string;
+        visibility?: Visibility;
+        modelConfigId?: UUID;
+        checksum?: string;
+    }): Promise<DataSource>;
+    uploadDirect(input: UploadDocumentInput): Promise<DataSource>;
+    createText(input: CreateTextDocumentInput): Promise<DataSource>;
+    createUrl(input: CreateUrlDocumentInput): Promise<DataSource>;
+    remove(input: DeleteDocumentInput): Promise<{
+        success: boolean;
+    }>;
+}
+declare class IngestionApi {
+    private readonly http;
+    private readonly documentsApi;
+    constructor(http: HttpClient, documentsApi: DocumentsApi);
+    retry(input: {
+        entityId: UUID;
+        sourceId: UUID;
+    }): Promise<{
+        success: boolean;
+        queued: boolean;
+        dataSourceId: UUID;
+    }>;
+    error(input: {
+        entityId: UUID;
+        sourceId: UUID;
+    }): Promise<SourceErrorDetails>;
+    waitUntilReady(input: WaitUntilReadyInput): Promise<DataSource>;
+}
+declare class QueryApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    run(input: QueryInput): Promise<QueryResponse>;
+    runDebug(input: QueryInput): Promise<QueryResponse>;
+}
+declare class ModelsApi {
+    private readonly http;
+    constructor(http: HttpClient);
+    listConfigs(): Promise<ModelConfig[]>;
+    listDefinitions(input?: ListModelDefinitionsInput): Promise<ModelDefinition[]>;
+}
+declare class LayerumClient {
+    readonly entities: EntitiesApi;
+    readonly entityTypes: EntityTypesApi;
+    readonly documents: DocumentsApi;
+    readonly ingestion: IngestionApi;
+    readonly query: QueryApi;
+    readonly models: ModelsApi;
+    constructor(options: LayerumClientOptions);
+}
+
+declare class LayerumApiError extends Error {
+    status: number;
+    details?: unknown;
+    path?: string;
+    method?: string;
+    constructor(message: string, status: number, details?: unknown, method?: string, path?: string);
+}
+
+export { type CreateEntityInput, type CreateEntityTypeInput, type CreateTextDocumentInput, type CreateUrlDocumentInput, type DataSource, type DeleteDocumentInput, type Entity, type EntityType, LayerumApiError, LayerumClient, type LayerumClientOptions, type ListModelDefinitionsInput, type ListSourcesInput, type ModelConfig, type ModelDefinition, type QueryInput, type QueryResponse, type SourceErrorDetails, type UUID, type UploadDocumentInput, type UploadFileInput, type UploadInitInput, type UploadInitResponse, type Visibility, type WaitUntilReadyInput };