@azure-rest/ai-inference package
Antarmuka
| ChatChoiceOutput |
Representasi penyelesaian permintaan tunggal sebagai bagian dari permintaan penyelesaian obrolan secara keseluruhan.
Umumnya, pilihan |
| ChatCompletionsNamedToolChoice |
Pilihan alat dari alat fungsi bernama tertentu yang akan membatasi penyelesaian obrolan untuk menggunakan fungsi bernama. |
| ChatCompletionsNamedToolChoiceFunction |
Pilihan alat dari alat fungsi bernama tertentu yang akan membatasi penyelesaian obrolan untuk menggunakan fungsi bernama. |
| ChatCompletionsOutput |
Representasi data respons dari permintaan penyelesaian obrolan. Penyelesaian mendukung berbagai tugas dan menghasilkan teks yang berlanjut dari atau "menyelesaikan" data permintaan yang disediakan. |
| ChatCompletionsResponseFormatJsonObject |
Format respons untuk Penyelesaian Obrolan yang membatasi respons untuk memancarkan objek JSON yang valid. Perhatikan bahwa untuk mengaktifkan mode JSON, beberapa model AI mungkin juga mengharuskan Anda menginstruksikan model untuk menghasilkan JSON melalui sistem atau pesan pengguna. |
| ChatCompletionsResponseFormatJsonSchema |
Format respons untuk Penyelesaian Obrolan yang membatasi respons untuk memancarkan objek JSON yang valid, dengan skema JSON yang ditentukan oleh pemanggil. |
| ChatCompletionsResponseFormatJsonSchemaDefinition |
Menentukan format respons untuk penyelesaian obrolan sebagai JSON dengan skema tertentu. Model AI harus mematuhi skema ini saat menghasilkan penyelesaian. |
| ChatCompletionsResponseFormatParent |
Mewakili format yang harus dihasilkan model. Gunakan ini untuk mengaktifkan mode JSON alih-alih mode teks default. Perhatikan bahwa untuk mengaktifkan mode JSON, beberapa model AI mungkin juga mengharuskan Anda menginstruksikan model untuk menghasilkan JSON melalui sistem atau pesan pengguna. |
| ChatCompletionsResponseFormatText |
Format respons untuk Penyelesaian Obrolan yang memancarkan respons teks. Ini adalah format respons default. |
| ChatCompletionsToolCall |
Panggilan alat fungsi yang diminta oleh model AI. |
| ChatCompletionsToolCallOutput |
Panggilan alat fungsi yang diminta oleh model AI. |
| ChatCompletionsToolDefinition |
Definisi alat penyelesaian obrolan yang dapat memanggil fungsi. |
| ChatMessageAudioDataContentItem |
Item konten obrolan terstruktur untuk konten audio yang diteruskan sebagai data yang dikodekan base64. |
| ChatMessageAudioUrlContentItem |
Item konten obrolan terstruktur untuk konten audio yang diteruskan sebagai url. |
| ChatMessageContentItemParent |
Representasi abstrak dari item konten terstruktur dalam pesan obrolan. |
| ChatMessageImageContentItem |
Item konten obrolan terstruktur yang berisi referensi gambar. |
| ChatMessageImageUrl |
Lokasi internet tempat model dapat mengambil gambar. |
| ChatMessageInputAudio |
Detail data audio input. |
| ChatMessageInputAudioUrl |
Detail url audio. |
| ChatMessageTextContentItem |
Item konten obrolan terstruktur yang berisi teks biasa. |
| ChatRequestAssistantMessage |
Pesan obrolan permintaan yang mewakili respons atau tindakan dari asisten. |
| ChatRequestDeveloperMessage |
Pesan obrolan permintaan yang berisi instruksi pengembang yang memengaruhi bagaimana model akan menghasilkan respons penyelesaian obrolan. Beberapa model AI mendukung pesan pengembang alih-alih pesan sistem. |
| ChatRequestMessageParent |
Representasi abstrak pesan obrolan seperti yang disediakan dalam permintaan. |
| ChatRequestSystemMessage |
Pesan obrolan permintaan yang berisi instruksi sistem yang memengaruhi bagaimana model akan menghasilkan respons penyelesaian obrolan. |
| ChatRequestToolMessage |
Pesan obrolan permintaan yang mewakili output yang diminta dari alat yang dikonfigurasi. |
| ChatRequestUserMessage |
Pesan obrolan permintaan yang mewakili input pengguna ke asisten. |
| ChatResponseMessageOutput |
Representasi pesan obrolan seperti yang diterima sebagai respons. |
| CompletionsUsageOutput |
Representasi jumlah token yang diproses untuk permintaan penyelesaian. Hitungan mempertimbangkan semua token di seluruh perintah, pilihan, pilihan alternatif, generasi best_of, dan konsumen lainnya. |
| EmbeddingItemOutput |
Representasi perbandingan keterkaitan penyematan tunggal. |
| EmbeddingsResultOutput |
Representasi data respons dari permintaan penyematan. Penyematan mengukur keterkaitan string teks dan umumnya digunakan untuk pencarian, pengklusteran, rekomendasi, dan skenario serupa lainnya. |
| EmbeddingsUsageOutput |
Pengukuran jumlah token yang digunakan dalam permintaan dan respons ini. |
| ErrorModel |
Objek kesalahan. |
| FunctionCall |
Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model. |
| FunctionCallOutput |
Nama dan argumen fungsi yang harus dipanggil, seperti yang dihasilkan oleh model. |
| FunctionDefinition |
Definisi fungsi yang ditentukan pemanggil yang dapat dipanggil penyelesaian obrolan sebagai respons terhadap input pengguna yang cocok. |
| GetChatCompletions | |
| GetChatCompletions200Response |
Permintaan telah berhasil. |
| GetChatCompletionsBodyParam | |
| GetChatCompletionsDefaultHeaders | |
| GetChatCompletionsDefaultResponse | |
| GetChatCompletionsHeaderParam | |
| GetChatCompletionsHeaders | |
| GetEmbeddings | |
| GetEmbeddings200Response |
Permintaan telah berhasil. |
| GetEmbeddingsBodyParam | |
| GetEmbeddingsDefaultHeaders | |
| GetEmbeddingsDefaultResponse | |
| GetEmbeddingsHeaderParam | |
| GetEmbeddingsHeaders | |
| GetImageEmbeddings | |
| GetImageEmbeddings200Response |
Permintaan telah berhasil. |
| GetImageEmbeddingsBodyParam | |
| GetImageEmbeddingsDefaultHeaders | |
| GetImageEmbeddingsDefaultResponse | |
| GetImageEmbeddingsHeaderParam | |
| GetImageEmbeddingsHeaders | |
| GetModelInfo | |
| GetModelInfo200Response |
Permintaan telah berhasil. |
| GetModelInfoDefaultHeaders | |
| GetModelInfoDefaultResponse | |
| ImageEmbeddingInput |
Mewakili gambar dengan teks opsional. |
| ModelClientOptions |
Parameter opsional untuk klien |
| ModelInfoOutput |
Mewakili beberapa informasi dasar tentang model AI. |
| Routes | |
Alias Jenis
| AudioContentFormat |
Alias untuk AudioContentFormat |
| ChatCompletionsResponseFormat |
Mewakili format yang harus dihasilkan model. Gunakan ini untuk mengaktifkan mode JSON alih-alih mode teks default. Perhatikan bahwa untuk mengaktifkan mode JSON, beberapa model AI mungkin juga mengharuskan Anda menginstruksikan model untuk menghasilkan JSON melalui sistem atau pesan pengguna. |
| ChatCompletionsToolChoicePreset |
Alias untuk ChatCompletionsToolChoicePreset |
| ChatMessageContentItem |
Representasi abstrak dari item konten terstruktur dalam pesan obrolan. |
| ChatMessageImageDetailLevel |
Alias untuk ChatMessageImageDetailLevel |
| ChatRequestMessage |
Representasi abstrak pesan obrolan seperti yang disediakan dalam permintaan. |
| ChatRole |
Alias untuk ChatRole |
| ChatRoleOutput |
Alias untuk ChatRoleOutput |
| CompletionsFinishReasonOutput |
Alias untuk CompletionsFinishReasonOutput |
| EmbeddingEncodingFormat |
Alias untuk EmbeddingEncodingFormat |
| EmbeddingInputType |
Alias untuk EmbeddingInputType |
| ExtraParameters |
Alias untuk ExtraParameters |
| GetChatCompletionsParameters | |
| GetEmbeddingsParameters | |
| GetImageEmbeddingsParameters | |
| GetModelInfoParameters | |
| ModelClient | |
| ModelTypeOutput |
Alias untuk ModelTypeOutput |
Fungsi
Detail Fungsi
default(string, TokenCredential | KeyCredential, ModelClientOptions)
Menginisialisasi instans baru ModelClient
function default(endpointParam: string, credentials: TokenCredential | KeyCredential, options?: ModelClientOptions): ModelClient
Parameter
- endpointParam
-
string
Parameter endpointParam
- credentials
mengidentifikasi kredensial klien secara unik
- options
- ModelClientOptions
parameter untuk semua parameter opsional
Mengembalikan
isUnexpected(GetChatCompletions200Response | GetChatCompletionsDefaultResponse)
function isUnexpected(response: GetChatCompletions200Response | GetChatCompletionsDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetModelInfo200Response | GetModelInfoDefaultResponse)
function isUnexpected(response: GetModelInfo200Response | GetModelInfoDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetEmbeddings200Response | GetEmbeddingsDefaultResponse)
function isUnexpected(response: GetEmbeddings200Response | GetEmbeddingsDefaultResponse): response
Parameter
Mengembalikan
response
isUnexpected(GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse)
function isUnexpected(response: GetImageEmbeddings200Response | GetImageEmbeddingsDefaultResponse): response
Parameter
Mengembalikan
response