Skip to content

Commit 77c4a00

Browse files
committed
docs: fix the name
1 parent f2fa5ac commit 77c4a00

10 files changed

+42
-44
lines changed

docs/api/create-crawl-openai.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
# createXCrawlOpenAI
1+
# createCrawlOpenAI
22

3-
Create an AI application instance by calling createXCrawlOpenAI.
3+
Create an AI application instance by calling createCrawlOpenAI.
44

55
## type
66

7-
createXCrawlOpenAI API is a function.
7+
createCrawlOpenAI API is a function.
88

99
```ts
10-
function createXCrawlOpenAI(config?: CreateXCrawlOpenAIConfig): XCrawlOpenAIApp
10+
function createCrawlOpenAI(config?: createCrawlOpenAIConfig): crawlOpenAIApp
1111
```
1212

1313
**Parameter Type:**
1414

15-
- View the [CreateXCrawlOpenAIConfig](/type/create-crawl-openai#createcrawlopenaiconfig) type
15+
- View the [createCrawlOpenAIConfig](/type/create-crawl-openai#createcrawlopenaiconfig) type
1616

1717
**Return value type:**
1818

19-
- View the [XCrawlOpenAIApp](/type/create-crawl-openai#crawlopenaiapp) type
19+
- View the [crawlOpenAIApp](/type/create-crawl-openai#crawlopenaiapp) type
2020

2121
## Example
2222

2323
```js
24-
import { createXCrawlOpenAI } from 'x-crawl'
24+
import { createCrawlOpenAI } from 'x-crawl'
2525
26-
// xCrawlOpenAIApp API
27-
const xCrawlOpenAIApp = createXCrawlOpenAI({
26+
// crawlOpenAIApp API
27+
const crawlOpenAIApp = createCrawlOpenAI({
2828
clientOptions: { apiKey: 'Your API Key' },
2929
defaultModel: { chatModel: 'gpt-4-turbo-preview' }
3030
})

docs/api/custom.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ You can refer to: https://platform.openai.com/docs/api-reference/chat/create?lan
1717
## Example
1818

1919
```js
20-
import { createXCrawlOpenAI } from 'x-crawl'
20+
import { createCrawlOpenAI } from 'x-crawl'
2121
22-
const xCrawlOpenAIApp = createXCrawlOpenAI()
22+
const crawlOpenAIApp = createCrawlOpenAI()
2323
24-
const openai = xCrawlOpenAIApp.custom()
24+
const openai = crawlOpenAIApp.custom()
2525
```

docs/api/get-element-selectors.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ function getElementSelectors(
2626
## Example
2727

2828
```js
29-
import { createXCrawlOpenAI } from 'x-crawl'
29+
import { createCrawlOpenAI } from 'x-crawl'
3030
31-
const xCrawlOpenAIApp = createXCrawlOpenAI()
31+
const crawlOpenAIApp = createCrawlOpenAI()
3232
33-
xCrawlOpenAIApp
33+
crawlOpenAIApp
3434
.getElementSelectors('HTML', 'Tell the AI what you want')
3535
.then((res) => {})
3636
```

docs/api/help.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ function help(
2020
## Example
2121

2222
```js
23-
import { createXCrawlOpenAI } from 'x-crawl'
23+
import { createCrawlOpenAI } from 'x-crawl'
2424
25-
const xCrawlOpenAIApp = createXCrawlOpenAI()
25+
const crawlOpenAIApp = createCrawlOpenAI()
2626
27-
xCrawlOpenAIApp.help('Tell the AI your problem').then((res) => {})
27+
crawlOpenAIApp.help('Tell the AI your problem').then((res) => {})
2828
```

docs/api/parse-elements.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,11 @@ function parseElements<T extends Record<string, string>>(
2626
## Example
2727

2828
```js
29-
import { createXCrawlOpenAI } from 'x-crawl'
29+
import { createCrawlOpenAI } from 'x-crawl'
3030
31-
const xCrawlOpenAIApp = createXCrawlOpenAI()
31+
const crawlOpenAIApp = createCrawlOpenAI()
3232
33-
xCrawlOpenAIApp
33+
crawlOpenAIApp
3434
.parseElements('HTML', 'Tell the AI what you want')
3535
.then((res) => {})
3636
```

docs/cn/api/create-crawl-openai.md

+9-9
Original file line numberDiff line numberDiff line change
@@ -1,30 +1,30 @@
1-
# createXCrawlOpenAI
1+
# createCrawlOpenAI
22

3-
通过调用 createXCrawlOpenAI 创建一个 AI 应用实例。
3+
通过调用 createCrawlOpenAI 创建一个 AI 应用实例。
44

55
## 类型
66

7-
createXCrawlOpenAI API 是一个函数。
7+
createCrawlOpenAI API 是一个函数。
88

99
```ts
10-
function createXCrawlOpenAI(config?: CreateXCrawlOpenAIConfig): XCrawlOpenAIApp
10+
function createCrawlOpenAI(config?: createCrawlOpenAIConfig): crawlOpenAIApp
1111
```
1212

1313
**参数类型:**
1414

15-
- 查看 [CreateXCrawlOpenAIConfig](/cn/type/create-crawl-openai#createcrawlopenaiconfig) 类型
15+
- 查看 [createCrawlOpenAIConfig](/cn/type/create-crawl-openai#createcrawlopenaiconfig) 类型
1616

1717
**返回值类型:**
1818

19-
- 查看 [XCrawlOpenAIApp](/cn/type/create-crawl-openai#crawlopenaiapp) 类型
19+
- 查看 [crawlOpenAIApp](/cn/type/create-crawl-openai#crawlopenaiapp) 类型
2020

2121
## 示例
2222

2323
```js
24-
import { createXCrawlOpenAI } from 'x-crawl'
24+
import { createCrawlOpenAI } from 'x-crawl'
2525
26-
// xCrawlOpenAIApp API
27-
const xCrawlOpenAIApp = createXCrawlOpenAI({
26+
// crawlOpenAIApp API
27+
const crawlOpenAIApp = createCrawlOpenAI({
2828
clientOptions: { apiKey: '你的 API Key' },
2929
defaultModel: { chatModel: 'gpt-4-turbo-preview' }
3030
})

docs/cn/api/custom.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,9 @@ function custom(): OpenAI
1717
## 示例
1818

1919
```js
20-
import { createXCrawlOpenAI } from 'x-crawl'
20+
import { createCrawlOpenAI } from 'x-crawl'
2121
22-
const xCrawlOpenAIApp = createXCrawlOpenAI()
22+
const crawlOpenAIApp = createCrawlOpenAI()
2323
24-
const openai = xCrawlOpenAIApp.custom()
24+
const openai = crawlOpenAIApp.custom()
2525
```

docs/cn/api/get-element-selectors.md

+3-5
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,9 @@ function getElementSelectors(
2626
## 示例
2727

2828
```js
29-
import { createXCrawlOpenAI } from 'x-crawl'
29+
import { createCrawlOpenAI } from 'x-crawl'
3030
31-
const xCrawlOpenAIApp = createXCrawlOpenAI()
31+
const crawlOpenAIApp = createCrawlOpenAI()
3232
33-
xCrawlOpenAIApp
34-
.getElementSelectors('HTML', '告诉 AI 你想要的')
35-
.then((res) => {})
33+
crawlOpenAIApp.getElementSelectors('HTML', '告诉 AI 你想要的').then((res) => {})
3634
```

docs/cn/api/help.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -20,9 +20,9 @@ function help(
2020
## 示例
2121

2222
```js
23-
import { createXCrawlOpenAI } from 'x-crawl'
23+
import { createCrawlOpenAI } from 'x-crawl'
2424
25-
const xCrawlOpenAIApp = createXCrawlOpenAI()
25+
const crawlOpenAIApp = createCrawlOpenAI()
2626
27-
xCrawlOpenAIApp.help('告诉 AI 你的问题').then((res) => {})
27+
crawlOpenAIApp.help('告诉 AI 你的问题').then((res) => {})
2828
```

docs/cn/api/parse-elements.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -26,9 +26,9 @@ function parseElements<T extends Record<string, string>>(
2626
## 示例
2727

2828
```js
29-
import { createXCrawlOpenAI } from 'x-crawl'
29+
import { createCrawlOpenAI } from 'x-crawl'
3030
31-
const xCrawlOpenAIApp = createXCrawlOpenAI()
31+
const crawlOpenAIApp = createCrawlOpenAI()
3232
33-
xCrawlOpenAIApp.parseElements('HTML', '告诉 AI 你想要的').then((res) => {})
33+
crawlOpenAIApp.parseElements('HTML', '告诉 AI 你想要的').then((res) => {})
3434
```

0 commit comments

Comments
 (0)