Update Document

PATCH

/document/:domain/:document_id

PATCH

/document/:domain/:document_id

$ curl -X PATCH https://fai.buildwithfern.com/document/domain/document_id \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{}'

1 {
2   "document": {
3     "document_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
4     "domain": "example.com",
5     "chunk": "This is a sample chunk of text extracted from the document for indexing purposes.",
6     "document": "This document provides detailed information about the API usage and integration guidelines.",
7     "created_at": "2024-01-15T09:30:00Z",
8     "updated_at": "2024-01-15T09:30:00Z",
9     "title": "API Integration Guide",
10     "url": "https://example.com/api-integration-guide",
11     "version": "v2.3.1",
12     "product": "ExampleAPI",
13     "keywords": [
14       "API",
15       "integration",
16       "guide",
17       "documentation"
18     ],
19     "authed": true
20   }
21 }

curl -X PATCH https://fai.buildwithfern.com/document/domain/document_id \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{}'

{
  "document": {
    "document_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
    "domain": "example.com",
    "chunk": "This is a sample chunk of text extracted from the document for indexing purposes.",
    "document": "This document provides detailed information about the API usage and integration guidelines.",
    "created_at": "2024-01-15T09:30:00Z",
    "updated_at": "2024-01-15T09:30:00Z",
    "title": "API Integration Guide",
    "url": "https://example.com/api-integration-guide",
    "version": "v2.3.1",
    "product": "ExampleAPI",
    "keywords": [
      "API",
      "integration",
      "guide",
      "documentation"
    ],
    "authed": true
  }
}

身份验证

AuthorizationBearer

Bearer 身份验证，格式为 Bearer <token>，其中 token 是您的身份验证令牌。

路径参数

domainstring必需

document_idstring必需

请求

This endpoint expects an object.

documentstring or null可选

The updated content of the document that will be returned to Ask Fern during document retrieval. If not provided, this field will remain unchanged.

chunkstring or null可选

The updated textual content that should be vectorized when indexing the document. If not provided, this field will remain unchanged.

titlestring or null可选

The updated title of the document. If not provided, this field will remain unchanged.

urlstring or null可选

The updated url of the document. If not provided, this field will remain unchanged.

versionstring or null可选

The updated version of the document. If not provided, this field will remain unchanged.

productstring or null可选

The updated product of the document. If not provided, this field will remain unchanged.

keywordslist of strings or null可选

The updated keywords of the document. If not provided, this field will remain unchanged.

authedboolean or null可选

The updated authed status of the document. If not provided, this field will remain unchanged.

响应

Successful Response

documentobject

The updated document

错误

422

Unprocessable Entity Error

$	curl -X PATCH https://fai.buildwithfern.com/document/domain/document_id \
>	-H "Authorization: Bearer <token>" \
>	-H "Content-Type: application/json" \
>	-d '{}'

1	{
2	"document": {
3	"document_id": "a1b2c3d4-e5f6-7890-ab12-cd34ef567890",
4	"domain": "example.com",
5	"chunk": "This is a sample chunk of text extracted from the document for indexing purposes.",
6	"document": "This document provides detailed information about the API usage and integration guidelines.",
7	"created_at": "2024-01-15T09:30:00Z",
8	"updated_at": "2024-01-15T09:30:00Z",
9	"title": "API Integration Guide",
10	"url": "https://example.com/api-integration-guide",
11	"version": "v2.3.1",
12	"product": "ExampleAPI",
13	"keywords": [
14	"API",
15	"integration",
16	"guide",
17	"documentation"
18	],
19	"authed": true
20	}
21	}