API, koleksiyonları ve belgeleri yönetme, içerik işleme ve soru yanıtlama, özetleme, arama ve yapılandırılmış çıkarma gibi yapay zeka yeteneklerini uygulama için iş akışlarını destekler. Bu parçaların nasıl birlikte çalıştığını anlamak için bu sayfayı kullanın, ardından uç nokta düzeyinde uygulama ayrıntıları için API referansını kullanın.
Şunlara sahip olduğunuzdan emin olun:
API erişimini yapılandırmadıysanız, bkz. Bilgi Bankası API erişimi kurulumu.
Tipik bir Bilgi Bankası API iş akışı şu sırayı izler:
Kimlik Doğrulama → Koleksiyon → Belge → Dizin → Çıkarım → Yanıt
Bir koleksiyon, uygulamanın çalıştığı bilgi alanını tanımlar. Bir koleksiyon oluşturduğunuzda, yanıt sonraki işlemlerde kullanılacak benzersiz ad alanını içerir.
Örneğin:
{
"namespace": "<collection-namespace>",
"name": "example-collection"
}
Belge ve çıkarım istekleri için koleksiyon ad alanını saklayın.
Belgeler koleksiyonlara yüklenir ve benzersiz belge tanımlayıcıları atanır.
Bir yükleme yanıtı belgeyi tanımlar, böylece uygulama işlemeyi izleyebilir ve sonraki isteklerde ona başvurabilir.
{
"document_id": "<document-id>",
"document_name": "example.pdf"
}
Bir belgeyi yükleme ve dizine ekleme ayrı aşamalardır.
Yükleme, dosyayı Bilgi Bankası'na aktarır. Dizine ekleme, içeriği çıkarır ve bu içeriği yapay zeka işlemlerinde kullanılmak üzere işler.
İşlemin tamamlandığını, belgeye yönelik çıkarım istekleri göndermeden önce doğrulamak gerekir.
Çıkarım işlemleri Bilgi Bankası yapay zeka yeteneklerini işlenmiş içeriğe uygular.
Kullanılabilir işlemler şunları içerir:
Gerçekleştirilecek işlem için uç nokta ve istek şemasını belirlemek üzere API referansını kullanın.
Çıkarım yanıtları oluşturulan sonucu döndürür ve destekleyici atıf bilgileri içerebilir.
İşleme bağlı olarak atıf verileri, sonuçla ilişkili kaynak içerik, sayfa ve koordinatları tanımlayabilir. Bu bilgilerin kullanıcıya nasıl sunulacağını uygulama belirler.
En basit uygulama iş akışı; koleksiyon oluşturmak, belge eklemek, işlemenin tamamlanmasını beklemek ve ardından çıkarım işlemi çalıştırmaktır.
Uygulamanız için kaynak belgeleri içerecek koleksiyonu oluşturun.
Yanıtta döndürülen ad alanını saklayın:
collection_namespace = <returned-namespace>
Bu değer, belge eklerken ve koleksiyona yönelik işlemler çağırırken kullanılır.
Koleksiyona belge yükleyin ve döndürülen belge kimliğini saklayın:
document_id = <returned-document-id>
Belge kimliği, yüklenen belgeyi dosya adından bağımsız olarak tanımlar.
Gerekli dizinleme işlemini başlatın, ardından işlem tamamlanana kadar belge durumunu kontrol edin.
Başarılı yüklemenin belgenin yapay zeka işlemleri için hazır olduğu anlamına geldiğini varsaymayın.
Tipik uygulama akışı:
Belge yükle
↓
Dizinlemeyi başlat
↓
İşleme durumunu kontrol et
↓
Tamamlandı
İşlem başarısız olursa, çıkarım isteği göndermeden önce belge işleme sorununu çözün.
İşlem tamamlandıktan sonra koleksiyon ad alanını, belge kimliğini ve uç noktanın gerektirdiği işleme özel girdileri gönderin.
Örneğin, soru yanıtlama isteği kavramsal olarak şunları sağlar:
Koleksiyon: <collection-namespace>
Belge: <document-id>
Soru: Temel bulgular nelerdir?
Gerçek istek şeması için API referansını kullanın.
Uygulamanızda döndürülen yanıtı veya çıkarılan veriyi kullanın.
Yanıt atıf bilgileri içeriyorsa, oluşturulan bilgiyi destekleyen belge içeriğine geri bağlamak için yanıtı kullanabilirsiniz.
Belge yaşam döngüsü, uygulamanızın yüklenen içeriği ne zaman kullanabileceğini etkiler.
| Aşama | Ne olur? | Uygulama eylemi |
|---|---|---|
| Yükleme | Dosya Bilgi Bankası'na eklenir ve bir belge kimliği alır. | Belge kimliğini saklayın. |
| Dizinleme | İçerik çıkarılır ve yapay zeka kullanımı için işlenir. | Belge durumunu izleyin. |
| Tamamla | İşlenmiş içerik çıkarım için kullanıma hazırdır. | Yapay zeka isteklerini gönderin. |
| Başarısız | İşlem başarıyla tamamlanamadı. | Devam etmeden önce hatayı çözün. |
Bu ayrım, özellikle otomatik iş akışları için önemlidir. Bir uygulama, yüklemeden hemen sonra çıkarım isteği göndermek yerine işleme durumunu kontrol etmelidir.
Uygulamanızın kaynak içerikle ne yapması gerektiğine göre bir işlem seçin.
Koleksiyon veya belge içeriği hakkında doğal dil soruları göndermek için Soru-Cevap bölümünü kullanın.
API hem akış halinde olan hem de olmayan Soru-Cevap imkanı sağlar.
Akış halinde Soru-Cevap yanıtı oluşturulurken kademeli olarak döndürür. Arayüzünüzün oluşturulan içeriği aşamalı olarak görüntülemesi gerektiğinde kullanın.
Akış halinde Soru-Cevap ayrıca isteğe Özel Talimatların uygulanıp uygulanmayacağını kontrol etmeyi destekler. Akış halinde Soru-Cevap yanıtı için akıl yürütmenin oluşturulup oluşturulmayacağını da kontrol edebilirsiniz.
Akış halinde olmayan Soru-Cevap oluşturmanın tamamlanmasını bekler ve bitmiş yanıtı döndürür. Uygulamanızın kısmi çıktı görüntülemesi gerekmediğinde kullanın.
Belge içeriğinin yoğunlaştırılmış temsilini oluşturmak için özetlemeyi kullanın.
API referansı geçerli istem gereksinimlerini ve desteklenen girdileri tanımlar.
Belirtilen arama metniyle ilgili içeriği almak için bağlam aramayı kullanın.
Bu, uygulamaların sohbet yanıtı oluşturmadan ilgili kaynak materyali belirlemesine yardımcı olabilir.
Uygulamanızın belge içeriğinden yapılandırılmış değerlere ihtiyacı olduğunda çıkarmayı kullanın.
Çıkarma tanımı şu tür bilgileri tanımlayabilir:
Özellik adı: sozlesme_degeri
Tür: tam sayı
Açıklama: Anlaşma sözleşme değeri
İstem: Dolar cinsinden en büyük anlaşma değerini çıkar.
Döndürülen sonuç çıkarılan değer, güven bilgisi ve kaynak atıfını içerebilir.
API, hangi içeriğin bir isteğe katılacağını belirlemek için çeşitli yollar sağlar.
Bir işlem için mevcut birincil içeriği tanımlamak için koleksiyon ve belge tanımlayıcılarını kullanın.
Etiketler koleksiyonlardan ziyade belgelerle ilişkilendirilir.
Belge etiketleri yalnızca Bilgi Bankası API aracılığıyla kullanılabilir ve standart kullanıcı arayüzünde gösterilmez.
Bir istek için değerlendirilen belgeleri filtrelemek üzere desteklenen işlemlerle etiketler kullanılabilir. Örneğin, bir uygulama bir belge grubunu finansal belgeler olarak etiketleyebilir ve soruyu o etiketi taşıyan belgelerle sınırlayabilir.
Ekler, koleksiyon belgelerinden ayrı tutulur.
Bir sohbete dosya eklemek, söz konusu dosyayı koleksiyona eklemez. Ek, koleksiyon içeriği ve sohbet geçmişi ile birlikte oluşturulan yanıta bağlam katkısında bulunabilir.
Uygulamanın geçici veya konuşmaya özel içeriğe bir koleksiyona kalıcı olarak eklemeksizin ihtiyaç duyduğu durumlarda ek uç noktalarını kullanın.
Çıkarım yanıtları, oluşturulan çıktıyı destekleyici kaynak içeriğine bağlayan atıf bilgilerini içerebilir.
Atıf verileri şu gibi bilgileri içerebilir:
API bu bilgileri veri olarak sağlar. Bunun nasıl sunulacağına karar vermek uygulamanın sorumluluğundadır.
Örneğin, bir uygulama döndürülen koordinatları kullanarak oluşturulan yanıtı destekleyen konumu belirleyen bir kaynak vurgulama deneyimi oluşturabilir.
API işlemleri, kimliği doğrulanmış kimliğin mevcut izinlerini kullanır.
Kimliği doğrulanmış kimlik, istenen koleksiyona, belgeye veya işleme erişim hakkına sahip değilse istek başarısız olabilir.
Sorun giderme sırasında:
X-Request-ID, Bilgi Bankası hizmetlerinde isteği tanımlar ve Desteğin başarısız bir isteği araştırmasına yardımcı olabilir.
Bu kavramları bir uygulamada gösteren çalışan örnekler istediğinizde Python Demo'yu kullanın.
Bilgi Bankası Python Demo ile başlayın
Belirli bir işlemi uygulamaya hazır olduğunuzda API referansını kullanın.
