Arama¶

Mesaj araması, dizine eklenmiş mesajları bir metin sorgusu ve bir filtre kümesiyle eşleştirir. TEBHOS mesajları Elasticsearch'te dizinler. Üye araması Sunucu üyesi arama, sunucu araması ise Keşif sayfasında anlatılır.

İki yol vardır. Mesaj ara (POST /search/messages) kullanıcı oturumlarını ve bot token'larını kabul eder; tek bir kanalda, tek bir sunucuda veya çağıranın tüm sunucularında ve doğrudan mesajlarında arama yapabilir. Mesaj ara (sorgu dizesi) (GET /messages/search) ise yalnızca kullanıcılara açık, daha eski bir TEBHOS biçimidir.

Her sonuç, çağıranın okuyabildiği kanallarla sınırlıdır: bir sunucu kanalında çağıranın VIEW_CHANNEL ve READ_MESSAGE_HISTORY izinlerine sahip olması, bir özel kanalda ise alıcılardan biri olması gerekir. Gizli kanallardaki mesajlar sonuçlarda hiçbir zaman görünmez.

Mesaj ara¶

POST /search/messages

Dizine eklenmiş mesajlarda arama yapar ve bir genel arama sonucu nesnesi döndürür. Kullanıcı oturumlarını ve bot token'larını kabul eder; bot yalnızca current kapsamını kullanabilir.

Her isabet, döndürülmeden önce mesaj deposundan yeniden okunur. Mesajı artık mevcut olmayan bir isabet sayfadan çıkarılır ve dizinden silinir; bu nedenle bir sayfada hits_per_page değerinden daha az girdi bulunabilir.

JSON gövdesi¶

Snowflake değerleri dize veya sayı olarak gönderilebilir. Aynı listedeki filtrelerin tümü eşleşmelidir (mentions, has, embed_type, link_hostname, attachment_filename, attachment_extension); yalnızca author_id ve author_type listelenen değerlerden herhangi biriyle eşleşir.

Yanıt¶

Hız sınırı¶

search:messages kovasında (sorgu dizesi yoluyla paylaşılır) hesap başına 10 saniyede 20 istek.

Örnek¶

curl -X POST https://tebhos.com/api/v1/search/messages \
  -H "Authorization: Bot $TEBHOS_BOT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"context_guild_id": "1489002177550843904", "content": "release notes", "has": ["link"], "hits_per_page": 10}'

Genel arama kapsamları¶

Genel arama sonucu nesnesi¶

Genel arama içerik türleri¶

Mesaj ara (sorgu dizesi)¶

GET /messages/search

Daha eski TEBHOS arama yolu. Yalnızca kullanıcılara açıktır: bot token'ı 403 ACCESS_DENIED ile reddedilir.

Dizine eklenmiş mesajlarda arama yapar ve bir mesaj arama sonucu nesnesi döndürür.

Her isabet, döndürülmeden önce mesaj deposundan yeniden okunur. Mesajı artık mevcut olmayan bir isabet sayfadan çıkarılır ve dizinden silinir; bu nedenle bir sayfada limit değerinden daha az girdi bulunabilir.

Sorgu parametreleri¶

before, after veya during içindeki geçersiz bir tarih 400 BAD_REQUEST döndürür.

Yanıt¶

Hız sınırı¶

search:messages kovasında kullanıcı başına 10 saniyede 20 istek.

Örnek¶

curl -G "https://tebhos.com/api/v1/messages/search" \
  -H "Authorization: Bearer $TOKEN" \
  --data-urlencode "q=release notes" \
  --data-urlencode "channel_id=1489002177550843905" \
  --data-urlencode "has=link,image" \
  --data-urlencode "sort=newest"

Arama kapsamları¶

Doğrudan mesaj ve grup doğrudan mesaj kanallarında channel_id ile arama yapılır; çağıran alıcılardan biri olmalıdır.

Mesaj arama sonucu nesnesi¶

Yapı¶

total arama dizininden gelir ve geçerli sayfada çıkarılan bayat isabet sayısı kadar azaltılır; bu nedenle bir tahmindir. Sonuçlarda next_cursor null olana kadar page değerini artırarak sayfalayın.

Yalnızca server_id içeren biçim, sayfalama alanları olmadan {"items": [...]} döndürür.

Örnek¶

{
  "items": [],
  "total": 0,
  "page": 1,
  "total_pages": 0,
  "next_cursor": null
}

Arama içerik türleri¶

has ve exclude_has tarafından kabul edilen değerler. Bilinmeyen değerler yok sayılır.

Arama sıralama kipleri¶