@aristech-org/nlp-client/dist/generated/projects.d.ts

A Node.js client library for the Aristech NLP Service

import { BinaryReader, BinaryWriter } from "@bufbuild/protobuf/wire";
export declare const protobufPackage = "aristech.nlp";
/** Empty request to retrieve all projects. */
export interface GetProjectsRequest {
}
/** A project represents a collection of intents. */
export interface Project {
    /** Unique ID of the project. */
    id: string;
    /** Name of the project. */
    name: string;
}
/** Request to add a new project. */
export interface AddProjectRequest {
    /** Name of the project. */
    name: string;
    /** Description of the project. */
    description: string;
    /** Model used for vectorization. */
    embeddingModel: EmbeddingModel | undefined;
    /** Predefined fallback messages for different channels. */
    fallbackMessages: FallbackMessage[];
    /** Default threshold for search queries. */
    defaultThreshold: number;
    /** ID of the associated team. */
    teamId: string;
    /** Enables debug mode for the project. */
    debugMode: boolean;
    /** Exclude output from search queries. */
    excludeOutputFromSearch: boolean;
    /** Metadata about creation and changes. */
    history: History | undefined;
    /** Configuration-specific identifier. */
    configSlug: string;
    /** URL-friendly identifier of the project. */
    slug: string;
}
/** Represents a fallback message used when no direct answer or match is found. */
export interface FallbackMessage {
    /** The fallback message text. */
    message: string;
    /** The channel for which this message is intended (e.g., CHAT, EMAIL, VOICE). */
    channel: FallbackMessage_Channel;
    /** Map for structured fallback messages. */
    messageMap: {
        [key: string]: string;
    };
}
export declare enum FallbackMessage_Channel {
    CHAT = 0,
    EMAIL = 1,
    VOICE = 2,
    UNRECOGNIZED = -1
}
export declare function fallbackMessage_ChannelFromJSON(object: any): FallbackMessage_Channel;
export declare function fallbackMessage_ChannelToJSON(object: FallbackMessage_Channel): string;
export interface FallbackMessage_MessageMapEntry {
    key: string;
    value: string;
}
/** Stores metadata about the history of a project. */
export interface History {
    /** IDs of the creator and last editor. */
    creatorId: string;
    /** ID of the last person who changed the project. */
    changedBy: string;
    /** Creation date of the project. */
    creationDate: string;
    /** Date of the last edit to the project. */
    lastEditDate: string;
}
/** Response message for project creation. */
export interface AddProjectResponse {
    /** ID of the newly created project. */
    projectId: string;
}
/** Request to remove a project. */
export interface RemoveProjectRequest {
    /** ID of the project to remove. */
    projectId: string;
}
/** Response message for project removal. */
export interface RemoveProjectResponse {
}
/** Request to retrieve all available embedding models. */
export interface GetEmbeddingModelsRequest {
}
/** Represents a model for vectorizing content. */
export interface EmbeddingModel {
    /** Name of the embedding model. */
    name: string;
    /** Number of dimensions of the embedding. */
    dimensions: number;
    /** Base library used for the embedding model. */
    baseLibrary: string;
    /** List of supported locales for the embedding model. */
    locale: string[];
}
/** Request to update an existing project or create a new one if no project_id is provided. */
export interface UpdateProjectRequest {
    /** ID of the project to update. If missing, a new project is created. */
    projectId: string;
    /** Name of the project. */
    name: string;
    /** Description of the project. */
    description: string;
    /** Model used for vectorization. */
    embeddingModel: EmbeddingModel | undefined;
    /** Predefined fallback messages for different channels. */
    fallbackMessages: FallbackMessage[];
    /** Default threshold for search queries. */
    defaultThreshold: number;
    /** Enables debug mode for the project. */
    debugMode: boolean;
    /** Exclude output from search queries. */
    excludeOutputFromSearch: boolean;
    /** Metadata about creation and changes. */
    history: History | undefined;
    /** Configuration-specific identifier. */
    configSlug: string;
    /** URL-friendly identifier of the project. */
    slug: string;
}
/** Response message for project update or creation. */
export interface UpdateProjectResponse {
}
export declare const GetProjectsRequest: MessageFns<GetProjectsRequest>;
export declare const Project: MessageFns<Project>;
export declare const AddProjectRequest: MessageFns<AddProjectRequest>;
export declare const FallbackMessage: MessageFns<FallbackMessage>;
export declare const FallbackMessage_MessageMapEntry: MessageFns<FallbackMessage_MessageMapEntry>;
export declare const History: MessageFns<History>;
export declare const AddProjectResponse: MessageFns<AddProjectResponse>;
export declare const RemoveProjectRequest: MessageFns<RemoveProjectRequest>;
export declare const RemoveProjectResponse: MessageFns<RemoveProjectResponse>;
export declare const GetEmbeddingModelsRequest: MessageFns<GetEmbeddingModelsRequest>;
export declare const EmbeddingModel: MessageFns<EmbeddingModel>;
export declare const UpdateProjectRequest: MessageFns<UpdateProjectRequest>;
export declare const UpdateProjectResponse: MessageFns<UpdateProjectResponse>;
type Builtin = Date | Function | Uint8Array | string | number | boolean | undefined;
export type DeepPartial<T> = T extends Builtin ? T : T extends globalThis.Array<infer U> ? globalThis.Array<DeepPartial<U>> : T extends ReadonlyArray<infer U> ? ReadonlyArray<DeepPartial<U>> : T extends {} ? {
    [K in keyof T]?: DeepPartial<T[K]>;
} : Partial<T>;
type KeysOfUnion<T> = T extends T ? keyof T : never;
export type Exact<P, I extends P> = P extends Builtin ? P : P & {
    [K in keyof P]: Exact<P[K], I[K]>;
} & {
    [K in Exclude<keyof I, KeysOfUnion<P>>]: never;
};
export interface MessageFns<T> {
    encode(message: T, writer?: BinaryWriter): BinaryWriter;
    decode(input: BinaryReader | Uint8Array, length?: number): T;
    fromJSON(object: any): T;
    toJSON(message: T): unknown;
    create<I extends Exact<DeepPartial<T>, I>>(base?: I): T;
    fromPartial<I extends Exact<DeepPartial<T>, I>>(object: I): T;
}
export {};