GET
/
api
/
workflows
/
{workflowName}
/
knowledge-documents
/
search
查找项目知识库文档
curl --request GET \
  --url https://wfapi.yuhe.space/api/workflows/{workflowName}/knowledge-documents/search \
  --header 'Authorization: Bearer <token>'
{
  "errCode": 123,
  "errMessage": "<string>",
  "data": {
    "query": "<string>",
    "documentsSearched": 123,
    "totalMatches": 123,
    "matchesTruncated": true,
    "maxMatches": 123,
    "pageSize": 123,
    "hasMore": true,
    "matches": [
      {
        "documentId": "<string>",
        "title": "<string>",
        "lineNumber": 123,
        "line": "<string>",
        "before": [
          {
            "lineNumber": 123,
            "content": "<string>"
          }
        ],
        "after": [
          {
            "lineNumber": 123,
            "content": "<string>"
          }
        ]
      }
    ],
    "cursor": "<string>",
    "nextCursor": "<string>"
  }
}

Authorizations

Authorization
string
header
required

使用 WORKFLOW_SERVER_ADMIN_KEY 或已创建的账号 API Key。

Path Parameters

workflowName
string
required

Query Parameters

q
string
required

非空搜索关键词,按 markdown 行大小写不敏感匹配。

documentId
string

传入后只查找单篇文档;省略时查找全部文档。

beforeLines
integer
default:0

每条匹配向上返回多少行上下文,范围 0 到 50。

Required range: 0 <= x <= 50
afterLines
integer
default:0

每条匹配向下返回多少行上下文,范围 0 到 50。

Required range: 0 <= x <= 50
maxMatches
integer
default:200

兼容旧客户端的本页大小参数;未传 pageSize 时生效,默认 200,最大 1000。

Required range: 1 <= x <= 1000
pageSize
integer
default:200

本页最多返回多少条匹配;默认 200,最大 1000。

Required range: 1 <= x <= 1000
cursor
string

上一页返回的 nextCursor;省略时读取第一页。

Response

按行匹配结果,包含行号和上下文。

errCode
integer
required
errMessage
string
required
Allowed value: ""
data
object
required