weseek__growi/apps/app/src/features/openai/interfaces/ai-assistant.ts

import type { HasObjectId, IGrantedGroup, IUserHasId, Ref } from '@growi/core';

import type { IVectorStore } from './vector-store';

/*
 *  Objects
 */
export const AiAssistantShareScope = {
  SAME_AS_ACCESS_SCOPE: 'sameAsAccessScope',
  PUBLIC_ONLY: 'publicOnly', // TODO: Rename to "PUBLIC"
  OWNER: 'owner',
  GROUPS: 'groups',
} as const;

export const AiAssistantAccessScope = {
  PUBLIC_ONLY: 'publicOnly',
  OWNER: 'owner',
  GROUPS: 'groups',
} as const;

/*
 *  Interfaces
 */
export type AiAssistantShareScope =
  (typeof AiAssistantShareScope)[keyof typeof AiAssistantShareScope];
export type AiAssistantAccessScope =
  (typeof AiAssistantAccessScope)[keyof typeof AiAssistantAccessScope];

export interface AiAssistant {
  name: string;
  description: string;
  additionalInstruction: string;
  pagePathPatterns: string[];
  vectorStore: Ref<IVectorStore>;
  owner: Ref<IUserHasId>;
  grantedGroupsForShareScope?: IGrantedGroup[];
  grantedGroupsForAccessScope?: IGrantedGroup[];
  shareScope: AiAssistantShareScope;
  accessScope: AiAssistantAccessScope;
  isDefault: boolean;
}

export type AiAssistantHasId = AiAssistant & HasObjectId;

export type UpsertAiAssistantData = Omit<
  AiAssistant,
  'owner' | 'vectorStore' | 'isDefault'
>;

export type AccessibleAiAssistants = {
  myAiAssistants: AiAssistant[];
  teamAiAssistants: AiAssistant[];
};

export type AccessibleAiAssistantsHasId = {
  myAiAssistants: AiAssistantHasId[];
  teamAiAssistants: AiAssistantHasId[];
};