JavaScript için Azure AI Discovery client library - sürüm 1.0.0

Bu paket, Azure AI Discovery servisi için izomorfik bir SDK (hem Node.js hem de tarayıcılarda çalışır) içerir.

Kütüphane iki istemciyi açıklar:

• WorkspaceClient — Discovery çalışma alanında konuşmalar, soruşturmalar, görevler ve araçlarla çalışmak.
• BookshelfClient — Discovery kitaplıktaki bilgi tabanlarını yönetin ve sorgulayın.

Her istemci kendi hizmet uç noktasını hedefliyor.

Önemli bağlantılar:

• Kaynak kod
• Paket (NPM)
• API başvuru belgeleri

Başlangıç Yapmak

Şu anda desteklenen ortamlar

• Node.js LTS sürümleri
• Safari, Chrome, Edge ve Firefox'un en son sürümleri.

Daha fazla bilgi için bkz. destek ilkesi.

Prerequisites

• Bir Azure aboneliği.

@azure/ai-discovery paketini yükleme

JavaScript için Discovery istemci kütüphanesini şu şekilde npmkurun:

npm install @azure/ai-discovery

Müşterileri oluşturun ve doğrulayın

Bir istemci nesnesi oluşturmak için servise endpoint ve bir credential. Azure AI Discovery istemcileri, kimlik doğrulamak için Microsoft Entra kimlik bilgilerini kullanır. WorkspaceClient Ve BookshelfClient her biri kendi uç noktasını hedefliyor, bu yüzden ihtiyacınız olan istemci(ler)i ilgili uç noktayla oluşturun. Discovery kaynaklarınızın uç noktalarını Azure portal'da bulabilirsiniz.

@azure/identity kütüphanesinden veya mevcut bir Microsoft Entra token'ından bir kimlik bilgisi kullanarak Microsoft Entra ID ile kimlik doğrulaması yapabilirsiniz.

Aşağıda gösterilen DefaultAzureCredential sağlayıcısını veya Azure SDK ile sağlanan diğer kimlik bilgisi sağlayıcılarını kullanmak için lütfen @azure/identity paketini yükleyin:

npm install @azure/identity

Ayrıca yeni bir Microsoft Entra uygulaması kaydetmeniz ve hizmet başlaşına uygun bir rol atayarak Azure AI Discovery'ye erişim vermeniz gerekecek (not: Like "Owner" roller gerekli izinleri vermeyecektir).

Microsoft Entra uygulamasının nasıl oluşturulacağı hakkında daha fazla bilgi için bu rehbere göz atın.

Node.js ve Node benzeri ortamlar kullanarak, sınıfı istemcileri doğrulamak için kullanabiliyorsunuz DefaultAzureCredential .

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);

Tarayıcı ortamlarında kimlik doğrulaması yapmak için InteractiveBrowserCredential paketindeki @azure/identity kullanın.

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);

JavaScript Paketi

Bu istemci kitaplığını tarayıcıda kullanmak için önce bir paketleyici kullanmanız gerekir. Bunun nasıl yapılacağının ayrıntıları için lütfen paketleme belgelerimize bakın.

Temel kavramlar

WorkspaceClient

WorkspaceClient Discovery çalışma alanı özelliklerine erişim sağlar: konuşmalar, soruşturmalar, görevler ve araçlar. Bu istemcide bir Discovery çalışma alanında kaynaklarla çalışmak için yöntemleri keşfedin.

Kitap Rafı İstemcisi

BookshelfClient Discovery kitaplıklarının özelliklerine erişim sağlar: bilgi tabanlarını yönetmek ve sorgulamak. Bu istemcinin bilgi tabanlarıyla çalışmak için Discovery kitaplıklarında çalışma yöntemlerini keşfedin.

Examples

Bilgi tabanlarını listele

Bir Discovery Kitaplık kaynağında bilgi tabanlarını .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);
}

Bir soruşturmada görevleri listele

Bir soruşturmaya ait görevleri .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

Logging

Loglamayı etkinleştirmek, hatalarla ilgili yararlı bilgilerin ortaya çıkmasına yardımcı olabilir. HTTP isteklerinin ve yanıtlarının günlüğünü görmek için ortam değişkenini AZURE_LOG_LEVEL olarak infoayarlayın. Alternatif olarak, çalışma zamanında setLogLevel@azure/logger çağrılarak günlük tutma etkinleştirilebilir.

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

setLogLevel("info");

Günlükleri etkinleştirme hakkında daha ayrıntılı yönergeler için @azure/günlükçü paketi belgelerine bakabilirsiniz.

Sonraki Adımlar

Tam çalıştırılabilir kod içeren package samples klasörüne bir göz atın.

Katkıda Bulunmak

Bu kitaplığa katkıda bulunmak istiyorsanız kodu oluşturma ve test etme hakkında daha fazla bilgi edinmek için lütfen katkıda bulunma kılavuzu okuyun.

İlgili projeler

• JavaScript için Microsoft Azure SDK