Skip to content

README.tr_TR.md

Latest commit

 

History

History
258 lines (180 loc) · 9.26 KB

README.tr_TR.md

File metadata and controls

258 lines (180 loc) · 9.26 KB
Raw

SearchCLI logo

SearchCLI

English | 简体中文 | 日本語 | Deutsch | 한국어 | Français | Русский | Italiano | Español | Português | Türkçe | ไทย | Bahasa Indonesia

Kararlı ve ayarlanabilir arama, öneri ve konuşmalı retrieval özelliklerini Agent sisteminize veya iş sisteminize bağlayın.

Topluluk · Hızlı Başlangıç (geliştiriciler) · AI Agent kurulumu · Tam Agent kılavuzu · Katkıda bulunma · Güvenlik

SearchCLI, AI Search on Volcengine için açık CLI'dır.

Agent sisteminiz veya iş sisteminiz kararlı ve ayarlanabilir bilgi dağıtım servislerine ihtiyaç duyuyorsa, SearchCLI production düzeyinde arama, öneri ve konuşmalı retrieval özelliklerini gerçek workflow'lara entegre etmek için pratik bir yol sunar.

SearchCLI ve kurulabilir Viking skills ile harici Agents veri onboarding yapabilir, arama ve öneri akışları oluşturup doğrulayabilir, konuşmalı retrieval çalıştırabilir, strateji yapılandırmasını ayarlayabilir, bad cases inceleyebilir ve retrieval kalitesini kararlı, incelenebilir bir şekilde yineleyerek iyileştirebilir.

Topluluk

SearchCLI WeChat kullanıcı grubuna katılın
Kullanıcılar ve proje yöneticileriyle iletişim kurmak için aşağıdaki QR kodunu WeChat ile tarayın.
QR kodu düzenli olarak yenilenir. Süresi dolmuşsa en güncel sürüm için daha sonra tekrar kontrol edin.

SearchCLI WeChat kullanıcı grubu QR kodu

SearchCLI nedir

  • AI Search on Volcengine için komut satırı entegrasyon yüzeyidir.
  • Harici sistemlerin arama, öneri ve konuşmalı retrieval özelliklerine erişmesi için kararlı bir yoldur.
  • Kurulabilir skills ve otomasyona güvenli komut çıktısı etrafında oluşturulmuş Agent dostu bir workflow katmanıdır.
  • Dry-run, onay kapıları ve write sonrası read doğrulaması içeren incelenebilir bir yürütme modelidir.

Kimler için

  • AI destekli bilgi dağıtımını iş sistemlerine entegre eden geliştiriciler.
  • Kararlı ve yapılandırılabilir arama, öneri ve retrieval workflow'larına ihtiyaç duyan Agent sistemleri geliştiren ekipler.
  • Production kullanımı öncesinde veri onboarding, uygulama yapılandırması ve runtime davranışını incelenebilir şekilde doğrulamak isteyen operasyon, delivery ve çözüm ekipleri.

Neler sağlar

  • Yapılandırılmış iş verileri üzerinde item ve catalog araması.
  • Uygulama sahneleri ve kullanıcı davranışıyla bağlantılı öneri akışları.
  • Uygulama aramasına dayalı konuşmalı retrieval deneyimleri.
  • Verileri onboard eden, uygulamaları yapılandıran ve runtime davranışını açık inceleme adımlarıyla doğrulayan Agent workflow'ları.

Temel özellikler

  • Yapılandırılmış item onboarding için vs item profile | plan | apply.
  • Uygulama ve dataset yönetimi için vs app, vs dataset ve vs data.
  • Runtime doğrulama için vs search run, vs recommend run ve vs chat run.
  • Metin benzerliği için ilk sürüm otomatik değerlendirme ve ayarlama amacıyla vs search tune query-generate | plan | run | report.
  • Harici Agents'ın aynı workflow'ları kullanabilmesi için kurulabilir Viking skills.

Gereksinimler

  • Node.js 20 veya daha yeni
  • git
  • AI Search erişimi olan Volcengine AK/SK

Hızlı Başlangıç (geliştiriciler)

1. Kurulum

git clone git@github.com:volcengine/SearchCLI.git vs
cd vs
bash ./scripts/install.sh

2. Kimlik doğrulama

Geçerli shell'de VIKING_AK ve VIKING_SK zaten ayarlıysa:

vs auth import-env
vs auth status --json
vs doctor --json

Aksi halde gerçek bir terminalde etkileşimli login çalıştırın:

vs auth login

Search tuning sorgu üretimi veya LLM ile ilgililik değerlendirmesi kullanacaksanız, API key'i düz metin yapılandırmaya koymadan OpenAI-compatible LLM API yapılandırın:

vs llm login
vs llm status --json
vs search tune llm-check --live --json

