Okuma kitaplığı
Varsayımları görünür kılan bir filtre paneli tasarlayın
LocalLLaMA filtre paneli sınırlarını açıklasın: görünür koşullar, geri alınabilir değişiklikler, okunabilir istek durumu ve dönen malzemenin dürüst sınırları.
Etkin her filtreyi etiketleyin
Filtre paneli, isteğin hangi malzemeyi döndürebileceğini açıklar. Önerilen nicemleme defterinde q=quantization, subreddit=LocalLLaMA, limit=3 ve page=1 değerlerini ayrı kararlar olarak gösterin. Topluluk kısıtı, ilgili bütün tartışmaların orada olduğunu veya arşivin oradaki her tartışmayı içerdiğini garanti etmez. Okuma sorusunu yakına koyun: örneğin bellek ölçümünde hangi koşullar bildirilmiş? Bu, okurun seçilmiş sınırı yanıttaki açıklanmamış yokluktan ayırmasına yardım eder.
Gerçek sözleşmeye uygun etiketler kullanın. Birden çok çözümlenmiş q terimi, iki alanda birden değil, tek bir eşleşen title veya text alanında bulunmalıdır; farklı alanlardaki kısmi eşleşmeler birleştirilmez. kind=comment kayıt türünü sınırlar, tam yorum dizisi vaat etmez. min_score=10, kalan kayıtların yetkin veya yararlı olduğunu değerlendirmez; kayıtlı puana eşik uygular. Kullanılmayan filtrelerle etkin kısıtları görünür biçimde ayırın. Sorguyu sessizce daraltan varsayılan da okurun anlaması gereken karardır.
Kaldırılabilir bir kısıt gösterin
Okur bütün isteği yeniden kurmadan bir koşulu kaldırabilsin. Açıkça adlandırılmış Minimum puanı kaldır eylemi, sorguyu, topluluğu ve diğer filtreleri koruyabilir. Değişen parametreyi göndermeden önce gösterin ve yeni sonuç dizisine sayfa 1'den başlayın. Bu, tanımlanmış iki isteği karşılaştırmayı destekler. Kayıt akını veya tam kaç kaydın dışlandığını göstermeyi garanti etmez: yanıtlar sınırlıdır, toplamlar alt sınır olabilir ve tekrarlanan veri alımı sabit görüntü vaat etmez.
Kontrole bir kalite hikâyesi yüklemeyin. min_score kaldırmak spam davet etmek, eklemek uzman kanıtı seçmek demek değildir. Eşiğin bu araştırmaya katkısını sorun. Soruyu aydınlatmadan yalnızca alışılmadık görüşleri gizliyorsa kapalı bırakmak makul olabilir. Her ayarlamada veri almak yerine gönderimi açık bir eylem yapın. Boş yanıt dâhil her başarılı alım bir krediye mal olduğundan, keşif kontrolleri sessizce ücretli istek akışına dönüşmemelidir.
URL durumunu okunabilir tutun
Etkin filtreleri kodlayan bir URL, aramada yapılan varsayımların kaydıdır. Örnek istek https://api.redditsearchapi.com/v1/search?q=quantization&subreddit=LocalLLaMA&limit=3&page=1 olabilir. Uygulama eşdeğer bir parametre özeti gösterip deftere kaydedebilir. URL oluştururken değerleri doğru kodlayın, arayüzde okunabilir etiketler kullanın. Kaydedilen istek seçilen koşulları tekrarlayabilir; eski yanıtı saklamaz veya aynı kayıtların daha sonra mevcut kalacağını garanti etmez.
Kimlik bilgisini URL'ye ya da ortak ekran görüntüsüne koymayın. Uygulamanın arka ucu, gizli deposundan X-API-Key veya Authorization: Bearer ekler. Sorgu değerleri ve notlar da hassas olabilir; paylaşmadan önce inceleyin. Tarih kontrolleri from ve to değerlerini YYYY-MM-DD UTC olarak yazmalıdır; to günün tamamını içerir. Tarih aralığını veya sayfa boyutunu değiştirmek, eski sınırları artık aynı anlama gelmeyen sayfa numarasını sürdürmek yerine yeni karşılaştırma başlatır.
Ortaya çıkan kapsamı açıklayın
Yanıt geldiğinde gösterileni, metadatanın ortaya koyduğundan ayırın. Gerçekte görüntülenen sayıyı gösterin; pagination.total değerini pagination.relation ile niteleyin. gte için yaklaşık işareti değil en az ifadesini, unknown veya null için toplam bilinmiyor ifadesini kullanın. pagination.has_more desteklenen pencerede devamı yönetir; pagination.window_exhausted son pencere koşulunu belirtir. En fazla 100 kayıt ve 100 sayfa kabul edilir. Sınır veya kesin yanıt sayısı, topluluğun ya da konunun tamamının kapsandığını göstermez.
Kayıtların kronolojik, ilgi veya puan sırasıyla değil arşivin _doc sırasıyla geldiğini belirtin. Yerel yeniden sıralama yalnızca yüklenmiş malzemeyi etkiler. Kayıtların düz olduğunu ve başlık, yazar, tarih, bağlantı gibi alanların bulunmayabileceğini açıklayın. İsteğe bağlı parent_id veya link_id eldeki kayıtları yerel gruplamaya yardım eder; sorgu filtresi veya tam konuşma kanıtı değildir. Panel, okurun sınırları ve belirsizliği adlandırmasını sağlamalı; kesin görünen bir formu Reddit'in eksiksiz ya da temsilî görünümü sanmasına yol açmamalıdır.
