Định dạng nhúng OpenAI

Tài liệu chính thức

📝 Giới thiệu

Nhận các biểu diễn vectơ của văn bản đầu vào nhất định mà các mô hình và thuật toán học máy có thể dễ dàng sử dụng. Để biết các hướng dẫn liên quan, hãy xem Hướng dẫn nhúng.

Lưu ý quan trọng:

Một số kiểu máy có thể có giới hạn về tổng số mã thông báo trong đầu vào
Bạn có thể sử dụng example Python code để tính số lượng token
Ví dụ: model text-embedding-ada-002 xuất ra vectơ có 1536 chiều

💡 Yêu cầu Ví dụ

Tạo văn bản nhúng ✅

curl https://88api.ai/v1/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "input": "The food was delicious and the waiter...",
    "model": "text-embedding-ada-002",
    "encoding_format": "float"
  }'

Response Example:

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255, -0.009327292,
        // ... (1536 floating point numbers for ada-002)
        -0.0028842222
      ],
      "index": 0
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 8,
    "total_tokens": 8
  }
}

Tạo các phần nhúng hàng loạt ✅

curl https://88api.ai/v1/embeddings \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer $API_KEY" \
  -d '{
    "input": ["The food was delicious", "The waiter was friendly"],
    "model": "text-embedding-ada-002",
    "encoding_format": "float"
  }'

Response Example:

{
  "object": "list",
  "data": [
    {
      "object": "embedding",
      "embedding": [
        0.0023064255
        // ... (1536 floating point numbers)
      ],
      "index": 0
    },
    {
      "object": "embedding",
      "embedding": [
        -0.008815289
        // ... (1536 floating point numbers)
      ],
      "index": 1
    }
  ],
  "model": "text-embedding-ada-002",
  "usage": {
    "prompt_tokens": 12,
    "total_tokens": 12
  }
}

📮 Yêu cầu

Điểm cuối

POST /v1/embeddings

Tạo các vectơ nhúng đại diện cho văn bản đầu vào.

Văn bản đầu vào cần nhúng, được mã hóa dưới dạng chuỗi hoặc mảng mã thông báo. Để nhúng nhiều đầu vào vào một yêu cầu, hãy chuyển một mảng chuỗi hoặc một mảng mảng mã thông báo. Đầu vào không được vượt quá số lượng mã thông báo đầu vào tối đa của mô hình (8192 mã thông báo cho nhúng văn bản-ada-002), không được là một chuỗi trống và bất kỳ mảng nào cũng phải có kích thước nhỏ hơn hoặc bằng 2048.

`model`

Loại: Chuỗi
Bắt buộc: Có

ID của mô hình sẽ sử dụng. Bạn có thể sử dụng API mô hình danh sách để xem tất cả các mô hình có sẵn hoặc xem tổng quan về mô hình để biết mô tả của chúng.

`encoding_format`

Loại: Chuỗi
Bắt buộc: Không
Mặc định: thả nổi

Định dạng để trả về phần nhúng. Có thể là float hoặc base64.

`dimensions`

Kiểu: Số nguyên
Bắt buộc: Không

Số lượng kích thước mà các phần nhúng đầu ra được tạo nên có. Chỉ được hỗ trợ trong các mẫu text-embed-3 và mới hơn.

`user`

Loại: Chuỗi
Bắt buộc: Không

Mã định danh duy nhất đại diện cho người dùng cuối của bạn, có thể giúp OpenAI giám sát và phát hiện hành vi lạm dụng. Tìm hiểu thêm.

📥 Phản hồi

###Phản hồi thành công

Trả về danh sách các đối tượng được nhúng.

`object`

Loại: Chuỗi
Mô tả: Kiểu đối tượng, giá trị là “list”

`data`

Kiểu: Mảng
Mô tả: Mảng chứa đối tượng nhúng
Của cải:
object: Kiểu đối tượng, giá trị là “nhúng”
embedding: Nhúng vector, danh sách số dấu phẩy động. Chiều dài vectơ phụ thuộc vào mô hình
index: Chỉ số nhúng trong danh sách

`model`

Loại: Chuỗi
Mô tả: Tên model sử dụng

`usage`

Loại: Đối tượng
Mô tả: Thống kê sử dụng Token
Của cải:
prompt_tokens: Số lượng token dùng cho lời nhắc
total_tokens: Tổng số token

Nhúng đối tượng

Biểu thị một vectơ nhúng được trả về bởi điểm cuối nhúng.

{
  "object": "embedding",
  "embedding": [
    0.0023064255, -0.009327292,
    // ... (1536 floating point numbers total for ada-002)
    -0.0028842222
  ],
  "index": 0
}

`index`

Kiểu: Số nguyên
Mô tả: Chỉ mục nhúng trong danh sách

`embedding`

Kiểu: Mảng
Mô tả: Nhúng vector, danh sách số dấu phẩy động. Độ dài vectơ tùy thuộc vào kiểu máy, xem hướng dẫn nhúng để biết chi tiết

`object`

Loại: Chuỗi
Mô tả: Kiểu đối tượng, luôn “nhúng”

Phản hồi lỗi

Khi có vấn đề với yêu cầu, API sẽ trả về đối tượng phản hồi lỗi có mã trạng thái HTTP trong phạm vi 4XX-5XX.

Mã trạng thái lỗi phổ biến

401 Unauthorized: Key API không hợp lệ hoặc bị thiếu
400 Bad Request: Tham số yêu cầu không hợp lệ, chẳng hạn như đầu vào trống hoặc vượt quá giới hạn mã thông báo
429 Too Many Requests: Vượt quá giới hạn lệnh gọi API
500 Internal Server Error: Lỗi máy chủ nội bộ

Ví dụ về phản hồi lỗi:

{
  "error": {
    "message": "The input exceeds the maximum length. Please reduce the length of your input.",
    "type": "invalid_request_error",
    "param": "input",
    "code": "context_length_exceeded"
  }
}

📝 Giới thiệu

💡 Yêu cầu Ví dụ

Tạo văn bản nhúng ✅

Tạo các phần nhúng hàng loạt ✅

📮 Yêu cầu

Điểm cuối

Phương thức xác thực

Thông số nội dung yêu cầu

`input`

`model`

`encoding_format`

`dimensions`

`user`

📥 Phản hồi

`object`

`data`

`model`

`usage`

Nhúng đối tượng

`index`

`embedding`

`object`

Phản hồi lỗi

Mã trạng thái lỗi phổ biến

Mục lục