Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
173 changes: 88 additions & 85 deletions ar/guides/claude/claude_messages.mdx

Large diffs are not rendered by default.

68 changes: 34 additions & 34 deletions ar/guides/openai/openai_embeddings.mdx
Original file line number Diff line number Diff line change
@@ -1,42 +1,42 @@
---
title: "OpenAI Embeddings API 申请及使用"
title: "التقديم واستخدام واجهة OpenAI Embeddings API"
description: "OpenAI generation API guide - Ace Data Cloud"
---

OpenAI 词向量服务,用于生成表示输入文本的词向量结果。
خدمة متجهات الكلمات من OpenAI، تُستخدم لإنشاء نتائج متجهات الكلمات التي تمثل النص المُدخل.

本文档主要介绍 OpenAI Embeddings API 操作的使用流程,利用它我们可以创建表示输入文本的嵌入向量。。
يقدم هذا المستند بشكل أساسي عملية استخدام واجهة OpenAI Embeddings API، وباستخدامها يمكننا إنشاء متجهات تضمين تمثل النص المُدخل。。

## 申请流程
## عملية التقديم

要使用 OpenAI Embeddings API,首先到 [Ace Data Cloud 控制台](https://platform.acedata.cloud/console/applications) 获取您的 API Token,留作备用。
لاستخدام واجهة OpenAI Embeddings API، انتقل أولاً إلى [وحدة تحكم Ace Data Cloud](https://platform.acedata.cloud/console/applications) للحصول على API Token الخاص بك، واحتفظ به للاستخدام لاحقًا.

![](https://cdn.acedata.cloud/dvc3cg.jpg)

如果你尚未登录或注册,会自动跳转到登录页面邀请你注册和登录,完成后会自动返回当前页面。
إذا لم تقم بتسجيل الدخول أو التسجيل بعد، فسيتم تلقائيًا الانتقال إلى صفحة تسجيل الدخول لدعوتك إلى التسجيل وتسجيل الدخول، وبعد الإكمال ستعود تلقائيًا إلى الصفحة الحالية.

**一个 API Token 即可调用平台所有服务,无需为每个服务单独申请。** 首次申请会赠送免费额度,可免费体验;额度不足时可在 [控制台](https://platform.acedata.cloud/console/coin) 充值通用余额。
**يمكن لـ API Token واحد استدعاء جميع خدمات المنصة، ولا حاجة للتقديم بشكل منفصل لكل خدمة.** سيُمنح رصيد مجاني عند التقديم لأول مرة، ويمكنك التجربة مجانًا؛ وعندما يكون الرصيد غير كافٍ، يمكنك شحن الرصيد العام في [وحدة التحكم](https://platform.acedata.cloud/console/coin).

> 📘 完整文档:[OpenAI Embeddings API →](https://platform.acedata.cloud/documents/openai-embeddings)
> 📘 المستند الكامل: [OpenAI Embeddings API →](https://platform.acedata.cloud/documents/openai-embeddings)

## 基本使用
## الاستخدام الأساسي

接下来就可以在界面上填写对应的内容,如图所示:
بعد ذلك، يمكنك ملء المحتوى المقابل في الواجهة، كما هو موضح في الصورة:

<p><img src="https://cdn.acedata.cloud/4qtbvr.png" width="500" className="m-auto" /></p>

在第一次使用该接口时,我们至少需要填写三个内容,一个是 `authorization`,直接在下拉列表里面选择即可。另一个参数是 `model`, `model` 就是我们选择使用 OpenAI 官网模型类别,这里我们主要有 3 种模型,详情可以看我们提供的模型。最后一个参数是`input`,`input` 是我们需要转换的词向量文本。
عند استخدام هذه الواجهة لأول مرة، نحتاج إلى ملء ثلاثة محتويات على الأقل، أحدها هو `authorization`، ويمكنك اختياره مباشرةً من القائمة المنسدلة. المعلمة الأخرى هي `model`، و`model` هي فئة النموذج من الموقع الرسمي لـ OpenAI التي نختار استخدامها، والنماذج المتاحة حاليًا هي `text-embedding-3-small` و`text-embedding-3-large`. تم إيقاف توفير `text-embedding-ada-002`؛ وإذا كانت فهارس المتجهات الحالية تستخدم هذا النموذج القديم، فلا يمكن خلط متجهات النموذج الجديد مباشرةً، ويجب إعادة إنشاء الفهرس. المعلمة الأخيرة هي `input`، و`input` هو نص متجهات الكلمات الذي نحتاج إلى تحويله.

同时您可以注意到右侧有对应的调用代码生成,您可以复制代码直接运行,也可以直接点击「Try」按钮进行测试。
في الوقت نفسه، يمكنك ملاحظة وجود إنشاء لرمز الاستدعاء المقابل على الجانب الأيمن، ويمكنك نسخ الرمز وتشغيله مباشرةً، أو يمكنك النقر مباشرةً على زر «Try» للاختبار.

可选参数:
المعلمات الاختيارية:

- `dimensions`:裁剪向量维度,默认输出完整维度。
- `encoding_format`:返回格式,可选 `float` 或 `base64`。
- `dimensions`: اقتطاع أبعاد المتجه، ويكون الإخراج الافتراضي بالأبعاد الكاملة.
- `encoding_format`: تنسيق الإرجاع، ويمكن أن يكون `float` أو `base64`.

<p><img src="https://cdn.acedata.cloud/gqulm9.png" width="500" className="m-auto" /></p>

Python 样例调用代码:
رمز استدعاء نموذجي بلغة Python:

```python
import requests
Expand All @@ -51,15 +51,15 @@ headers = {

payload = {
"input": "The food was delicious and the waiter...",
"model": "text-embedding-ada-002",
"model": "text-embedding-3-small",
"encoding_format": "float"
}

response = requests.post(url, json=payload, headers=headers)
print(response.text)
```

调用之后,我们发现返回结果如下:
بعد الاستدعاء، نجد أن النتيجة المُرجعة كما يلي:

```json
{
Expand Down Expand Up @@ -97,33 +97,33 @@ print(response.text)
]
}
],
"model": "text-embedding-ada-002",
"model": "text-embedding-3-small",
"usage": {
"prompt_tokens": 8,
"total_tokens": 8
}
}
```

返回结果一共有多个字段,介绍如下:
تحتوي النتيجة المُرجعة على عدة حقول، ويُقدَّم شرحها كما يلي:

- `model`,此次文本转词向量所采用的模型。
- `usage`,此次文本转词向量所使用的token信息。
- `data`,文本转化后的词向量结果。
- `model`، النموذج المُستخدم في تحويل هذا النص إلى متجهات كلمات.
- `usage`، معلومات token المستخدمة في تحويل هذا النص إلى متجهات كلمات.
- `data`، نتيجة متجهات الكلمات بعد تحويل النص.

其中 `data` 是包含了文本对应的词向量的具体信息,它里面的 `embedding` 是生成的词向量具体结果。
من بينها، يحتوي `data` على المعلومات التفصيلية لمتجهات الكلمات المقابلة للنص، ويكون `embedding` داخله هو النتيجة التفصيلية لمتجهات الكلمات المُنشأة.

## 错误处理
## معالجة الأخطاء

在调用 API 时,如果遇到错误,API 会返回相应的错误代码和信息。例如:
عند استدعاء API، إذا واجهت خطأً، فسيُرجع API رمز الخطأ والمعلومات المقابلة. على سبيل المثال:

- `400 token_mismatched`:请求错误,可能是由于缺少或无效的参数。
- `400 api_not_implemented`:请求错误,可能是由于缺少或无效的参数。
- `401 invalid_token`:未授权,授权令牌无效或缺失。
- `429 too_many_requests`:请求过多,您已超出速率限制。
- `500 api_error`:内部服务器错误,服务器出现问题。
- `400 token_mismatched`: طلب غير صالح، ربما بسبب معلمات مفقودة أو غير صالحة.
- `400 api_not_implemented`: طلب غير صالح، ربما بسبب معلمات مفقودة أو غير صالحة.
- `401 invalid_token`: غير مصرح، رمز التفويض غير صالح أو مفقود.
- `429 too_many_requests`: عدد كبير جدًا من الطلبات، لقد تجاوزت حد المعدل.
- `500 api_error`: خطأ داخلي في الخادم، حدث خطأ ما على الخادم.

### 错误响应示例
### مثال على استجابة الخطأ

```json
{
Expand All @@ -136,6 +136,6 @@ print(response.text)
}
```

## 结论
## الخلاصة

通过本文档,您已经了解了如何使用 OpenAI Embeddings API 轻松使用官方 OpenAI 的词向量生成的功能。希望本文档能帮助您更好地对接和使用该 API。如有任何问题,请随时联系我们的技术支持团队。
من خلال هذا المستند، أصبحت تعرف بالفعل كيفية استخدام واجهة OpenAI Embeddings API لاستخدام ميزة إنشاء متجهات الكلمات الرسمية من OpenAI بسهولة. نأمل أن يساعدك هذا المستند على الربط واستخدام API بشكل أفضل. إذا كانت لديك أي أسئلة، فيُرجى التواصل مع فريق الدعم الفني لدينا في أي وقت.
Loading
Loading