Mengimpor Api Azure OpenAI sebagai REST API

BERLAKU UNTUK: semua tingkatan Manajemen API

Anda dapat mengimpor endpoint model AI yang disebarkan di Azure OpenAI dalam Model Foundry ke instans API Management Anda sebagai REST API. Gunakan kebijakan gateway AI dan kemampuan lain dalam API Management untuk menyederhanakan integrasi, meningkatkan pengamatan, dan meningkatkan kontrol atas titik akhir model.

Artikel ini memperlihatkan dua opsi untuk mengimpor Api Azure OpenAI ke instans Azure API Management sebagai REST API:

Pelajari selengkapnya tentang mengelola API LLM di API Management:

Prasyarat

  • Instans Manajemen API yang ada. Buat jika Anda belum melakukannya.

  • (Untuk impor dari Microsoft Foundry) Proyek Microsoft Foundry dengan model Azure OpenAI yang telah diterapkan. Untuk informasi selengkapnya tentang penyebaran model di Azure OpenAI, lihat panduan penyebaran sumber daya.

    Catat ID (nama) dari deployment tersebut. Anda memerlukannya saat menguji API yang diimpor di API Management.

  • Izin untuk memberikan akses ke sumber daya Azure OpenAI dari instance Manajemen API.

Pilihan 1. Mengimpor OpenAI API dari Microsoft Foundry

Anda dapat mengimpor penyebaran model Azure OpenAI langsung dari Microsoft Foundry ke API Management. Untuk detailnya, lihat Mengimpor MICROSOFT Foundry API.

Saat Anda mengimpor API:

  • Tentukan layanan Microsoft Foundry yang menghosting penyebaran model Azure OpenAI.
  • Tentukan opsi kompatibilitas klien Azure OpenAI . Opsi ini mengonfigurasi API Manajemen dengan titik akhir /openai.

Opsi 2. Menambahkan spesifikasi OpenAPI ke API Management

Atau, unduh spesifikasi OpenAPI secara manual untuk Azure OpenAI REST API dan tambahkan ke API Management sebagai API OpenAPI.

Unduh spesifikasi OpenAPI

Unduh spesifikasi OpenAPI untuk Azure OpenAI REST API, seperti versi GA 2024-10-21.

  1. Di editor teks, buka file spesifikasi yang Anda unduh.

  2. Dalam elemen servers dalam spesifikasi tersebut, gantilah nama titik akhir Azure OpenAI Anda pada nilai tempat penampung url dan default. Misalnya, jika titik akhir Azure OpenAI Anda adalah contoso.openai.azure.com, perbarui servers elemen dengan nilai berikut:

    • url: https://contoso.openai.azure.com/openai
    • default titik akhir:contoso.openai.azure.com
    [...]
"servers": [
    {
      "url": "https://contoso.openai.azure.com/openai",
      "variables": {
        "endpoint": {
          "default": "contoso.openai.azure.com"
        }
      }
    }
  ],
[...]

  3. Catat nilai dari API version dalam spesifikasi. Anda memerlukannya untuk menguji API. Contoh: 2024-10-21.

Tambahkan spesifikasi OpenAPI ke Manajemen API

  1. Di portal Microsoft Azure, buka instans API Management Anda.
  2. Di menu sebelah kiri, pilih API>+ Tambah API.
  3. Di bawah Tentukan API baru, pilih OpenAPI. Masukkan Nama tampilan dan Nama untuk API.
  4. Masukkan sebuah suffix URL API yang diakhiri dengan /openai untuk mengakses endpoint API Azure OpenAI dalam instance Manajemen API Anda. Misalnya: my-openai-api/openai.
  5. Pilih Buat.

API Management mengimpor API dan menampilkan operasi dari spesifikasi OpenAPI.

Mengonfigurasi autentikasi ke Azure OpenAI API

Untuk mengautentikasi ke Azure OpenAI API, berikan kunci API atau gunakan identitas terkelola. Jika Anda mengimpor Azure OpenAI API langsung dari Microsoft Foundry, autentikasi dengan menggunakan identitas terkelola instans API Management dikonfigurasi secara otomatis.

Jika Anda menambahkan Azure OpenAI API dari spesifikasi OpenAPI-nya, Anda perlu mengonfigurasi autentikasi. Untuk informasi selengkapnya tentang mengonfigurasi autentikasi dengan menggunakan kebijakan API Management, lihat Mengautentikasi dan mengotorisasi KE API LLM.

Menguji Api Azure OpenAI

Untuk memastikan Api Azure OpenAI Anda berfungsi seperti yang diharapkan, uji di konsol pengujian API Management. Anda perlu memberikan ID penyebaran model (nama) yang Anda konfigurasikan di sumber daya proyek Microsoft Foundry dan versi API untuk menguji API.

  1. Pilih API yang Anda buat pada langkah sebelumnya.

  2. Pilih tab Test.

  3. Pilih operasi yang kompatibel dengan model yang Anda terapkan di sumber daya Azure OpenAI. Halaman menampilkan bidang untuk parameter dan header.

  4. Di Template parameters, masukkan nilai berikut:

    • deployment-id - ID penyebaran model Azure OpenAI di Microsoft Foundry
    • api-version - versi API Azure OpenAI yang valid, seperti versi API yang Anda pilih saat mengimpor API. Cuplikan layar pengujian Azure OpenAI API di portal.

  5. Masukkan parameter dan header lain sesuai kebutuhan. Bergantung pada operasi dan model, Anda mungkin perlu mengonfigurasi atau memperbarui isi Permintaan. Misalnya, berikut adalah isi permintaan dasar untuk operasi penyelesaian obrolan:

    {
  "model": "any",
  "messages": [
    {
      "role": "user",
      "content": "Help me plan a vacation trip to Paris."
    }
  ],
  "max_tokens": 100
}

    Catatan

    Di konsol pengujian, API Management secara otomatis menambahkan header Ocp-Apim-Subscription-Key dan mengatur kunci langganan untuk langganan semua akses bawaan. Kunci ini menyediakan akses ke setiap API dalam instans API Management. Untuk menampilkan header Ocp-Apim-Subscription-Key secara opsional, pilih ikon "mata" di samping Permintaan HTTP.

  6. Pilih Kirim.

    Ketika pengujian berhasil, backend merespons dengan kode respons HTTP yang berhasil dan beberapa data. Responsnya mencakup data penggunaan token untuk membantu Anda memantau dan mengelola konsumsi token Azure OpenAI API Anda.

    Tangkapan layar data penggunaan token dalam respons API di portal.

Konten terkait

  • Last updated on