New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

feat: AiAssistantModel #9494

Open

miya wants to merge 12 commits into feat/growi-ai-next from feat/159152-ai-assistant-model

+138 −0

Member

miya commented Dec 17, 2024

Task

#159151 [GROWI AI Next][特化型アシスタント] 新規作成モーダルから作成ボタンをクリックした時アシスタントデータが作成される
- #159152 Assistant model の実装


          impl AiAssistantModel

821203c

miya requested a review from yuki-takei

December 17, 2024 08:38

miya self-assigned this

changeset-bot bot commented Dec 17, 2024 •

edited

Loading

⚠️ No Changeset found

Latest commit: c5c8529

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

miya added 10 commits

December 17, 2024 08:45


          clean code

26713ca


          rm unnec opt

9930e20


          Add types (to be implemented in the future)

a8b3143


          type -> types

caf1db1


          clean code

b52554d


          Add field (isDeleted)

6a505a4


          add grantedGroups

b143f57


          add creator


          fix types

3fc841c


          optional

df996cb

miya commented

View reviewed changes

apps/app/src/features/openai/server/models/ai-assistant.ts

+                    type: String,
+                    enum: Object.values(AiAssistantSharingScope),
+                    required: true,
+                  },

Member Author

miya Dec 17, 2024

共有範囲

apps/app/src/features/openai/server/models/ai-assistant.ts

+                    type: String,
+                    enum: Object.values(AiAssistantLearningScope),
+                    required: true,
+                  },

Member Author

miya Dec 17, 2024

学習範囲
- VectorStore に保存する権限の範囲を指定
- アシスタント作成者が閲覧可能な範囲が指定できる

Member

yuki-takei Dec 17, 2024

名前変えたほうがいいかも。e-learning のためのフィールドと勘違いする。
かといって「実行ユーザー」というのが適当とも思わないんだけどね

あとこれは enum だけではなく UserGroup への参照が必要なのではないか？

apps/app/src/features/openai/server/models/ai-assistant.ts

+                        required: true,
+                        index: true,
+                      },
+                    }],

Member Author

miya Dec 17, 2024

Page mode を踏襲

growi/apps/app/src/server/models/page.ts

Lines 137 to 158 in df996cb

    
             type: [{ 
        
               type: { 
        
                 type: String, 
        
                 enum: Object.values(GroupType), 
        
                 required: true, 
        
                 default: 'UserGroup', 
        
               }, 
        
               item: { 
        
                 type: Schema.Types.ObjectId, 
        
                 refPath: 'grantedGroups.type', 
        
                 required: true, 
        
                 index: true, 
        
               }, 
        
             }], 
        
             validate: [function(arr) { 
        
               if (arr == null) return true; 
        
               const uniqueItemValues = new Set(arr.map(e => e.item)); 
        
               return arr.length === uniqueItemValues.size; 
        
             }, 'grantedGroups contains non unique item'], 
        
             default: [], 
        
             required: true, 
        
           },

apps/app/src/features/openai/server/models/ai-assistant.ts

+                    default: false,
+                    required: true,
+                  },
+                },

Member Author

miya Dec 17, 2024

VectorStore model を踏襲

growi/apps/app/src/features/openai/server/models/vector-store.ts

Lines 35 to 39 in df996cb

    
           isDeleted: { 
        
             type: Boolean, 
        
             default: false, 
        
             required: true, 
        
           },

apps/app/src/features/openai/server/models/ai-assistant.ts

+                  vectorStoreId: {
+                    type: String,
+                    required: true,
+                  },

Member Author

miya Dec 17, 2024

VectorStore model を踏襲

growi/apps/app/src/features/openai/server/models/vector-store.ts

Lines 25 to 29 in df996cb

    
           vectorStoreId: { 
        
             type: String, 
        
             required: true, 
        
             unique: true, 
        
           },

apps/app/src/features/openai/server/models/ai-assistant.ts

+              schema.methods.markAsDeleted = async function(): Promise<void> {
+                this.isDeleted = true;
+                await this.save();
+              };

Member Author

miya Dec 17, 2024

VectorStore model 踏襲

growi/apps/app/src/features/openai/server/models/vector-store.ts

Lines 42 to 45 in df996cb

    
           schema.methods.markAsDeleted = async function(): Promise<void> { 
        
             this.isDeleted = true; 
        
             await this.save(); 
        
           };

yuki-takei requested changes

View reviewed changes

apps/app/src/features/openai/server/models/ai-assistant.ts Outdated

+              interface AiAssistant {
+                name: string;
+                description?: string
+                instruction?: string

Member

yuki-takei Dec 17, 2024

特化型アシスタントになったことで、実際使う時の instruction はシステム側で入れると思うんだよね
ナレッジアシスタントとかエディタアシスタントのそれぞれの役割になるように

ユーザーが指定できるのはサブの instruction になるので、additionalInstruction にしておいた方がいいかも

あと description も instruction も not optional でいいと思う。初期値は空文字列にすればいいので。

apps/app/src/features/openai/server/models/ai-assistant.ts Outdated

+                instruction?: string
+                vectorStoreId: string // VectorStoreId of OpenAI Specify (https://platform.openai.com/docs/api-reference/vector-stores/object)
+                types: AiAssistantType[]
+                creator: Ref<IUser>

Member

yuki-takei Dec 17, 2024

owner にしよう

Member Author

miya Dec 18, 2024

修正済み

apps/app/src/features/openai/server/models/ai-assistant.ts

+                types: AiAssistantType[]
+                creator: Ref<IUser>
+                grantedGroups?: IGrantedGroup[];
+                pages: Ref<IPage>[]

Member

yuki-takei Dec 17, 2024

pages って何用途だろ？
個別にページへの参照を追加できるというのも thread 作ったときに便利そうではあるが、vector store 利用との一貫性はないので今使い分けをするのかきちんと設計しておきたい

apps/app/src/features/openai/server/models/ai-assistant.ts

+                    type: String,
+                    enum: Object.values(AiAssistantLearningScope),
+                    required: true,
+                  },

Member

yuki-takei Dec 17, 2024

名前変えたほうがいいかも。e-learning のためのフィールドと勘違いする。
かといって「実行ユーザー」というのが適当とも思わないんだけどね

あとこれは enum だけではなく UserGroup への参照が必要なのではないか？


          change field name

c5c8529

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet