Bagikan melalui

Mengimpor API Azure OpenAI

  • Artikel

BERLAKU UNTUK: Semua tingkatAN API Management

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

Prasyarat

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

  • Akses yang diberikan ke Azure OpenAI dalam langganan Azure yang diinginkan. Anda dapat mengajukan permohonan akses ke Azure OpenAI dengan melengkapi formulir di https://aka.ms/oai/access. Buka masalah pada repositori ini untuk menghubungi kami jika Anda mengalami masalah.

  • Sumber daya Azure OpenAI dengan model yang disebarkan. Untuk informasi selengkapnya tentang penyebaran model, lihat panduan penyebaran sumber daya.

    Catat ID (nama) penyebaran. Anda akan membutuhkannya saat menguji API yang diimpor di API Management.

  • Izin untuk memberikan akses ke sumber daya Azure OpenAI dari instans API Management.

Opsi 1. Mengimpor API dari Layanan Azure OpenAI

Anda dapat mengimpor Api Azure OpenAI langsung ke API Management dari Layanan Azure OpenAI. Saat Anda mengimpor API, API Management secara otomatis mengonfigurasi:

  • Operasi untuk setiap titik akhir Azure OpenAI REST API.
  • Identitas yang ditetapkan sistem dengan izin yang diperlukan untuk mengakses sumber daya Azure OpenAI.
  • Sumber daya backend dan kebijakan layanan set-backend yang mengarahkan permintaan API ke titik akhir Azure OpenAI Service.
  • Kebijakan identitas terkelola autentikasi yang dapat mengautentikasi ke sumber daya Azure OpenAI menggunakan identitas yang ditetapkan sistem instans.
  • (opsional) Kebijakan untuk membantu Anda memantau dan mengelola konsumsi token oleh Azure OpenAI API.

Untuk mengimpor Api Azure OpenAI ke API Management:

  1. Di Portal Microsoft Azure, navigasikan ke instans API Management Anda.

  2. Di menu sebelah kiri, di bawah API, pilih API>+ Tambahkan API.

  3. Di bawah Buat dari sumber daya Azure, pilih Azure OpenAI Service.

    Cuplikan layar membuat API dari Azure OpenAI Service di portal.

  4. Pada tab Dasar:

    1. Pilih sumber daya Azure OpenAI yang ingin Anda impor.

    2. Secara opsional pilih versi Azure OpenAI API. Jika Anda tidak memilihnya, versi REST API siap produksi terbaru digunakan secara default.

    3. Masukkan Nama tampilan dan Deskripsi opsional untuk API.

    4. Di URL Dasar, tambahkan jalur yang digunakan instans API Management Anda untuk mengakses titik akhir API Azure OpenAI. Jika Anda mengaktifkan Pastikan kompatibilitas OpenAI SDK (disarankan), /openai secara otomatis ditambahkan ke URL dasar.

      Misalnya, jika titik akhir gateway API Management Anda adalah https://contoso.azure-api.net, atur URL Dasar yang mirip https://contoso.azure-api.net/my-openai-api/openaidengan .

    5. Secara opsional pilih satu atau beberapa produk untuk dikaitkan dengan API. Pilih Selanjutnya.

  5. Pada tab Kebijakan , secara opsional mengaktifkan kebijakan untuk memantau dan mengelola konsumsi token Azure OpenAI API. Jika dipilih, masukkan pengaturan atau terima default yang menentukan azure-openai-token-limit kebijakan dan azure-openai-emit-token-metric untuk API Anda. Anda juga dapat mengatur atau memperbarui konfigurasi kebijakan nanti. Pilih Tinjau + Buat.

  6. Setelah pengaturan divalidasi, pilih Buat.

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-02-01.

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

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

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

  3. Catat nilai API version dalam spesifikasi. Anda akan memerlukannya untuk menguji API. Contoh: 2024-02-01.

Menambahkan spesifikasi OpenAPI ke API Management

  1. Di Portal Microsoft Azure, navigasikan ke instans API Management Anda.
  2. Di menu sebelah kiri, pilih API>+ Tambahkan API.
  3. Di bawah Tentukan API baru, pilih OpenAPI. Masukkan Nama tampilan dan Nama untuk API.
  4. Masukkan akhiran URL API yang berakhiran /openai untuk mengakses titik akhir API Azure OpenAI di instans API Management Anda. Contoh: my-openai-api/openai.
  5. Pilih Buat.

API diimpor dan menampilkan operasi dari spesifikasi OpenAPI.

Mengonfigurasi autentikasi ke Azure OpenAI API

Untuk mengautentikasi ke Azure OpenAI API, Anda menyediakan kunci API atau identitas terkelola. Jika Anda mengimpor Api Azure OpenAI langsung ke instans API Management Anda, autentikasi 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 menggunakan kebijakan API Management, lihat Mengautentikasi dan mengotorisasi ke Azure OpenAI API.

Menguji Api Azure OpenAI

Untuk memastikan bahwa Azure OpenAI API Anda berfungsi seperti yang diharapkan, uji di konsol pengujian API Management. Anda perlu menyediakan ID penyebaran model (nama) yang dikonfigurasi di sumber daya Azure OpenAI untuk menguji API.

  1. Memilih API yang Anda buat di langkah sebelumnya.

  2. Pilih tab Uji.

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

  4. Di Parameter templat, masukkan nilai berikut:

    • deployment-id - ID penyebaran di layanan Azure OpenAI
    • api-version - versi Api Azure OpenAI yang valid, seperti versi API yang Anda pilih saat mengimpor API. Cuplikan layar pengujian AZURE OpenAI Service API di portal.

  5. Masukkan parameter dan header lain sesuai kebutuhan. Bergantung pada operasi, Anda mungkin perlu mengonfigurasi atau memperbarui isi Permintaan.

    Catatan

    Di konsol pengujian, API Management secara otomatis mengisi header Ocp-Apim-Subscription-Key, dan mengonfigurasi kunci langganan langganan semua akses bawaan. Kunci ini memungkinkan akses ke setiap API dalam instans API Management. Secara opsional tampilkan header Ocp-Apim-Subscription-Key dengan memilih ikon "mata" di samping Permintaan HTTP.

  6. Pilih Kirim.

    Ketika pengujian berhasil, backend merespons dengan kode respons HTTP yang berhasil dan beberapa data. Ditambahkan ke respons adalah data penggunaan token untuk membantu Anda memantau dan mengelola konsumsi Api Azure OpenAI Anda. Cuplikan layar data penggunaan token dalam respons API di portal.

Kebijakan penembolokan untuk API Azure OpenAI

Selain azure-openai-token-limit kebijakan dan azure-openai-emit-token-metric yang dapat Anda konfigurasi saat mengimpor AZURE OpenAI Service API, API Management menyediakan kebijakan penembolokan berikut untuk membantu Anda mengoptimalkan performa dan mengurangi latensi untuk API Azure OpenAI:

  • azure-openai-semantic-cache-store
  • azure-openai-semantic-cache-lookup

Konten terkait