Descarga y extrae el paquete de Python Demo.
El paquete contiene los scripts y la configuración utilizados para demostrar la administración de colecciones, el procesamiento de documentos, la inferencia y las operaciones de API relacionadas.
Última actualización el
29 set. 2026
Ejecuta, inspecciona y adapta una implementación de Python funcional de los flujos de trabajo de API comunes de Knowledge Base.
Python Demo proporciona un punto de partida funcional para el desarrollo de aplicaciones.Usa el flujo de trabajo completo para ver cómo funcionan juntas la creación de colecciones, el procesamiento de documentos y la inferencia de IA, luego explora scripts individuales para operaciones específicas de colecciones e inferencia.
Antes de empezar
Asegúrate de tener:
- Acceso a la API de Knowledge Base.
- Las credenciales necesarias para autenticar tu aplicación.
- Python 3.7 o posterior.Se recomienda Python 3.11 o posterior.
- Un PDF que puedas usar para el flujo de trabajo de demostración completo.
Si no has configurado el acceso a la API, consulta Configurar acceso a la API de Knowledge Base.
Descargar y configurar Python Demo
Crea un entorno virtual:
python3 -m venv venv
Activa el entorno:
- En macOS o Linux:
source venv/bin/activate - En Windows:
venv\Scripts\activate
Instala las dependencias:
pip install --upgrade pip
pip install -e .
Agrega las credenciales de API requeridas y la configuración del servicio a config.yaml.
Cambia a la subcarpeta python antes de ejecutar los Scripts de muestra.
La demostración usa requests, pyyaml y tqdm.Las credenciales se almacenan en config.yaml, y los tokens de autenticación se administran automáticamente.
No confirme los archivos config.yaml ni los archivos .token generados en el control de versiones.
Ejecutar el flujo de trabajo completo
Ejecutar:
python knowledgebase.py
Para usar un PDF específico:
python knowledgebase.py --document=<ruta-al-pdf>
La demostración:
- Se autentica con la API.
- Crea una colección llamada demo-collection.
- Carga un PDF.
- Supervisa el documento hasta que se complete la indexación.
- Ejecuta una solicitud de inferencia contra el documento procesado.
La carga y la indexación son partes distintas de la ingesta de documentos. La indexación extrae el contenido del documento y lo pone a disposición de las operaciones de IA.
Si no especificas un PDF, la demostración selecciona uno del directorio documents del paquete. El procesamiento del documento expira después de cinco minutos si no alcanza un estado completo.
Nota
El flujo de trabajo completo crea una colección llamada demo-collection y carga un PDF en ella. La demostración no elimina la colección ni el documento cargado cuando termina el flujo de trabajo.
Explorar las operaciones de colección
Después de ejecutar el flujo de trabajo completo, utilice scripts individuales para explorar operaciones específicas de la API.
Crear una colección
python collection.py --action create --name <nombre-de-colección>
Los nombres de colección pueden contener hasta 255 caracteres.
Listar colecciones
python collection.py --action list
Elige si listar las colecciones que has creado, que has compartido o que otros han compartido contigo cuando se te solicite.
Compartir una colección
python collection.py --action share --collection-id <collection-id>
Introduce las direcciones de correo electrónico que deben recibir acceso de lectura o escritura cuando se solicite.
Cargar documentos
python collection.py --action upload --collection-id <collection-id> --path=<ruta-al-archivo-o-directorio>
El script puede cargar un solo archivo o documentos desde un directorio específico.
Enumerar documentos en una colección
python collection.py --action get_documents --collection-id <collection-id>
Comprobar el estado de procesamiento del documento
python collection.py --action get_status --document-id <document-id>
La demostración proporciona estas operaciones como ejemplos independientes que puedes inspeccionar y adaptar de forma independiente del flujo de trabajo completo.
Explorar las operaciones de inferencia
Los ejemplos de inferencia requieren un ID de colección y un ID de documento.Usa los Scripts de colección para identificarlos:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
Respuesta a preguntas
Enumera tus colecciones y documentos, luego ejecuta el ejemplo de preguntas y respuestas:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --questionAnswer
Introduce el ID de colección, el ID de documento y la pregunta cuando se solicite.
Resumen de documento
Identifica la colección y documento, luego ejecuta el ejemplo de resumen:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --summarize
Introduzca el ID de colección e ID de documento cuando se solicite.
Búsqueda de contexto
Identificar la colección y el documento y, a continuación, ejecutar el ejemplo de búsqueda de contexto:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --context-search
Introduzca el ID de colección, el ID de documento y el texto de búsqueda cuando se solicite.
Extracción de propiedades
Identifique la colección y el documento y, a continuación, ejecute el ejemplo de extracción:
python collection.py --action list
python collection.py --action get_documents --collection-id <collection-id>
python inference.py --extract
Introduce el ID de colección, el ID de documento, el nombre de la Propiedad, la indicación de extracción, el tipo de datos y la descripción opcional cuando se te solicite.
Continúa desarrollando con la API
La demostración de Python proporciona patrones de implementación funcionales en lugar de documentación completa de la API.
Usa Empezar con la API de base de conocimiento para comprender el modelo de recursos de la API, el ciclo de vida del documento, el comportamiento de inferencia y el manejo de respuestas.
Usa la referencia de la API de base de conocimiento cuando necesites rutas de puntos finales actuales, parámetros, esquemas de solicitud y respuesta, e información de estado.
Solución de problemas
La demostración escribe información de diagnóstico detallada en:
logs/knowledgebase-demo.log
El archivo de registro registra información a Nivel DEBUG, mientras que la consola muestra mensajes de Nivel de Advertencia y superiores.
Si falla una operación:
- Revisa logs/kinowledgebase-demo.log para detalles de solicitud y autenticación.
- Verifica la configuración en config.yaml.
- Confirma que el PDF que estás usando existe y es accesible.
- Confirma que la aplicación está usando el punto final de servicio apropiado para tu organización.
- Confirma que la identidad autenticada tiene acceso al recurso solicitado.
- Para fallos de la API, conserva el X-Request-ID devuelto en las cabeceras de respuesta cuando esté disponible.El servicio de soporte puede usar este identificador para rastrear la solicitud.
Consideraciones de implementación
- El flujo de trabajo completo acepta archivos PDF.
- La demostración administra tokens de autenticación después de que se configura el acceso a la API.
- Las operaciones de la API usan los permisos disponibles para la identidad autenticada.
- El paquete fuente incluye funcionalidad de descubrimiento de puntos finales regionales, pero los valores de puntos finales de producción deben provenir de la documentación actual de la API de base de conocimiento en lugar de valores heredados incluidos con la demostración.