Geçerli shell'de VIKING_LLM_BASE_URL, VIKING_LLM_API_KEY ve VIKING_LLM_MODEL zaten ayarlıysa bunun yerine vs llm import-env kullanabilirsiniz. API key yerel güvenli kimlik bilgisi deposunda saklanır; base URL ve model gizli olmayan yapılandırma olarak saklanır.

3. İlk onboarding flow'u çalıştırma

Kullanıcı yeni bir app, bind-time yapılandırma incelemesi ve runtime doğrulama istiyorsa dataset+app yolunu kullanın:

vs item profile --file ./items.json --pretty
vs item plan --file ./items.json --goal "Build item search"
vs item apply --plan-dir ./.viking/item-plans/<plan> --dry-run
vs item apply --plan-dir ./.viking/item-plans/<plan> --confirm-review --wait-ready --run-trials

Yalnızca dataset provisioning gerekiyorsa dataset-only yolunu kullanın, --skip-app ile dataset-only plan oluşturun ve dataset create + ingest sonrasında durun:

vs item profile --file ./items.json --pretty
vs item plan --file ./items.json --goal "Build item search" --skip-app
vs dataset create --data @dataset-create.json
vs dataset ingest --dataset-id <dataset-id> --fields @<normalized-items-artifact>

Plan dataset-create.json ürettiyse bunu tercih edin; böylece dataset oluşturma sırasında Schema ve DataFieldConfig birlikte gönderilir. Tam bir create payload yoksa veya uygun değilse --name <dataset-name> --type item --schema @schema.json biçimi manuel schema-only fallback olarak kalır.

Mevcut bir plandan dataset-only sınırını zorunlu tutmanız gerektiğinde --skip-app, vs item provision ve vs item apply tarafından execution-time guard rail olarak da kabul edilir.

Video dataset gerekiyorsa varsayılan tipe güvenmeyin. Her zaman açıkça --type video geçirin:

dataset+app için:

vs item profile --file ./videos.jsonl --type video --pretty
vs item plan --file ./videos.jsonl --type video --goal "Build video search"
vs item apply --plan-dir ./.viking/item-plans/<plan> --dry-run
vs item apply --plan-dir ./.viking/item-plans/<plan> --confirm-review --wait-ready --run-trials

dataset-only için:

vs item profile --file ./videos.jsonl --type video --pretty
vs item plan --file ./videos.jsonl --type video --goal "Build video search" --skip-app
vs dataset create --data @dataset-create.json
vs dataset ingest --dataset-id <dataset-id> --fields @<normalized-items-artifact>

Video dataset-only provisioning için dataset-create.json tercih edin; böylece istek DataFieldConfig içerir. Yalnızca --schema @schema.json kullanmak MissingParameter.DefaultFieldStrategy hatasıyla başarısız olabilir.

Hızlı Başlangıç (AI Agents)

Harici bir Agent bu repository üzerinden AI Search çalıştıracaksa:

1. SearchCLI kurulumu

git clone git@github.com:volcengine/SearchCLI.git vs
cd vs
bash ./scripts/install.sh

2. Viking skills kurulumu

npx skills add "git@github.com:volcengine/SearchCLI.git" -y -g

Varsayılan public skill bundle şunları içerir:

  • vs-shared
  • vs-item-onboarding
  • vs-search
  • vs-search-tuning
  • vs-chat
  • vs-recommend

3. Kimlik doğrulama

Geçerli shell'de VIKING_AK ve VIKING_SK zaten ayarlıysa şunu tercih edin:

vs auth import-env

Aksi halde:

vs auth login

4. Doğrulama

vs --help
vs auth status --json
vs llm status --json
vs doctor --json
vs skill list

Public komut grupları

  • vs auth
  • vs llm
  • vs doctor
  • vs skill
  • vs item
  • vs app
  • vs dataset
  • vs data
  • vs search
  • vs chat
  • vs recommend

Dokümantasyon

Maintainer workflow

Open-source repository'nin kendisini maintain ediyorsanız, yerel skill tooling şudur:

vs skill list
vs skill init viking-demo-skill
vs skill validate
vs skill install all

Repository kontrollerini build edip çalıştırın:

npm install
npm run validate:skills
npm run build
npm run test:acceptance:dist

Katkıda bulunma

Daha fazla ayrıntı için Contributing sayfasını inceleyin.

Harici contributors, bir pull request kabul edilmeden önce Contributor License Agreement (CLA) tamamlamalıdır.

Davranış Kuralları

Daha fazla ayrıntı için Code of Conduct sayfasını inceleyin.

Güvenlik

Bu projede olası bir güvenlik sorunu keşfederseniz veya keşfetmiş olabileceğinizi düşünüyorsanız, Bytedance Security'yi security center veya vulnerability reporting email üzerinden bilgilendirmenizi rica ederiz.

Lütfen public GitHub issue oluşturmayın.

Lisans

Bu proje Apache-2.0 License altında lisanslanmıştır.