dify-knowledge-base-search

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Dify Knowledge Base Search

Dify知识库搜索

Prepare required inputs

准备所需输入

Provide
```
data
```
as JSON containing
```
query
```
and optional
```
retrieval_model.top_k
```
.

Read these env vars:

DIFY_API_BASE_URL

: base API URL and include

/v1

(example:

https://api.dify.ai/v1

```
DIFY_DATASET_ID
```
: target dataset ID.

DIFY_API_KEY

: send as

Authorization: Bearer <DIFY_API_KEY>

提供包含
```
query
```
和可选
```
retrieval_model.top_k
```
的JSON格式
```
data
```
。
读取以下环境变量：
- ```
DIFY_API_BASE_URL
```
  ：基础API URL，需包含
```
/v1
```
  （示例：
```
https://api.dify.ai/v1
```
  ）。
- ```
DIFY_DATASET_ID
```
  ：目标数据集ID。
- ```
DIFY_API_KEY
```
  ：以
```
Authorization: Bearer <DIFY_API_KEY>
```
  的形式发送。

Send request

发送请求

Endpoint:

${DIFY_API_BASE_URL}/datasets/${DIFY_DATASET_ID}/retrieve

Headers:

```
Content-Type: application/json
```
```
Authorization: Bearer <DIFY_API_KEY>
```

Use
```
assets/example-request.json
```
as the payload template.

bash

curl -sS --location --request POST "$DIFY_API_BASE_URL/datasets/$DIFY_DATASET_ID/retrieve" \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer $DIFY_API_KEY" \
  --data @assets/example-request.json

端点：

${DIFY_API_BASE_URL}/datasets/${DIFY_DATASET_ID}/retrieve

请求头：

```
Content-Type: application/json
```
```
Authorization: Bearer <DIFY_API_KEY>
```

使用
```
assets/example-request.json
```
作为请求体模板。

bash

curl -sS --location --request POST "$DIFY_API_BASE_URL/datasets/$DIFY_DATASET_ID/retrieve" \
  --header 'Content-Type: application/json' \
  --header "Authorization: Bearer $DIFY_API_KEY" \
  --data @assets/example-request.json

Interpret response

解析响应

Request shape:

{ "query": string, "retrieval_model"?: { "top_k": number } }

Success shape: 200 with
```
{ query, records: [...] }
```
If
```
records
```
is empty, increase
```
retrieval_model.top_k
```
moderately and retry.

请求格式：

{ "query": string, "retrieval_model"?: { "top_k": number } }

成功响应格式：状态码200，返回
```
{ query, records: [...] }
```
若
```
records
```
为空，适度增大
```
retrieval_model.top_k
```
后重试。

Troubleshoot quickly

快速故障排除

If auth fails, verify
```
DIFY_API_KEY
```
and
```
Authorization
```
header format.
If route fails, verify
```
DIFY_API_BASE_URL
```
includes
```
/v1
```
.
If results are low quality, refine
```
query
```
and tune
```
top_k
```
.

若认证失败，验证
```
DIFY_API_KEY
```
和
```
Authorization
```
请求头格式。
若路由失败，验证
```
DIFY_API_BASE_URL
```
是否包含
```
/v1
```
。
若结果质量不佳，优化
```
query
```
并调整
```
top_k
```
值。

References

参考资料

```
references/env.md
```
```
references/request-response.md
```
```
references/testing.md
```

```
references/env.md
```
```
references/request-response.md
```
```
references/testing.md
```

Assets

资源文件

```
assets/example-request.json
```

```
assets/example-request.json
```