Bagikan melalui


Stored Completion - List

Mendapatkan daftar penyelesaian tersimpan.

GET {endpoint}/openai/chat/completions?api-version=2025-02-01-preview
GET {endpoint}/openai/chat/completions?metadata={metadata}&model={model}&after={after}&limit={limit}&order={order}&api-version=2025-02-01-preview

Parameter URI

Nama Dalam Diperlukan Jenis Deskripsi
endpoint
path True

string (url)

Titik akhir Cognitive Services yang didukung (protokol dan nama host, misalnya: https://aoairesource.openai.azure.com. Ganti "aoairesource" dengan nama akun Azure OpenAI Anda).

api-version
query True

string

Versi API yang diminta.

after
query

string

Pengidentifikasi untuk penyelesaian terakhir yang disimpan dari permintaan penomoran halaman sebelumnya.

limit
query

integer (int32)

Jumlah penyelesaian tersimpan untuk diambil. Default ke 20.

metadata
query

string

Filter menurut pasangan (kunci, nilai) dalam penyelesaian tersimpan.

model
query

string

Filter menurut nama model.

order
query

string

Urutan hasil dengan waktu yang dibuat (naik atau turun). Default ke desc.

Respons

Nama Jenis Deskripsi
200 OK

StoredCompletionList

Keberhasilan

Other Status Codes

ErrorResponse

Terjadi kesalahan.

Keamanan

api-key

Autentikasi kunci API

Jenis: apiKey
Dalam: header

OAuth2Auth

Autentikasi OAuth2

Jenis: oauth2
Alur: implicit
URL Otorisasi: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Cakupan

Nama Deskripsi
https://cognitiveservices.azure.com/.default

Contoh

Gets list of stored completions.

Permintaan sampel

GET https://aoairesource.openai.azure.com/openai/chat/completions?api-version=2025-02-01-preview

Respon sampel

{
  "object": "list",
  "data": [
    {
      "id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
      "model": "gpt-4o-mini-2024-07-18",
      "created": 1738193475,
      "request_id": "e539c139-a97d-4ee1-bde9-3be3d5c6edb5",
      "usage": {
        "total_tokens": 25,
        "completion_tokens": 7,
        "prompt_tokens": 18
      },
      "seed": 123,
      "top_p": 1,
      "temperature": 1,
      "presence_penalty": 0,
      "frequency_penalty": 0,
      "system_fingerprint": "fp_f3927aa00d",
      "metadata": {
        "key_1": "val_1",
        "key_2": "val_2"
      },
      "choices": [
        {
          "index": 0,
          "message": {
            "content": "Hello, how are you?",
            "role": "assistant"
          },
          "finish_reason": "stop"
        }
      ]
    }
  ],
  "total": 1,
  "first_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
  "last_id": "chatcmpl-AvBCKqg2xqxVHCCEnUB4Bgj1Bjl7Y",
  "has_more": false
}

Definisi

Nama Deskripsi
Choice

Pilihan

ChoiceMessage

ChoiceMessage

Error

Kesalahan

ErrorCode

Kode Kesalahan

ErrorResponse

ErrorResponse

FunctionCallFunction

FunctionCallFunction

FunctionDefinition

FunctionDefinition

InnerError

InnerError

InnerErrorCode

InnerErrorCode

Logprob

Logprob

StoredCompletion

StoredCompletion

StoredCompletionList

StoredCompletionList

Tool

Alat

ToolCall

ToolCall

Usage

Penggunaan

Choice

Pilihan

Nama Jenis Deskripsi
finish_reason

string

Alasan model berhenti menghasilkan token.

index

integer (int32)

Indeks pilihan dalam daftar pilihan.

logprobs

<string,  Logprob>

Kamus'2
Catat informasi probabilitas untuk pilihan tersebut.

message

ChoiceMessage

ChoiceMessage

ChoiceMessage

ChoiceMessage

Nama Jenis Deskripsi
content

string

Isi pesan.

role

string

Peran entitas yang membuat pesan.

tool_calls

ToolCall[]

Daftar panggilan alat yang relevan.

Error

Kesalahan

Nama Jenis Deskripsi
code

ErrorCode

Kode Kesalahan
Kode kesalahan seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

details

Error[]

Detail kesalahan jika tersedia.

innererror

InnerError

InnerError
Kesalahan dalam seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

message

string

minLength: 1

Pesan kesalahan ini.

target

string

Lokasi tempat kesalahan terjadi jika tersedia.

ErrorCode

Kode Kesalahan

Nilai Deskripsi
conflict

Operasi yang diminta berkonflik dengan status sumber daya saat ini.

contentFilter

Pembuatan gambar gagal sebagai akibat dari sistem keamanan kami.

fileImportFailed

Impor file gagal.

forbidden

Operasi dilarang untuk kunci pengguna/api saat ini.

internalFailure

Kesalahan internal. Silakan coba lagi.

invalidPayload

Data permintaan tidak valid untuk operasi ini.

itemDoesAlreadyExist

Item sudah ada.

jsonlValidationFailed

Validasi data jsonl gagal.

notFound

Sumber daya tidak ditemukan.

quotaExceeded

Kuota terlampaui.

serviceUnavailable

Layanan saat ini tidak tersedia.

tooManyRequests

Terlalu banyak permintaan. Silakan coba lagi nanti.

unauthorized

Kunci pengguna/api saat ini tidak diotorisasi untuk operasi.

unexpectedEntityState

Operasi tidak dapat dijalankan dalam status sumber daya saat ini.

ErrorResponse

ErrorResponse

Nama Jenis Deskripsi
error

Error

Kesalahan
Konten kesalahan seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

FunctionCallFunction

FunctionCallFunction

Nama Jenis Deskripsi
arguments

string

Argumen yang diharapkan model untuk Anda teruskan ke fungsi .

name

string

Nama fungsi.

FunctionDefinition

FunctionDefinition

Nama Jenis Deskripsi
description

string

Deskripsi tentang apa yang dilakukan fungsi, digunakan oleh model untuk memilih kapan dan bagaimana memanggil fungsi.

name

string

Nama fungsi yang akan dipanggil.

parameters

Parameter yang diterima fungsi, dijelaskan sebagai objek Skema JSON.

InnerError

InnerError

Nama Jenis Deskripsi
code

InnerErrorCode

InnerErrorCode
Kode kesalahan dalam seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

innererror

InnerError

InnerError
Kesalahan dalam seperti yang didefinisikan dalam panduan Microsoft REST (https://github.com/microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses).

InnerErrorCode

InnerErrorCode

Nilai Deskripsi
invalidPayload

Data permintaan tidak valid untuk operasi ini.

Logprob

Logprob

Nama Jenis Deskripsi
logprob

number (float)

Probabilitas log dari token ini, jika berada dalam 20 token teratas yang paling mungkin. Jika tidak, nilai -9999.0 digunakan untuk menandakan bahwa token sangat tidak mungkin.

token

string

Token.

StoredCompletion

StoredCompletion

Nama Jenis Deskripsi
choices

Choice[]

Daftar pilihan penyelesaian obrolan. Bisa lebih dari satu jika n lebih besar dari 1.

created

integer (int64)

Tanda waktu Unix (dalam detik) saat penyelesaian obrolan dibuat.

frequency_penalty

number (float)

Angka antara -2.0 dan 2.0. Nilai positif menghukus token baru berdasarkan frekuensi yang ada dalam teks sejauh ini, mengurangi kemungkinan model untuk mengulangi verbatim baris yang sama.

id

string

Identitas penyelesaian tersimpan.

input_user

string

Pengguna input untuk permintaan ini.

metadata

object

Kamus'2
Pasangan kunci-nilai arbitrer untuk informasi tambahan.

model

string

ID model yang akan digunakan.

presence_penalty

number (float)

Angka antara -2.0 dan 2.0. Nilai positif menghukus token baru berdasarkan apakah token tersebut muncul dalam teks sejauh ini, meningkatkan kemungkinan model untuk berbicara tentang topik baru.

request_id

string

Pengidentifikasi unik untuk permintaan OpenAI API. Sertakan ID permintaan ini saat menghubungi dukungan.

seed

integer (int64)

Jika ditentukan, sistem kami akan melakukan upaya terbaik untuk sampel secara deterministik, sehingga permintaan berulang dengan seed dan parameter yang sama harus mengembalikan hasil yang sama.

Determinisme tidak dijamin, dan Anda harus merujuk ke parameter respons system_fingerprint untuk memantau perubahan di backend.

service_tier

string

Menentukan tingkat latensi yang akan digunakan untuk memproses permintaan.

system_fingerprint

string

Sidik jari ini mewakili konfigurasi backend yang dijalankan model.

Dapat digunakan bersama dengan parameter permintaan seed untuk memahami kapan perubahan backend telah dilakukan yang mungkin berdampak pada determinisme.

temperature

number (float)

Suhu pengambilan sampel apa yang akan digunakan, antara 0 dan 2. Nilai yang lebih tinggi seperti 0,8 akan membuat output lebih acak, sementara nilai yang lebih rendah seperti 0,2 akan membuatnya lebih fokus dan deterministik.

Kami umumnya merekomendasikan untuk mengubah ini atau top_p tetapi tidak keduanya.

tool_choice

string

Mengontrol alat mana (jika ada) yang dipanggil oleh model.

tools

Tool[]

Daftar alat yang mungkin dipanggil model. Saat ini, hanya fungsi yang didukung sebagai alat. Gunakan ini untuk menyediakan daftar fungsi yang dapat dihasilkan model input JSON. Maksimal 128 fungsi didukung.

top_p

number (float)

Alternatif untuk pengambilan sampel dengan suhu, yang disebut pengambilan sampel nukleus, di mana model mempertimbangkan hasil token dengan massa probabilitas top_p. Jadi 0,1 berarti hanya token yang terdiri dari 10 besar% massa probabilitas yang dipertimbangkan.

Kami umumnya merekomendasikan untuk mengubah ini atau temperature tetapi tidak keduanya.

usage

Usage

Penggunaan

StoredCompletionList

StoredCompletionList

Nama Jenis Deskripsi
data

StoredCompletion[]

Daftar objek yang diambil.

first_id

string

Id pertama dalam list yang diambil

has_more

boolean

Properti has_more digunakan untuk penomoran halaman untuk menunjukkan ada hasil tambahan.

last_id

string

Id terakhir dalam list yang diambil

object

string

Jenis objek, yang selalu list

total

integer (int64)

Jumlah total item.

Tool

Alat

Nama Jenis Deskripsi
function

FunctionDefinition

FunctionDefinition

type

string

Jenis panggilan alat. Ini akan selalu function untuk jenis panggilan alat ini.

ToolCall

ToolCall

Nama Jenis Deskripsi
function

FunctionCallFunction

FunctionCallFunction

id

string

ID panggilan alat.

type

string

Jenis alat yang memanggil output diperlukan. Untuk saat ini, ini selalu function.

Usage

Penggunaan

Nama Jenis Deskripsi
completion_tokens

integer (int32)

Jumlah token dalam penyelesaian yang dihasilkan.

prompt_tokens

integer (int32)

Jumlah token dalam perintah.

total_tokens

integer (int32)

Jumlah total token yang digunakan dalam permintaan (prompt + completion).