Optimizing the AI command with parameter domain setting to tidbcloud (

#125) ## What is the purpose of the change Setting the AI bot's domain restriction to `tidbcloud` for more precise responses. ## Brief change log - update swagger json. - set param domain to `tidbcloud`
tidbcloud · Dec 14, 2023 · 3b69b14 · 3b69b14
1 parent 8b0826a
commit 3b69b14
Show file tree

Hide file tree

Showing 5 changed files with 82 additions and 6 deletions.
diff --git a/internal/cli/ai/ai.go b/internal/cli/ai/ai.go
@@ -37,7 +37,8 @@ const (
 )
 
 var (
-	re = regexp.MustCompile(regexPattern)
+	re     = regexp.MustCompile(regexPattern)
+	domain = []string{"tidbcloud"}
 )
 
 type AIOpts struct {
@@ -112,6 +113,7 @@ func AICmd(h *internal.Helper) *cobra.Command {
 					}
 					chat, err := client.Chat(param.WithChatInfo(&models.PingchatChatInfo{
 						Messages: msgs,
+						Domain:   domain,
 					}))
 
 					if err != nil {
@@ -165,6 +167,7 @@ func AICmd(h *internal.Helper) *cobra.Command {
 							Role:    &role,
 						},
 					},
+					Domain: domain,
 				}))
 
 				if err != nil {

diff --git a/pkg/tidbcloud/pingchat/client/operations/operations_client.go b/pkg/tidbcloud/pingchat/client/operations/operations_client.go
diff --git a/pkg/tidbcloud/pingchat/models/pingchat_chat_info.go b/pkg/tidbcloud/pingchat/models/pingchat_chat_info.go
diff --git a/pkg/tidbcloud/pingchat/models/pingchat_chat_message.go b/pkg/tidbcloud/pingchat/models/pingchat_chat_message.go
diff --git a/pkg/tidbcloud/pingchat/pingchat_swagger.json b/pkg/tidbcloud/pingchat/pingchat_swagger.json
@@ -13,6 +13,7 @@
     "paths": {
         "/ecosystem/api/internal/pingchat/chat": {
             "post": {
+                "description": "Chat with PingChat",
                 "produces": [
                     "application/json"
                 ],
@@ -37,15 +38,21 @@
                     },
                     "400": {
                         "description": "error",
-                        "schema": {}
+                        "schema": {
+                            "type": "object"
+                        }
                     },
                     "500": {
                         "description": "error",
-                        "schema": {}
+                        "schema": {
+                            "type": "object"
+                        }
                     },
                     "default": {
                         "description": "other error",
-                        "schema": {}
+                        "schema": {
+                            "type": "object"
+                        }
                     }
                 }
             }
@@ -54,8 +61,27 @@
     "definitions": {
         "pingchat.ChatInfo": {
             "type": "object",
+            "required": [
+                "messages"
+            ],
             "properties": {
+                "domain": {
+                    "type": "array",
+                    "items": {
+                        "type": "string",
+                        "enum": [
+                            "tidb",
+                            "tidbcloud",
+                            "asktug",
+                            "blog",
+                            "community",
+                            "knowledge-base-cn",
+                            "kb"
+                        ]
+                    }
+                },
                 "messages": {
+                    "description": "https://pkg.go.dev/gopkg.in/bluesuncorp/validator.v9#hdr-Dive",
                     "type": "array",
                     "items": {
                         "$ref": "#/definitions/pingchat.ChatMessage"
@@ -71,9 +97,11 @@
             ],
             "properties": {
                 "content": {
+                    "description": "Dialogue content",
                     "type": "string"
                 },
                 "role": {
+                    "description": "User's input as \"user\", AI assistant's reply as \"assistant\", see https://github.com/gin-gonic/gin/issues/3234.",
                     "type": "string",
                     "enum": [
                         "user",
@@ -89,6 +117,7 @@
                     "type": "string"
                 },
                 "links": {
+                    "description": "Reference Document Links",
                     "type": "array",
                     "items": {
                         "$ref": "#/definitions/pingchat.Link"