关于本页

本页介绍更夫所基于的开源内核 Keep 的通用能力。更夫在其上提供国内化增强：钉钉/企业微信/飞书通知、国产大模型接入、LDAP 认证与值班管理。部署与上手请看快速上手。

In workflows

This provider can be used in workflows.

As "step" to query data, example:

steps:
    - name: Query websocket
      provider: websocket
      config: "{{ provider.my_provider_name }}"
      with:
        socket_url: {value}  # The websocket URL to query.
        timeout: {value}  # Connection Timeout. Defaults to None.
        data: {value}  # Data to send through the websocket. Defaults to None.

If you need workflow examples with this provider, please raise a GitHub issue.

输出

WebsocketProvider 的 query 函数输出以下格式：

{
  "connection": true,
  "data": "Received data from the websocket"
}

connection 字段指示 websocket 连接是否成功（true）或不成功（false）。data 字段包含从 websocket 接收到的数据。 如果 connection 字段指示连接不成功（false），则对象还将包含一个 error 字段，其中包含有关失败连接的详细信息。

认证参数

Websocket provider 不需要任何特定的认证参数。

连接 Provider

要连接 Websocket provider 并执行查询，请按照以下步骤操作：

在您的系统中初始化 provider 和 provider 配置。 使用 WebsocketProvider 的 query 函数与 websocket 进行交互。

有关更多信息，请参阅 文档。