diff --git a/docs/products/apis/documents/ocr.md b/docs/products/apis/documents/ocr.md index dbd32a4fe83bbce0c8488fa5f0e6ace01347bf9b..5254e2b1cbe57e652e883b3781bfd795773a6063 100644 --- a/docs/products/apis/documents/ocr.md +++ b/docs/products/apis/documents/ocr.md @@ -21,40 +21,36 @@ GOT-OCR2_0 提供功能强大的 OCR 解决方案，能够高精度、快速、 您可以点击 [GOT-OCR2_0]({{SITE_URL}}/serverless-api?model=GOT-OCR2_0) 在线免费体验。以下是代码调用示例。 - - -```bash -curl {{SITE_URL}}/v1/images/ocr \ - -X POST \ - -H "Authorization: Bearer 私人令牌" \ - -F "model=GOT-OCR2_0" - -F "image=@path/to/image.jpg" - -F "response_format=text" -``` - - - -```python showLineNumbers title="python" -import requests -API_URL = "{{SITE_URL}}/v1/images/ocr" -HEADERS = { - "Authorization": "Bearer 私人令牌", -} -def query(image_path, model="GOT-OCR2_0", response_format="text"): - with open(image_path, "rb") as image_file: - response = requests.post( - API_URL, - headers=HEADERS, - files={"image": (image_path, image_file)}, - data={"model": model, "response_format": response_format}, - ) - return response.json() - -output = query("test.jpg") -print(output) # {"text": "xxx"} - -```` - + + ```bash showLineNumbers + curl {{SITE_URL}}/v1/images/ocr \ + -X POST \ + -H "Authorization: Bearer 私人令牌" \ + -F "model=GOT-OCR2_0" + -F "image=@path/to/image.jpg" + -F "response_format=text" + ``` + + + ```python showLineNumbers title="python" + import requests + API_URL = "{{SITE_URL}}/v1/images/ocr" + HEADERS = { + "Authorization": "Bearer 私人令牌", + } + def query(image_path, model="GOT-OCR2_0", response_format="text"): + with open(image_path, "rb") as image_file: + response = requests.post( + API_URL, + headers=HEADERS, + files={"image": (image_path, image_file)}, + data={"model": model, "response_format": response_format}, + ) + return response.json() + + output = query("test.jpg") + print(output) # {"text": "xxx"} + ``` diff --git a/docs/products/apis/documents/pdf.md b/docs/products/apis/documents/pdf.md index 57012b66e5f37fb229d306524433f218f9ea7016..a99df1c9cb199f5d51f89467b1050195a47562af 100644 --- a/docs/products/apis/documents/pdf.md +++ b/docs/products/apis/documents/pdf.md @@ -35,10 +35,7 @@ PDF-Extract-Kit 专为从各类复杂 PDF 文档中高效提取高质量内容 ### 使用方法 您可以点击 [PDF-Extract-Kit]({{SITE_URL}}/serverless-api?model=PDF-Extract-Kit-1.0) 在线免费体验。以下是代码调用示例。 - - - -```bash +```bash showLineNumbers curl {{SITE_URL}}/v1/async/documents/parse \ -X POST \ -H "Authorization: Bearer 您的访问令牌" \ @@ -50,9 +47,6 @@ PDF-Extract-Kit 专为从各类复杂 PDF 文档中高效提取高质量内容 -F "file=@path/to/file.pdf" ``` - - - ### 参数说明： - 私人令牌：用于验证调用身份，点击 [访问令牌]({{SITE_URL}}/dashboard/settings/tokens) 获取。 @@ -76,7 +70,7 @@ PDF-Extract-Kit 专为从各类复杂 PDF 文档中高效提取高质量内容 该接口为异步接口，需要先提交任务，获取到任务 ID，随后再根据 ID 轮询获取执行结果。CURL 提交任务后将会响应： -```json +```json showLineNumbers { "task_id": "AAC2KETEYJVKER04U6RNMHJTOGLVEG1B", "status": "waiting", @@ -90,12 +84,12 @@ PDF-Extract-Kit 专为从各类复杂 PDF 文档中高效提取高质量内容 再根据 task_id 获取最终执行结果： -```bash +```bash showLineNumbers curl {{SITE_URL}}/v1/task/AAC2KETEYJVKER04U6RNMHJTOGLVEG1B/ --header 'Authorization: Bearer 您的访问令牌' ``` -```json +```json showLineNumbers { "task_id": "AAC2KETEYJVKER04U6RNMHJTOGLVEG1B", "output": { diff --git a/docs/products/apis/texts/text-comlpetion.md b/docs/products/apis/texts/text-comlpetion.md index 918c4cd29d1b7a5b9b949047cef5c327b771dccd..bc6dd7d66586c81ace998024b7a6d4d99ed93ed7 100644 --- a/docs/products/apis/texts/text-comlpetion.md +++ b/docs/products/apis/texts/text-comlpetion.md @@ -30,7 +30,7 @@ import TabItem from '@theme/TabItem'; 使用 `curl` 可清晰了解文本补全请求的路径、参数的原始情况： -```bash +```bash showLineNumbers curl {{SITE_URL}}/v1/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer 您的访问令牌" \ @@ -43,7 +43,7 @@ curl {{SITE_URL}}/v1/completions \ }' ``` AI 模型响应： -```json +```json showLineNumbers title="json" { "id": "cmpl-6d4f8a9b9c7e6f5d4c3b2a1", "object": "text_completion", @@ -156,6 +156,13 @@ for chunk in stream: **示例：通过 instructions 设定风格** ```python showLineNumbers title="python" +from openai import OpenAI + +client = OpenAI( + base_url="{{SITE_URL}}/v1", + api_key="您的访问令牌" +) + client.completions.create( model="Qwen2.5-72B-Instruct", prompt="余尝闻，世间至美之物，莫过于", @@ -170,6 +177,13 @@ client.completions.create( 对于长文本片段的补全，确保提供足够的上下文信息，帮助模型理解文本的主题、逻辑和风格。 **示例：** ```python showLineNumbers title="python" +from openai import OpenAI + +client = OpenAI( + base_url="{{SITE_URL}}/v1", + api_key="您的访问令牌" +) + prompt = """ 以下是一篇关于环境保护的文章片段，请继续补全： @@ -201,6 +215,13 @@ prompt = """ 补全内容： """ +from openai import OpenAI + +client = OpenAI( + base_url="{{SITE_URL}}/v1", + api_key="您的访问令牌" +) + client.completions.create( model="Qwen2.5-72B-Instruct", prompt=prompt, diff --git a/docs/products/apis/texts/text-generation.md b/docs/products/apis/texts/text-generation.md index a83757de39adc0ad7279326087a4cb80d68bcc0a..fff1710969dac95dbdf589ea8e7c71680b961f1f 100644 --- a/docs/products/apis/texts/text-generation.md +++ b/docs/products/apis/texts/text-generation.md @@ -33,7 +33,7 @@ import TabItem from '@theme/TabItem'; - ```bash + ```shell showLineNumbers curl {{SITE_URL}}/v1/chat/completions \ -H "Content-Type: application/json" \ -H "Authorization: Bearer 您的访问令牌" \ @@ -54,50 +54,47 @@ import TabItem from '@theme/TabItem'; ``` -```js -async function query(data) { - const response = await fetch( - "{{SITE_URL}}/v1/chat/completions", - { - headers: { - "Authorization": "Bearer xxxxx", - "Content-Type": "application/json" - }, - method: "POST", - body: JSON.stringify(data), + ```javascript showLineNumbers + async function query(data) { + const response = await fetch('https://ai.gitee.com/v1/chat/completions', { + headers: { + Authorization: 'Bearer xxxxx', + 'Content-Type': 'application/json', + }, + method: 'POST', + body: JSON.stringify(data), + }); + const result = await response.json(); + return result; } - ); - const result = await response.json(); - return result; -} - -query({ - "messages": [ - { - "role": "system", - "content": "你是聪明的助手" - }, - { - "role": "user", - "content": "老鼠生病了可以吃老鼠药治好吗？" - } - ], - "model": "Qwen2.5-72B-Instruct", - "stream": false, - "max_tokens": 512, - "temperature": 0.7, - "top_p": 0.7, - "frequency_penalty": 1 -}).then((response) => { - console.log(JSON.stringify(response)); -}); - -```` + + query({ + "messages": [ + { + "role": "system", + "content": "你是聪明的助手" + }, + { + "role": "user", + "content": "老鼠生病了可以吃老鼠药治好吗？" + } + ], + "model": "Qwen2.5-72B-Instruct", + "stream": false, + "max_tokens": 512, + "temperature": 0.7, + "top_p": 0.7, + "frequency_penalty": 1 + }).then((response) => { + console.log(JSON.stringify(response)); + }); + + ``` AI 模型响应： -```json +```json showLineNumbers { "id": "chat-476266af435142d2bb7d342ea54694f2", "object": "chat.completion", @@ -148,7 +145,8 @@ base_url = "{{SITE_URL}}/v1" model_name = "Qwen2.5-72B-Instruct" # {{SITE_URL}}/dashboard/settings/tokens 获取您的访问令牌 -client = OpenAI(base_url=base_url, api_key="GITEE_AI_API_KEY") +GITEE_AI_API_KEY = "您的访问令牌" +client = OpenAI(base_url=base_url, api_key=GITEE_AI_API_KEY) completion = client.chat.completions.create( model=model_name, # 指定模型名称 例如 Qwen2.5-72B-Instruct，可访问 {{SITE_URL}}/serverless-api 查看 @@ -174,6 +172,14 @@ for chunk in completion: 对于长文本生成，启用流式响应 `stream=True` 可实时获取结果，减少等待时间： ```python showLineNumbers title="python" +from openai import OpenAI + +# 初始化客户端 +client = OpenAI( + base_url="{{SITE_URL}}/v1", + api_key="您的访问令牌" +) + stream = client.chat.completions.create( model="Qwen2.5-72B-Instruct",# 替换成指定模型名称 messages=[ @@ -247,7 +253,7 @@ for chunk in stream: `instructions` 为模型提供**高级指令**（语气、目标、示例等），优先级高于 `input` 内容。 -```javascript +```javascript showLineNumbers title="javascript" import OpenAI from 'openai'; const client = new OpenAI({ baseURL: '{{SITE_URL}}/v1', diff --git a/docusaurus.config.ts b/docusaurus.config.ts index cb38b5e0597f44c46058ca96cd4afb7d5d16af51..0abfa95284923fc939fac065b8391da5a09129dc 100644 --- a/docusaurus.config.ts +++ b/docusaurus.config.ts @@ -241,6 +241,7 @@ const config: Config = { copyright: `Copyright © ${new Date().getFullYear()} 模力方舟.`, }, prism: { + additionalLanguages: ['bash', 'json'], theme: prismThemes.github, darkTheme: prismThemes.dracula, }, diff --git a/src/plugins/env-replacement-loader.js b/src/plugins/env-replacement-loader.js index e41f0cbd98cca9c3e1a5439fa8e7d38cec85769f..d52e01280320b64aea3f9b2c31f4dcd2039e4fe2 100644 --- a/src/plugins/env-replacement-loader.js +++ b/src/plugins/env-replacement-loader.js @@ -28,7 +28,7 @@ module.exports = function (source) { // 如果进行了替换，输出调试信息（仅在开发模式下） if (hasReplacements && process.env.NODE_ENV === 'development') { - console.log(`[env-replacement-loader] 已处理文件: ${this.resourcePath}`); + // console.log(`[env-replacement-loader] 已处理文件: ${this.resourcePath}`); } return result;