Pustaka klien Azure AI Discovery untuk JavaScript - versi 1.0.0

Paket ini berisi SDK isomorfik (berjalan baik di Node.js maupun browser) untuk layanan Azure AI Discovery.

Perpustakaan ini menampilkan dua klien:

  • WorkspaceClient — bekerja dengan percakapan, investigasi, tugas, dan alat di workspace Discovery.
  • BookshelfClient — mengelola dan mencari basis pengetahuan di rak buku Discovery.

Setiap klien menargetkan endpoint layanannya sendiri.

Tautan kunci:

Memulai Langkah Pertama

Lingkungan yang didukung saat ini

Lihat kebijakan dukungan kami untuk detail selengkapnya.

Prasyarat

  • Sebuah langganan Azure.

Pasang paket @azure/ai-discovery

Instal pustaka klien Discovery untuk JavaScript dengan npm:

npm install @azure/ai-discovery

Buat dan autentikasi klien

Untuk membuat objek klien, Anda memerlukan layanan endpoint dan .credential Klien Azure AI Discovery menggunakan kredensial Microsoft Entra untuk autentikasi. WorkspaceClient dan BookshelfClient masing-masing menargetkan endpoint mereka sendiri, jadi buatlah klien yang Anda butuhkan dengan endpoint yang sesuai. Anda dapat menemukan endpoint untuk sumber daya Discovery Anda di portal Azure.

Anda dapat mengautentikasi dengan Microsoft Entra ID menggunakan kredensial dari pustaka @azure/identity atau token Microsoft Entra yang ada.

Untuk menggunakan penyedia DefaultAzureCredential yang ditunjukkan di bawah ini, atau penyedia kredensial lain yang disediakan dengan Azure SDK, instal paket :

npm install @azure/identity

Anda juga perlu mendaftarkan aplikasi Microsoft Entra baru dan memberikan akses ke Azure AI Discovery dengan menetapkan peran yang sesuai kepada prinsipal layanan Anda (catatan: peran seperti tidak "Owner" memberikan izin yang diperlukan).

Untuk informasi lebih lanjut tentang cara membuat aplikasi Microsoft Entra, lihat panduan ini.

Dengan menggunakan lingkungan seperti Node.js dan Node, Anda dapat menggunakan kelas tersebut DefaultAzureCredential untuk mengautentikasi klien.

import { DefaultAzureCredential } from "@azure/identity";
import { WorkspaceClient, BookshelfClient } from "@azure/ai-discovery";

const credential = new DefaultAzureCredential();
// WorkspaceClient exposes conversations, investigations, tasks, and tools.
const workspaceClient = new WorkspaceClient("<workspace-endpoint>", credential);
// BookshelfClient exposes knowledge bases.
const bookshelfClient = new BookshelfClient("<bookshelf-endpoint>", credential);

Untuk lingkungan browser, gunakan InteractiveBrowserCredential dari paket @azure/identity untuk mengautentikasi.

import { InteractiveBrowserCredential } from "@azure/identity";
import { WorkspaceClient, BookshelfClient } from "@azure/ai-discovery";

const credential = new InteractiveBrowserCredential({
  tenantId: "<YOUR_TENANT_ID>",
  clientId: "<YOUR_CLIENT_ID>",
});
const workspaceClient = new WorkspaceClient("<workspace-endpoint>", credential);
const bookshelfClient = new BookshelfClient("<bookshelf-endpoint>", credential);

Bundel JavaScript

Untuk menggunakan pustaka klien ini di browser, pertama-tama Anda perlu menggunakan bunder. Untuk detail tentang cara melakukan ini, silakan lihat dokumentasi bundling kami.

Konsep Utama

WorkspaceClient

WorkspaceClient menyediakan akses ke fitur workspace Discovery: percakapan, investigasi, tugas, dan alat. Jelajahi metode pada klien ini untuk bekerja dengan sumber daya di workspace Discovery.

BookshelfClient

BookshelfClient menyediakan akses ke fitur rak buku Discovery: mengelola dan mengajukan query basis pengetahuan. Jelajahi metode pada klien ini untuk bekerja dengan basis pengetahuan di rak buku Discovery.

Examples

Daftar basis pengetahuan

Daftarkan basis pengetahuan dalam sumber Discovery Bookshelf dengan BookshelfClient.

import { BookshelfClient } from "@azure/ai-discovery";
import { DefaultAzureCredential } from "@azure/identity";

const client = new BookshelfClient("<bookshelf-endpoint>", new DefaultAzureCredential());
for await (const knowledgeBase of client.knowledgeBases.list()) {
  console.log(knowledgeBase.name);
}

Daftar tugas dalam investigasi

Daftarkan tugas-tugas yang termasuk dalam investigasi dengan WorkspaceClient.

import { WorkspaceClient } from "@azure/ai-discovery";
import { DefaultAzureCredential } from "@azure/identity";

const client = new WorkspaceClient("<workspace-endpoint>", new DefaultAzureCredential());
for await (const task of client.tasks.list("<project-name>", "<investigation-name>")) {
  console.log(task.name);
}

Troubleshooting

Penebangan kayu

Mengaktifkan pengelogan dapat membantu menemukan informasi yang berguna tentang kegagalan. Untuk melihat log permintaan dan respons HTTP, atur variabel lingkungan AZURE_LOG_LEVEL ke info. Atau, pengelogan dapat diaktifkan saat runtime dengan memanggil setLogLevel di @azure/logger:

import { setLogLevel } from "@azure/logger";

setLogLevel("info");

Untuk instruksi lebih rinci tentang cara mengaktifkan log, Anda dapat melihat dokumen paket @azure/logger.

Langkah berikutnya

Lihatlah folder package samples, yang berisi kode yang dapat dijalankan sepenuhnya.

Contributing

Jika Anda ingin berkontribusi pada pustaka ini, baca panduan berkontribusi untuk mempelajari selengkapnya tentang cara membuat dan menguji kode.

  • Terakhir diperbarui pada