Browse Source

feat: /conversations api response add 'update_at' field,and update api docs add sort_by parameter (#10043)

郭伟伟 5 months ago
parent
commit
190b6a2aa6

+ 3 - 0
api/fields/conversation_fields.py

@@ -121,6 +121,7 @@ conversation_fields = {
     "from_account_name": fields.String,
     "read_at": TimestampField,
     "created_at": TimestampField,
+    "updated_at": TimestampField,
     "annotation": fields.Nested(annotation_fields, allow_null=True),
     "model_config": fields.Nested(simple_model_config_fields),
     "user_feedback_stats": fields.Nested(feedback_stat_fields),
@@ -182,6 +183,7 @@ conversation_detail_fields = {
     "from_end_user_id": fields.String,
     "from_account_id": fields.String,
     "created_at": TimestampField,
+    "updated_at": TimestampField,
     "annotated": fields.Boolean,
     "introduction": fields.String,
     "model_config": fields.Nested(model_config_fields),
@@ -197,6 +199,7 @@ simple_conversation_fields = {
     "status": fields.String,
     "introduction": fields.String,
     "created_at": TimestampField,
+    "updated_at": TimestampField,
 }
 
 conversation_infinite_scroll_pagination_fields = {

+ 5 - 0
web/app/components/develop/template/template_advanced_chat.en.mdx

@@ -656,6 +656,11 @@ Chat applications support session persistence, allowing previous chat history to
       <Property name='pinned' type='bool' key='pinned'>
         Return only pinned conversations as `true`, only non-pinned as `false`
       </Property>
+      <Property name='sort_by' type='string' key='sort_by'>
+        Sorting Field (Optional), Default: -updated_at (sorted in descending order by update time)
+        - Available Values: created_at, -created_at, updated_at, -updated_at
+        - The symbol before the field represents the order or reverse, "-" represents reverse order.
+      </Property>
     </Properties>
 
     ### Response

+ 5 - 0
web/app/components/develop/template/template_advanced_chat.zh.mdx

@@ -691,6 +691,11 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
       <Property name='pinned' type='bool' key='pinned'>
         只返回置顶 true,只返回非置顶 false
       </Property>
+      <Property name='sort_by' type='string' key='sort_by'>
+        排序字段(选题),默认 -updated_at(按更新时间倒序排列)
+        - 可选值:created_at, -created_at, updated_at, -updated_at
+        - 字段前面的符号代表顺序或倒序,-代表倒序
+      </Property>
     </Properties>
 
     ### Response

+ 5 - 0
web/app/components/develop/template/template_chat.en.mdx

@@ -690,6 +690,11 @@ Chat applications support session persistence, allowing previous chat history to
       <Property name='pinned' type='bool' key='pinned'>
         Return only pinned conversations as `true`, only non-pinned as `false`
       </Property>
+      <Property name='sort_by' type='string' key='sort_by'>
+        Sorting Field (Optional), Default: -updated_at (sorted in descending order by update time)
+        - Available Values: created_at, -created_at, updated_at, -updated_at
+        - The symbol before the field represents the order or reverse, "-" represents reverse order.
+      </Property>
     </Properties>
 
     ### Response

+ 5 - 0
web/app/components/develop/template/template_chat.zh.mdx

@@ -705,6 +705,11 @@ import { Row, Col, Properties, Property, Heading, SubProperty } from '../md.tsx'
       <Property name='pinned' type='bool' key='pinned'>
         只返回置顶 true,只返回非置顶 false
       </Property>
+      <Property name='sort_by' type='string' key='sort_by'>
+        排序字段(选题),默认 -updated_at(按更新时间倒序排列)
+        - 可选值:created_at, -created_at, updated_at, -updated_at
+        - 字段前面的符号代表顺序或倒序,-代表倒序
+      </Property>
     </Properties>
 
     ### Response