Bỏ qua để đến nội dung

Đã tạo xong

Xem Markdownllms.txt

API origin: https://api.openaihub.net. Chọn đúng nhóm API và model. Thông số dưới đây là bản tham chiếu kỹ thuật; chưa phải kết quả kiểm thử từng endpoint bằng tài khoản của bạn.

openapi: 3.0.1
info:
title: ''
description: ''
version: 1.0.0
paths:
/v1/completions:
post:
summary: Đã tạo xong
deprecated: false
description: >-
Khi được cung cấp một gợi ý, mô hình sẽ trả về một hoặc nhiều phần hoàn
thành được dự đoán và cũng có thể trả về xác suất của dấu thay thế tại
mỗi vị trí.
Tạo phần hoàn thành cho các lời nhắc và tham số đã cung cấp
https://platform.openai.com/docs/api-reference/completions
operationId: v1_completions
tags:
- >-
OpenAiHub Việt Nam/OpenAiHub Tiếng Việt/Trò chuyện/ChatGpt/Các lượt hoàn tất
của ChatGPT
- Hoàn tất
parameters:
- name: Authorization
in: header
description: Khóa API Bearer
required: false
example: Bearer {{YOUR_API_KEY}}
schema:
type: string
requestBody:
content:
application/json:
schema:
type: object
required:
- model
- prompt
- user
properties:
best_of:
type: integer
description: >-
Mặc định là 1. Tạo best_of phương án hoàn thành ở phía máy
chủ và trả về phương án hoàn thành "tốt nhất" (phương án có
xác suất log cao nhất cho từng token). Không thể truyền phát
kết quả. Khi được dùng cùng với n, best_of kiểm soát số
lượng phương án hoàn thành ứng viên, còn n chỉ định số lượng
phương án được trả về – best_of phải lớn hơn n. Lưu ý: Vì
tham số này tạo ra nhiều phương án hoàn thành, nó có thể
nhanh chóng tiêu hao hạn mức token của bạn. Vui lòng thận
trọng khi sử dụng và bảo đảm rằng bạn thiết lập các giá trị
hợp lý cho max_tokens và stop.
echo:
type: boolean
description: >-
Giá trị mặc định là false. Ngoài phần hoàn thành, các lời
nhắc cũng được hiển thị lại.
frequency_penalty:
type: number
description: >-
Mặc định là 0 - một số nằm trong khoảng từ 2.0 đến 2.0. Các
giá trị dương phạt những token mới dựa trên tần suất hiện
tại của chúng trong văn bản, làm giảm khả năng mô hình lặp
lại nguyên văn cùng một dòng.
logit_bias:
type: object
description: >-
Mặc định là null
Xác suất xuất hiện của token được chỉ định trong phần hoàn
thành chỉnh sửa. Chấp nhận một đối tượng JSON ánh xạ một
token (được chỉ định bằng ID token trong bộ tách token GPT)
tới một giá trị độ lệch tương ứng, từ -100 đến 100. Bạn có
thể dùng công cụ tách token này (có sẵn cho GPT-2 và GPT-3)
để chuyển đổi văn bản thành các ID token.
Về mặt toán học, độ lệch được cộng vào logit thu được trước
khi mô hình được lấy mẫu. Tác động chính xác khác nhau tùy
theo từng mô hình, nhưng các giá trị từ -1 đến 1 sẽ làm giảm
hoặc tăng khả năng được chọn; các giá trị như -100 hoặc 100
sẽ khiến token liên quan bị cấm hoặc được chọn riêng biệt.
Ví dụ, bạn có thể truyền {"50256": -100} để ngăn token
<|endoftext|> được tạo.
x-apidog-orders: []
logprobs:
type: string
description: >-
Mặc định là null
Bao gồm xác suất logarit của các token có khả năng cao nhất
trong logprobs, cũng như token đã chọn. Ví dụ, nếu logprobs
là 5, API sẽ trả về danh sách 5 token có khả năng cao nhất.
API luôn trả về xác suất logarit của token được lấy mẫu, vì
vậy phản hồi có thể có tối đa logprobs+1 phần tử.
Giá trị tối đa của logprobs là 5.
nullable: true
max_tokens:
type: integer
description: >-
Mặc định là 16
Số lượng token tối đa được tạo trong phần hoàn thành.
Tổng số token của gợi ý và `max_tokens` không được vượt quá
độ dài ngữ cảnh của mô hình. Ví dụ mã Python để đếm token.
model:
type: string
description: >-
ID của mô hình cần sử dụng. Bạn có thể dùng API Liệt kê mô
hình để xem tất cả các mô hình hiện có, hoặc xem phần Tổng
quan về mô hình để đọc mô tả của chúng.
'n':
type: integer
description: >-
Mặc định là 1
Số lượng phương án hoàn thành được tạo cho mỗi lời nhắc.
Lưu ý: Vì tham số này tạo ra nhiều phương án hoàn thành, nó
có thể nhanh chóng làm cạn hạn mức token của bạn. Vui lòng
sử dụng thận trọng và đảm bảo bạn đã thiết lập các giá trị
hợp lý cho max_tokens và stop.
presence_penalty:
type: number
description: >-
Mặc định là 0 - một số nằm trong khoảng từ 2.0 đến 2.0. Các
giá trị dương phạt các token mới dựa trên việc chúng có xuất
hiện trong văn bản hiện tại hay không, làm tăng khả năng mô
hình thảo luận các chủ đề mới. Để biết thêm thông tin về mức
phạt tần suất và mức phạt hiện diện, hãy xem .
prompt:
type: string
description: >-
Tạo một lời nhắc hoàn chỉnh, được mã hóa dưới dạng một
chuỗi, một mảng chuỗi, một mảng token hoặc một mảng các mảng
token. Lưu ý rằng <|endoftext|> là dấu phân cách tài liệu mà
mô hình nhìn thấy trong quá trình huấn luyện, vì vậy nếu
không chỉ định gợi ý nào, mô hình sẽ tạo phần mở đầu của một
tài liệu mới.
seed:
type: integer
description: >-
Nếu được chỉ định, hệ thống của chúng tôi sẽ cố gắng hết sức
để lấy mẫu theo cách xác định, nhờ đó các yêu cầu lặp lại
với cùng seed và các tham số sẽ trả về cùng kết quả. Tính
xác định không được bảo đảm và bạn nên tham chiếu tham số
phản hồi system_fingerprint để theo dõi các thay đổi ở
backend của mình.
stop:
type: string
description: >-
Mặc định là null, với tối đa 4 chuỗi mà tại đó API sẽ ngừng
tạo thêm token. Văn bản được trả về sẽ không chứa các chuỗi
dừng.
stream:
type: boolean
description: >-
Mặc định là false, cho biết có truyền ngược lại một phần
tiến trình hay không. Nếu được bật, token sẽ được gửi dưới
dạng sự kiện do máy chủ gửi chỉ chứa dữ liệu khi có sẵn, và
luồng sẽ kết thúc bằng thông báo data: [DONE]. Thông báo
dạng đối tượng. Các ví dụ mã Python.
suffix:
type: string
description: >-
Mặc định là null. Hậu tố xuất hiện sau khi hoàn tất văn bản
được chèn.
temperature:
type: integer
description: >-
Mặc định là 1. Nhiệt độ lấy mẫu được sử dụng, nằm trong
khoảng từ 0 đến 2. Giá trị cao hơn (như 0.8) sẽ làm cho đầu
ra ngẫu nhiên hơn, trong khi giá trị thấp hơn (như 0.2) sẽ
làm cho đầu ra tập trung và có tính xác định cao hơn. Nhìn
chung, chúng tôi khuyến nghị chỉ thay đổi tham số này hoặc
top_p, không thay đổi cả hai.
top_p:
type: integer
description: >-
Đại diện cho một mã định danh duy nhất của người dùng cuối,
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.
user:
type: string
description: >-
Mã định danh người dùng cuối (để kiểm soát rủi ro / thanh
toán)
refName: PostV1CompletionsRequest
x-apifox-orders:
- best_of
- echo
- frequency_penalty
- logit_bias
- logprobs
- max_tokens
- model
- 'n'
- presence_penalty
- prompt
- seed
- stop
- stream
- suffix
- temperature
- top_p
- user
x-apidog-orders:
- best_of
- echo
- frequency_penalty
- logit_bias
- logprobs
- max_tokens
- model
- 'n'
- presence_penalty
- prompt
- seed
- stop
- stream
- suffix
- temperature
- top_p
- user
examples:
gpt_3_5_turbo_instruct:
value:
max_tokens: 30
model: gpt-3.5-turbo-instruct
prompt: Xin chào,
temperature: 0
user: default-user
summary: gpt_3_5_turbo_instruct
description: Đã tạo xong
responses:
'200':
description: ''
content:
application/json:
schema:
type: object
required:
- id
- object
- created
- model
- system_fingerprint
- choices
- usage
properties:
choices:
type: array
items:
type: object
properties:
finish_reason:
type: string
description: 'Lý do kết thúc, ví dụ: stop, length'
index:
type: integer
description: Chỉ mục của mục ứng viên
logprobs:
type: string
description: Thông tin xác suất lôgarit (nếu được bật)
nullable: true
text:
type: string
description: Vui lòng cung cấp nội dung văn bản cần dịch.
x-apifox-orders:
- finish_reason
- index
- logprobs
- text
x-apidog-orders:
- finish_reason
- index
- logprobs
- text
description: Danh sách các kết quả ứng viên
created:
type: integer
description: Thời gian tạo (dấu thời gian Unix)
id:
type: string
description: ID tài nguyên hoặc tác vụ
model:
type: string
description: Tên mô hình / mã định danh mô hình
object:
type: string
description: 'Định danh kiểu đối tượng, ví dụ: chat.completion'
system_fingerprint:
type: string
description: Dấu vân tay cấu hình phía máy chủ
usage:
type: object
required:
- prompt_tokens
- completion_tokens
- total_tokens
properties:
completion_tokens:
type: integer
description: Số lượng token hoàn thành
prompt_tokens:
type: integer
description: Số lượng token trong lời nhắc
total_tokens:
type: integer
description: Tổng số token
description: Thống kê mức sử dụng token
x-apifox-orders:
- completion_tokens
- prompt_tokens
- total_tokens
x-apidog-orders:
- completion_tokens
- prompt_tokens
- total_tokens
refName: PostV1CompletionsResponse
x-apifox-orders:
- choices
- created
- id
- model
- object
- system_fingerprint
- usage
x-apidog-orders:
- choices
- created
- id
- model
- object
- system_fingerprint
- usage
examples:
example:
summary: example
value:
choices:
- finish_reason: độ dài
index: 0
logprobs: ''
text: >-
Tôi là Tiểu Băng, rất vui được làm quen với bạn. Tôi
là một trợ lý trí tuệ nhân tạo, có thể trả
created: 1753859563
id: cmpl-ByvHP6AWeB1L5vWZSPNHsB12sU9db
model: gpt-3.5-turbo-instruct
object: text_completion
system_fingerprint: fp_abc123
usage:
completion_tokens: 30
prompt_tokens: 3
total_tokens: 33
headers: {}
x-apidog-name: ''
'400':
description: Yêu cầu không hợp lệ hoặc xác thực thất bại
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: object
required:
- message
- type
properties:
message:
type: string
description: Thông báo lỗi (thường kết thúc bằng mã yêu cầu)
type:
type: string
description: Loại lỗi; các lỗi cổng cục bộ thường là new_api_error
examples:
- new_api_error
x-apifox-orders:
- message
- type
x-apidog-orders:
- message
- type
refName: NewApiError
x-apifox-orders:
- error
x-apidog-orders:
- error
examples:
example:
summary: example
value:
error:
message: >-
Yêu cầu không hợp lệ (mã yêu cầu:
20260805120000123456789AbCdEfGh)
type: new_api_error
headers: {}
x-apidog-name: Yêu cầu không hợp lệ hoặc xác thực thất bại
'401':
description: Khóa API bị thiếu hoặc không hợp lệ
content:
application/json:
schema:
type: object
required:
- error
properties:
error:
type: object
required:
- message
- type
properties:
message:
type: string
description: Thông báo lỗi (thường kết thúc bằng mã yêu cầu)
type:
type: string
description: Loại lỗi; các lỗi cổng cục bộ thường là new_api_error
examples:
- new_api_error
x-apifox-orders:
- message
- type
x-apidog-orders:
- message
- type
refName: NewApiError
x-apifox-orders:
- error
x-apidog-orders:
- error
examples:
example:
summary: example
value:
error:
message: >-
Mã thông báo không hợp lệ (request id:
20260805120000123456789AbCdEfGh)
type: new_api_error
headers: {}
x-apidog-name: Khóa API bị thiếu hoặc không hợp lệ
security: []
x-apidog-folder: >-
OpenAiHub Việt Nam/OpenAiHub Tiếng Việt/Trò chuyện/ChatGpt/Các lượt hoàn tất của
ChatGPT
x-apidog-status: released
x-run-in-apidog: https://app.apidog.com/web/project/1218648/apis/api-45208825-run
components:
schemas: {}
securitySchemes: {}
servers:
- url: https://api.openaihub.net
description: Prod Env
security: []