@azure/openai package
Kelas
AzureKeyCredential |
Kredensial berbasis kunci statis yang mendukung pembaruan nilai kunci yang mendasar. |
OpenAIClient |
Klien untuk berinteraksi dengan Azure OpenAI. Klien memerlukan titik akhir sumber daya OpenAI dan metode autentikasi seperti kunci API atau token. Kunci API dan titik akhir dapat ditemukan di halaman sumber daya OpenAI. Mereka akan terletak di halaman Kunci dan Titik Akhir sumber daya. Contoh untuk autentikasi:Kunci API
Azure Active Directory
|
OpenAIKeyCredential |
Kelas OpenAIKeyCredential mewakili kunci OPENAI API dan digunakan untuk mengautentikasi ke klien OpenAI untuk titik akhir OpenAI. |
Antarmuka
AudioResultSimpleJson |
Respons transkripsi sederhana |
AudioResultVerboseJson |
Respons transkripsi. |
AudioSegment |
Segmen transkripsi. |
AzureChatEnhancementConfiguration |
Representasi konfigurasi peningkatan Azure OpenAI yang tersedia. |
AzureChatEnhancements |
Mewakili hasil output penyempurnaan Azure untuk penyelesaian obrolan, seperti yang dikonfigurasi melalui input yang cocok yang disediakan dalam permintaan. |
AzureChatExtensionConfiguration |
Representasi data konfigurasi untuk satu ekstensi obrolan Azure OpenAI. Ini akan digunakan oleh permintaan penyelesaian obrolan yang harus menggunakan ekstensi obrolan Azure OpenAI untuk menambah perilaku respons. Penggunaan konfigurasi ini hanya kompatibel dengan Azure OpenAI. |
AzureChatExtensionDataSourceResponseCitation |
Satu instans informasi konteks tambahan yang tersedia saat ekstensi obrolan Azure OpenAI terlibat dalam pembuatan respons penyelesaian obrolan yang sesuai. Informasi konteks ini hanya diisi saat menggunakan permintaan Azure OpenAI yang dikonfigurasi untuk menggunakan ekstensi yang cocok. |
AzureChatExtensionsMessageContext |
Representasi informasi konteks tambahan yang tersedia saat ekstensi obrolan Azure OpenAI terlibat dalam pembuatan respons penyelesaian obrolan yang sesuai. Informasi konteks ini hanya diisi saat menggunakan permintaan Azure OpenAI yang dikonfigurasi untuk menggunakan ekstensi yang cocok. |
AzureChatGroundingEnhancementConfiguration |
Representasi opsi yang tersedia untuk peningkatan grounding Azure OpenAI. |
AzureChatOCREnhancementConfiguration |
Representasi opsi yang tersedia untuk peningkatan pengenalan karakter optik (OCR) Azure OpenAI. |
AzureCosmosDBChatExtensionConfiguration |
Representasi spesifik dari opsi yang dapat dikonfigurasi untuk Azure Cosmos DB saat menggunakannya sebagai ekstensi obrolan Azure OpenAI. |
AzureCosmosDBFieldMappingOptions |
Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Cosmos DB yang dikonfigurasi. |
AzureExtensionsOptions |
Opsi untuk ekstensi obrolan Azure OpenAI. |
AzureGroundingEnhancement |
Peningkatan grounding yang mengembalikan kotak pembatas objek yang terdeteksi dalam gambar. |
AzureGroundingEnhancementCoordinatePoint |
Representasi dari satu titik poligon seperti yang digunakan oleh peningkatan grounding Azure. |
AzureGroundingEnhancementLine |
Objek baris konten yang terdiri dari urutan elemen konten yang berdekatan, seperti kata dan tanda pilihan. |
AzureGroundingEnhancementLineSpan |
Objek rentang yang mewakili objek yang terdeteksi dan informasi kotak pembatasnya. |
AzureMachineLearningIndexChatExtensionConfiguration |
Representasi spesifik opsi yang dapat dikonfigurasi untuk indeks vektor Azure Machine Learning saat menggunakannya sebagai ekstensi obrolan Azure OpenAI. |
AzureSearchChatExtensionConfiguration |
Representasi spesifik opsi yang dapat dikonfigurasi untuk Azure Search saat menggunakannya sebagai ekstensi obrolan Azure OpenAI. |
AzureSearchIndexFieldMappingOptions |
Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Azure Search yang dikonfigurasi. |
ChatChoice |
Representasi penyelesaian permintaan tunggal sebagai bagian dari permintaan penyelesaian obrolan secara keseluruhan.
Umumnya, |
ChatChoiceLogProbabilityInfo |
Catat informasi probabilitas untuk pilihan, seperti yang diminta melalui 'logprobs' dan 'top_logprobs'. |
ChatCompletions |
Representasi data respons dari permintaan penyelesaian obrolan. Penyelesaian mendukung berbagai tugas dan menghasilkan teks yang berlanjut dari atau "menyelesaikan" data permintaan yang disediakan. |
ChatCompletionsFunctionToolCall |
Panggilan alat ke alat fungsi, yang dikeluarkan oleh model dalam evaluasi alat fungsi yang dikonfigurasi, yang mewakili pemanggilan fungsi yang diperlukan untuk permintaan penyelesaian obrolan berikutnya untuk diselesaikan. |
ChatCompletionsFunctionToolDefinition |
Informasi definisi untuk alat fungsi penyelesaian obrolan yang dapat memanggil fungsi sebagai respons terhadap panggilan alat. |
ChatCompletionsFunctionToolSelection |
Pemilihan alat dari alat fungsi bernama tertentu yang akan membatasi penyelesaian obrolan untuk menggunakan fungsi bernama. |
ChatCompletionsJsonResponseFormat |
Format respons untuk Penyelesaian Obrolan yang membatasi respons untuk memancarkan objek JSON yang valid. |
ChatCompletionsNamedFunctionToolSelection |
Pemilihan alat dari alat fungsi bernama tertentu yang akan membatasi penyelesaian obrolan untuk menggunakan fungsi bernama. |
ChatCompletionsNamedToolSelection |
Representasi abstrak dari pilihan alat bernama eksplisit yang digunakan untuk permintaan penyelesaian obrolan. |
ChatCompletionsResponseFormat |
Representasi abstrak dari konfigurasi format respons yang dapat digunakan oleh Penyelesaian Obrolan. Dapat digunakan untuk mengaktifkan mode JSON. |
ChatCompletionsTextResponseFormat |
Format respons Penyelesaian Obrolan standar yang dapat secara bebas menghasilkan teks dan tidak dijamin menghasilkan konten respons yang mematuhi skema tertentu. |
ChatCompletionsToolCall |
Representasi abstrak dari panggilan alat yang harus diselesaikan dalam permintaan berikutnya untuk melakukan penyelesaian obrolan yang diminta. |
ChatCompletionsToolDefinition |
Representasi abstrak alat yang dapat digunakan oleh model untuk meningkatkan respons penyelesaian obrolan. |
ChatFinishDetails |
Representasi abstrak dari informasi terstruktur tentang mengapa respons penyelesaian obrolan dihentikan. |
ChatMessageContentItem |
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. |
ChatMessageTextContentItem |
Item konten obrolan terstruktur yang berisi teks biasa. |
ChatRequestAssistantMessage |
Pesan obrolan permintaan yang mewakili respons atau tindakan dari asisten. |
ChatRequestFunctionMessage |
Pesan obrolan permintaan yang mewakili output yang diminta dari fungsi yang dikonfigurasi. |
ChatRequestMessage |
Representasi abstrak dari 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. |
ChatResponseMessage |
Representasi pesan obrolan seperti yang diterima dalam respons. |
ChatTokenLogProbabilityInfo |
Representasi informasi probabilitas log untuk satu token konten pesan. |
ChatTokenLogProbabilityResult |
Representasi informasi probabilitas log untuk satu token konten, termasuk daftar token yang paling mungkin jika 'top_logprobs' diminta. |
Choice |
Representasi penyelesaian permintaan tunggal sebagai bagian dari permintaan penyelesaian keseluruhan.
Umumnya, |
Completions |
Representasi data respons dari permintaan penyelesaian. Penyelesaian mendukung berbagai tugas dan menghasilkan teks yang berlanjut dari atau "menyelesaikan" data permintaan yang disediakan. |
CompletionsLogProbabilityModel |
Representasi model probabilitas log untuk pembuatan penyelesaian. |
CompletionsUsage |
Representasi jumlah token yang diproses untuk permintaan penyelesaian. Hitungan mempertimbangkan semua token di seluruh perintah, pilihan, pilihan alternatif, generasi best_of, dan konsumen lainnya. |
ContentFilterBlocklistIdResult |
Mewakili hasil evaluasi terhadap daftar blokir kustom seperti yang dilakukan oleh pemfilteran konten. |
ContentFilterCitedDetectionResult |
Mewakili hasil operasi deteksi terhadap sumber daya yang dilindungi seperti yang dilakukan oleh pemfilteran konten. |
ContentFilterDetectionResult |
Mewakili hasil operasi deteksi yang dilakukan oleh pemfilteran konten. |
ContentFilterErrorResults |
Informasi tentang hasil kesalahan pemfilteran konten. |
ContentFilterResult |
Informasi tentang tingkat keparahan konten yang difilter dan apakah telah difilter atau belum. |
ContentFilterResultsForPrompt |
Hasil pemfilteran konten untuk satu permintaan dalam permintaan. |
ContentFilterSuccessResultDetailsForPrompt |
Informasi tentang hasil keberhasilan pemfilteran konten. |
ContentFilterSuccessResultsForChoice |
Informasi tentang pemfilteran konten yang dievaluasi terhadap output model yang dihasilkan. |
ElasticsearchChatExtensionConfiguration |
Representasi spesifik dari opsi yang dapat dikonfigurasi untuk Elasticsearch saat menggunakannya sebagai ekstensi obrolan Azure OpenAI. |
ElasticsearchIndexFieldMappingOptions |
Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Elasticsearch® yang dikonfigurasi. |
EmbeddingItem |
Representasi dari perbandingan keterkaitan penyematan tunggal. |
Embeddings |
Representasi data respons dari permintaan penyematan. Penyematan mengukur keterkaitan string teks dan umumnya digunakan untuk pencarian, pengklusteran, rekomendasi, dan skenario serupa lainnya. |
EmbeddingsUsage |
Pengukuran jumlah token yang digunakan dalam permintaan dan respons ini. |
EventStream |
Aliran yang dapat dibaca yang dapat diulang dan sekali pakai. |
FunctionCall |
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. |
FunctionName |
Struktur yang menentukan nama yang tepat dari fungsi tertentu yang disediakan permintaan untuk digunakan saat memproses operasi penyelesaian obrolan. |
GetAudioTranscriptionOptions |
Opsi untuk permintaan transkripsi audio |
GetAudioTranslationOptions |
Opsi untuk permintaan terjemahan audio |
GetChatCompletionsOptions |
Modul ini berisi model yang ingin kita jalankan berdampingan dengan model yang dihasilkan yang sesuai. Ini berguna untuk menyediakan model yang menghadap pelanggan yang memiliki nama/jenis yang berbeda dari model yang dihasilkan. |
GetCompletionsOptions |
Informasi konfigurasi untuk permintaan penyelesaian. Penyelesaian mendukung berbagai tugas dan menghasilkan teks yang berlanjut dari atau "menyelesaikan" data prompt yang disediakan. |
GetEmbeddingsOptions |
Opsi untuk permintaan penyematan kustom |
GetImagesOptions |
Mewakili data permintaan yang digunakan untuk menghasilkan gambar. |
ImageGenerationContentFilterResults |
Menjelaskan hasil pemfilteran konten untuk permintaan pembuatan gambar. |
ImageGenerationData |
Representasi dari satu gambar yang dihasilkan, disediakan sebagai data yang dikodekan base64 atau sebagai URL tempat gambar dapat diambil. |
ImageGenerationPromptFilterResults |
Menjelaskan hasil pemfilteran konten untuk permintaan pembuatan gambar. |
ImageGenerations |
Hasil dari operasi pembuatan gambar yang berhasil. |
MaxTokensFinishDetails |
Representasi terstruktur dari alasan berhenti yang menandakan batas token tercapai sebelum model dapat selesai secara alami. |
OnYourDataAccessTokenAuthenticationOptions |
Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan token akses. |
OnYourDataApiKeyAuthenticationOptions |
Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci API. |
OnYourDataAuthenticationOptions |
Opsi autentikasi untuk Azure OpenAI On Your Data. |
OnYourDataConnectionStringAuthenticationOptions |
Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan string koneksi. |
OnYourDataDeploymentNameVectorizationSource |
Detail sumber vektorisasi, digunakan oleh Azure OpenAI On Your Data saat menerapkan pencarian vektor, yang didasarkan pada nama penyebaran model penyematan internal di sumber daya Azure OpenAI yang sama. |
OnYourDataEncodedApiKeyAuthenticationOptions |
Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci API yang dikodekan Elasticsearch. |
OnYourDataEndpointVectorizationSource |
Detail sumber vektorisasi, digunakan oleh Azure OpenAI On Your Data saat menerapkan pencarian vektor, yang didasarkan pada panggilan titik akhir Azure OpenAI publik untuk penyematan. |
OnYourDataKeyAndKeyIdAuthenticationOptions |
Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan kunci Elasticsearch dan pasangan ID kunci. |
OnYourDataModelIdVectorizationSource |
Detail sumber vektorisasi, yang digunakan oleh Azure OpenAI On Your Data saat menerapkan pencarian vektor, yang didasarkan pada ID model layanan pencarian. Saat ini hanya didukung oleh Elasticsearch®. |
OnYourDataSystemAssignedManagedIdentityAuthenticationOptions |
Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan identitas terkelola yang ditetapkan sistem. |
OnYourDataUserAssignedManagedIdentityAuthenticationOptions |
Opsi autentikasi untuk Azure OpenAI On Your Data saat menggunakan identitas terkelola yang ditetapkan pengguna. |
OnYourDataVectorizationSource |
Representasi abstrak dari sumber vektorisasi untuk Azure OpenAI On Your Data dengan pencarian vektor. |
OpenAIClientOptions | |
PineconeChatExtensionConfiguration |
Representasi spesifik opsi yang dapat dikonfigurasi untuk Pinecone saat menggunakannya sebagai ekstensi obrolan Azure OpenAI. |
PineconeFieldMappingOptions |
Pengaturan opsional untuk mengontrol bagaimana bidang diproses saat menggunakan sumber daya Pinecone yang dikonfigurasi. |
StopFinishDetails |
Representasi terstruktur dari alasan berhenti yang menandakan penghentian alami oleh model. |
Alias Jenis
AudioResult |
Jenis hasil transkripsi berdasarkan format respons yang diminta |
AudioResultFormat |
Format hasil tugas audio |
AudioTranscriptionTask |
"transcribe", "translate" |
AzureChatExtensionConfigurationUnion |
Alias untuk AzureChatExtensionConfigurationUnion |
AzureChatExtensionType |
"azure_search", "azure_ml_index", "azure_cosmos_db", "elasticsearch", "pinecone" |
AzureSearchQueryType |
"sederhana", "semantik", "vektor", "vector_simple_hybrid", "vector_semantic_hybrid" |
ChatCompletionsNamedToolSelectionUnion |
Alias untuk ChatCompletionsNamedToolSelectionUnion |
ChatCompletionsResponseFormatUnion |
Alias untuk ChatCompletionsResponseFormatUnion |
ChatCompletionsToolCallUnion |
Alias untuk ChatCompletionsToolCallUnion |
ChatCompletionsToolDefinitionUnion |
Alias untuk ChatCompletionsToolDefinitionUnion |
ChatCompletionsToolSelectionPreset |
"auto", "none" |
ChatFinishDetailsUnion |
Alias untuk ChatFinishDetailsUnion |
ChatMessageContentItemUnion |
Alias untuk ChatMessageContentItemUnion |
ChatMessageImageDetailLevel |
"auto", "low", "high" |
ChatRequestMessageUnion |
Alias untuk ChatRequestMessageUnion |
ChatRole |
"system", "asisten", "user", "function", "tool" |
CompletionsFinishReason |
"stop", "length", "content_filter", "function_call", "tool_calls" |
ContentFilterResultDetailsForPrompt |
Informasi tentang kategori pemfilteran konten, jika telah terdeteksi. |
ContentFilterResultsForChoice |
Informasi tentang hasil pemfilteran konten, jika telah terdeteksi. |
ContentFilterSeverity |
"aman", "rendah", "sedang", "tinggi" |
ElasticsearchQueryType |
"sederhana", "vektor" |
FunctionCallPreset |
"auto", "none" |
ImageGenerationQuality |
"standard", "hd" |
ImageGenerationResponseFormat |
"url", "b64_json" |
ImageGenerationStyle |
"natural", "vivid" |
ImageSize |
"256x256", "512x512", "1024x1024", "1792x1024", "1024x1792" |
OnYourDataAuthenticationOptionsUnion |
Alias untuk OnYourDataAuthenticationOptionsUnion |
OnYourDataAuthenticationType |
"api_key", "connection_string", "key_and_key_id", "encoded_api_key", "access_token", "system_assigned_managed_identity", "user_assigned_managed_identity" |
OnYourDataVectorizationSourceType |
"endpoint", "deployment_name", "model_id" |
OnYourDataVectorizationSourceUnion |
Alias untuk OnYourDataVectorizationSourceUnion |
Azure SDK for JavaScript