跳到主要内容

向Copilot提问(或其它请求)

POST 
/wiki/ask

History​

VersionChanges
v6.35.0Added in: v6.35.0

Request​

Query Parameters

    teamID stringrequired

    团队ID

    requestUserID string

    用户 ID，此参数仅在作为 Oauth 机器人调用时才能传递。它用于以指定用户的身份执行操作

Body

required

向 Copilot 提出的问题及其它参数

    oneOf

    开始一个新的 Copilot 提问请求。

    scopeType string

    Possible values: [global, space, page, attachment]

    scopeType的类型，表示提问的范围。可以是全局(global)、空间(space)、页面(page)或附件(attachment)。默认为global。

    scopeID string

    设定提问的范围ID，表示提问的具体范围。可以是空间ID、页面ID或附件ID。当scopeType为global时，此字段为空。

    query string

    向 Copilot 提问或请求的内容。

    language string

    响应的输出语言，默认为当前用户的语言。取值为语言的英文全称，比如"Chinese", "English", "Japanese"等。

    generateRelatedQuestions boolean

    是否生成相关问题。默认为true，表示Copilot会尝试生成与提问相关的问题。

    config

    object

    配置参数，用于定制Copilot的行为。

    expandQuery boolean

    是否扩展查询内容。如果为true，表示Copilot会尝试扩展查询内容以获取更全面的答案。 扩展查询会让结果更全面，但可能会增加响应时间。如果模型不支持结构化数据生成，则Copilot会忽略此配置。对于思考模型，此配置的默认值为false，对于普通的生成模型，此配置的默认值为true。

    enableCache boolean

    是否启用缓存。默认为true，表示Copilot会尝试使用缓存的结果来加快响应速度。有任何问题或参考内容的更新，无论这里是否启用缓存，Copilot都会重新生成。

Responses​

数据将以SSE格式返回

如果发生任何错误，响应将包含以下错误代码：

代码错误
409超出 Copilot 访问量限制。私有部署没有此限制
510一般错误
511没有Copilot授权
512Copilot未安装
513调用参数不合法，具体参考错误信息
601当调用外部AI服务时认证错误
602当调用外部AI服务时超出配额错误
604无法连接到外部AI服务
605调用外部AI服务时权限被拒绝

Schema

    oneOf

    step类型的响应，表示Copilot当前的处理步骤。

    type string

    Possible values: [step]

    step string

    Possible values: [embedding, searching, reranking, thinking, generating]

    当前Copilot处理的步骤，可能的值包括embedding（嵌入）、searching（搜索）、reranking（重排序）、thinking（思考）和generating（生成）。其中reranking只有当Copilot配置了重排序模型时才会返回。thinking只有当Copilot配置了思考模型时才会返回。

Loading...