智能体开发平台
产品使用手册
产品使用手册
    • API文档描述
    • 根据文本/图片生成id获取文本/图片应用信息
      GET
    • 文本/图片生成接口
      POST
    • 流对话接口
      POST
    • 根据对话助手版本id获取对话助手
      GET
    • 对话助手流接口
      POST
    • 获取对话消息列表
      GET
    • 关闭对话
      GET
    • 用户模型服务列表
      GET
    • 获取文本生成历史记录
      GET
    • 获取对话助手记录列表
      GET
    • 声音转文字接口
      POST

      流对话接口

      开发中
      POST
      /copywriting/dialogue/sse/send-message
      对话接口,首次返回的是产生的对话对象内容,以后都是返回消息内容信息 result, isEnd,userDialogueId这三个变量属于消息内容变量

      请求参数

      Header 参数
      Accept
      string 
      可选
      示例值:
      text/event-stream
      x-api-key
      string 
      apikey
      可选
      默认值:
      Bearer {{apiKey}}
      tenant-id
      string 
      可选
      默认值:
      {{tenantId}}
      Body 参数application/json
      speechUserDialogueMessage
      object 
      必需
      content
      string 
      必需
      dialogueType
      string 
      对话类型
      可选
      如果使用知识库改值为KB
      searchKnowledgeRequest
      object 
      搜索知识库参数对象
      可选
      parentId
      string 
      父级消息id
      必需
      如果是大于一轮对话要填上次的消息id
      tools
      array[string]
      插件工具id列表
      可选
      workflows
      array[string]
      工作流id列表
      可选
      modelServiceId
      string 
      模型服务id
      可选
      name
      string 
      对话名称
      可选
      id
      string 
      对话id
      必需
      示例
      {"speechUserDialogueMessage":{"content":"1+1等于几","kbIdArray":[]},"isKb":false,"tools":[],"workflows":[],"modelServiceId":"1783672782255861761","name":"1+1等于几"}

      示例代码

      Shell
      JavaScript
      Java
      Swift
      Go
      PHP
      Python
      HTTP
      C
      C#
      Objective-C
      Ruby
      OCaml
      Dart
      R
      请求示例请求示例
      Shell
      JavaScript
      Java
      Swift
      curl --location --request POST 'https://cloud.xinyoutai.net//api/copywriting/dialogue/sse/send-message' \
      --header 'Accept: text/event-stream' \
      --header 'x-api-key: Bearer {{apiKey}}' \
      --header 'tenant-id: {{tenantId}}' \
      --header 'Content-Type: application/json' \
      --data-raw '{"speechUserDialogueMessage":{"content":"1+1等于几","kbIdArray":[]},"isKb":false,"tools":[],"workflows":[],"modelServiceId":"1783672782255861761","name":"1+1等于几"}'

      返回响应

      🟢200成功
      application/json
      Body
      createBy
      string 
      必需
      createTime
      string 
      必需
      updateBy
      string 
      必需
      updateTime
      string 
      必需
      params
      object 
      必需
      tenantId
      string 
      必需
      id
      string 
      对话id
      必需
      name
      string 
      对话名称
      必需
      userId
      string 
      对话用户id
      必需
      modelServiceId
      integer 
      模型服务id
      必需
      youtaizhis
      integer 
      消耗优态值
      必需
      tools
      array[string]
      工具列表
      必需
      workflows
      array[string]
      工作流列表
      必需
      speechUserDialogueMessage
      object 
      必需
      createBy
      string 
      必需
      createTime
      string 
      必需
      params
      object 
      必需
      id
      string 
      发送消息的id
      必需
      content
      string 
      内容
      必需
      role
      string 
      角色
      必需
      userDialogueId
      string 
      对话id
      必需
      youtaizhis
      integer 
      优态值
      必需
      userId
      string 
      用户id
      必需
      result
      string 
      消息内容
      可选
      isEnd
      boolean 
      是否是最后一条消息
      可选
      true是,false否
      userDialogueId
      string 
      对话id
      可选
      示例
      data:{"createBy":"sunche","createTime":"2024-07-10 17:08:55","updateBy":"sunche","updateTime":"2024-07-10 17:08:55","params":{},"tenantId":"1772455731533221889","id":"1810964405916037122","name":"1+1等于几","userId":"1636623530508611586","modelServiceId":1783672782255861761,"totalTokens":0,"youtaizhis":0,"tools":[],"workflows":[],"isUser":false,"realEventSource":{},"speechUserDialogueMessage":{"createBy":"sunche","createTime":"2024-07-10 17:08:55","params":{},"id":"1810964405957980161","content":"1+1等于几","role":"user","userDialogueId":"1810964405916037122","completionTokens":0,"promptTokens":0,"totalTokens":0,"youtaizhis":0,"userId":"1636623530508611586"},"closeSse":false}
      
      data:{"result":"1","isEnd":false,"userDialogueId":"1810964405916037122"}
      
      data:{"result":"+","isEnd":false,"userDialogueId":"1810964405916037122"}
      
      data:{"result":"1","isEnd":false,"userDialogueId":"1810964405916037122"}
      
      data:{"result":"等于2。这是最基本的","isEnd":false,"userDialogueId":"1810964405916037122"}
      
      data:{"result":"数学加法。","isEnd":false,"userDialogueId":"1810964405916037122"}
      
      data:{"result":"","isEnd":true,"userDialogueId":"1810964405916037122"}
      
      
      修改于 2024-07-10 09:27:25
      上一页
      文本/图片生成接口
      下一页
      根据对话助手版本id获取对话助手
      Built with