Skip to content

README.es_ES.md

Latest commit

 

History

History
228 lines (159 loc) · 7.64 KB

README.es_ES.md

File metadata and controls

228 lines (159 loc) · 7.64 KB
Raw

SearchCLI logo

SearchCLI

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

Conecta búsqueda estable y ajustable, recomendaciones y retrieval conversacional a tu sistema Agent o sistema de negocio.

Comunidad · Inicio rápido (desarrolladores) · Configuración de AI Agent · Guía completa para Agent · Contribuir · Seguridad

SearchCLI es la CLI abierta para AI Search on Volcengine.

Si tu sistema Agent o sistema de negocio necesita servicios de distribución de información estables y ajustables, SearchCLI ofrece una ruta práctica para integrar búsqueda, recomendaciones y retrieval conversacional de nivel production en workflows reales.

Con SearchCLI y sus Viking skills instalables, los Agents externos pueden hacer onboarding de datos, construir y validar flujos de búsqueda y recomendación, ejecutar retrieval conversacional, ajustar configuraciones de estrategia, investigar bad cases e iterar sobre la calidad del retrieval de forma estable y verificable.

Comunidad

Únete al grupo de usuarios de SearchCLI en WeChat
Escanea el código QR con WeChat para conectar con otros usuarios y mantenedores.
El código QR se actualiza periódicamente. Si ha caducado, vuelve más tarde para consultar la versión más reciente.

Código QR del grupo de usuarios de SearchCLI en WeChat

Qué es SearchCLI

  • La superficie de integración de línea de comandos para AI Search on Volcengine.
  • Una ruta estable para que los sistemas externos accedan a capacidades de búsqueda, recomendación y retrieval conversacional.
  • Una capa de workflow apta para Agents, construida alrededor de skills instalables y salida de comandos segura para automatización.
  • Un modelo de ejecución revisable con dry-runs, puntos de confirmación y verificación read-after-write.

Para quién es

  • Desarrolladores que integran distribución de información impulsada por AI en sistemas de negocio.
  • Equipos que construyen sistemas Agent y necesitan workflows de búsqueda, recomendación y retrieval estables y configurables.
  • Equipos de operaciones, delivery y soluciones que necesitan una forma revisable de hacer onboarding de datos, configurar aplicaciones y verificar el comportamiento runtime antes del uso en producción.

Qué habilita

  • Búsqueda de items y catálogos sobre datos de negocio estructurados.
  • Flujos de recomendación conectados a escenas de aplicación y comportamiento de usuarios.
  • Experiencias de retrieval conversacional basadas en la búsqueda de la aplicación.
  • Workflows Agent que pueden hacer onboarding de datos, configurar aplicaciones y validar el comportamiento runtime con pasos explícitos de revisión.

Capacidades principales

  • vs app, vs dataset y vs data para gestión de aplicaciones y datasets.
  • vs search run, vs recommend run y vs chat run para verificación runtime.
  • vs search tune query-generate | plan | run | report para una primera versión de evaluación y ajuste automatizados de similitud textual.
  • Viking skills instalables para que los Agents externos puedan usar los mismos workflows.

Requisitos

  • Node.js 20 o posterior
  • git
  • Volcengine AK/SK con acceso a AI Search

Inicio rápido (desarrolladores)

1. Instalar

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

2. Autenticarse

Si la shell actual ya tiene VIKING_AK y VIKING_SK:

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

De lo contrario, ejecuta el inicio de sesión interactivo en una terminal real:

vs auth login

Si vas a usar generación de consultas para search tuning o evaluación de relevancia mediante LLM, configura una API LLM compatible con OpenAI sin colocar la API key en texto plano dentro de la configuración:

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

Si la shell actual ya tiene VIKING_LLM_BASE_URL, VIKING_LLM_API_KEY y VIKING_LLM_MODEL, puedes usar vs llm import-env en su lugar. La API key se almacena en el almacén local seguro de credenciales; base URL y model se guardan como configuración no secreta.

3. Ejecutar el primer flujo de onboarding

vs dataset import-url --file-name items.jsonl
curl -X PUT --data-binary "@./items.jsonl" "<FileUrl from previous step>"
vs dataset infer-schema --tos-key <FileKey> --type multi_modal --theme e_commerce --language zh --name <dataset-name>
vs dataset infer-result --task-id <TaskID> --render-schema
vs dataset create --data @dataset-create.json
vs data write --dataset-id <DatasetId> --fields @items.jsonl
vs app create --name <app-name> --industry e_commerce --language zh
vs app attach-dataset --data @attach.json

Si solo necesitas un dataset (sin app), detente después de vs data write.

Para los datasets de eventos de usuario, usa --type user_event y omite --theme.

Inicio rápido (AI Agents)

Si un Agent externo necesita operar AI Search a través de este repositorio:

1. Instalar SearchCLI

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

2. Instalar Viking skills

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

El paquete público predeterminado de skills incluye:

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

3. Autenticarse

Si la shell actual ya tiene VIKING_AK y VIKING_SK, se recomienda:

vs auth import-env

De lo contrario:

vs auth login

4. Verificar

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

Grupos de comandos públicos

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

Documentación

Workflow de maintainers

Si mantienes el repositorio open-source, el tooling local de skills es:

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

Construir y ejecutar las comprobaciones del repositorio:

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

Contribuir

Consulta Contributing para más detalles.

Los contribuidores externos deben completar el Contributor License Agreement (CLA) antes de que una pull request pueda ser aceptada.

Código de conducta

Consulta Code of Conduct para más detalles.

Seguridad

Si descubres un posible problema de seguridad en este proyecto, o crees haber descubierto uno, te pedimos que notifiques a Bytedance Security mediante nuestro security center o el vulnerability reporting email.

No crees una issue pública de GitHub.

Licencia

Este proyecto está licenciado bajo la Apache-2.0 License.