búsqueda semántica sobre fragmentos

Pipeline Multimodular: Búsqueda Semántica Sobre Fragmentos

Este documento detalla un pipeline multimodular que recibe fragmentos de texto en un archivo JSON y habilita búsqueda semántica sobre ellos.

El documento se divide en las siguientes secciones:

Monta tu Pipeline
Procesa un Archivo de Entrada
Búsqueda Semántica

Monta tu Pipeline

Para lograr lo arriba descrito, monta un pipeline que consiste de los siguientes módulos en secuencia:

Un módulo text-embedder (encaje léxico).
Un módulo vector-db (base de datos vectorial).

Para esto usarás el método create_pipeline de la siguiente manera:

# crear el pipeline descrito
pipeline = krixik.create_pipeline(name="multi_busqueda_semantica_sobre_fragmentos", module_chain=["text-embedder", "vector-db"])

Procesa un Archivo de Entrada

El formato de entrada de este pipeline es un archivo JSON (dado que ese es el formato de entrada de su primer módulo). Las entradas JSON siempre deben seguir un formato específico; de lo contrario, el método process no funcionará.

Examina el archivo de prueba antes de continuar:

# examina el archivo de entrada
with open(data_dir + "input/1984_fragmentos.json", "r") as file:
    print(file.read())

[{"snippet": "It was a bright cold day in April, and the clocks were striking thirteen.", "line_numbers": [1]}, {"snippet": "Winston Smith, his chin nuzzled into his breast in an effort to escape the\nvile wind, slipped quickly through the glass doors of Victory Mansions,\nthough not quickly enough to prevent a swirl of gritty dust from entering\nalong with him.", "line_numbers": [2, 3, 4, 5]}]

Usarás los modelos predeterminados en este pipeline, así que el argumento modules del método process no hará falta.

# procesa el archivo a través del pipeline según lo arriba descrito
process_output = pipeline.process(
    local_file_path=data_dir + "input/1984_fragmentos.json",  # la ruta de archivo inicial en la que yace el archivo de entrada
    local_save_directory=data_dir + "output",  # el directorio local en el que se guardará el archivo de salida
    expire_time=60 * 30,  # data de este proceso se eliminará del sistema Krixik en 30 minutos
    wait_for_process=True,  # espera que el proceso termine antes de devolver control del IDE al usuario
    verbose=False,  # no mostrar actualizaciones de proceso al ejecutar el código
)

Reproduce la salida de este proceso con el siguiente código. Para aprender más sobre cada componente de la salida, estudia la documentación del método process.

Dado que la salida de este modelo/módulo es un archivo de base de datos FAISS, process_output se muestra como "null". Sin embargo, el archivo de salida se ha guardado en la ubicación indicada bajo process_output_files. El file_id del archivo procesado es el prefijo del nombre del archivo de salida en esta ubicación.

# nítidamente reproduce la salida de este proceso
print(json.dumps(process_output, indent=2))

{
  "status_code": 200,
  "pipeline": "multi_snippets_semantic_search",
  "request_id": "df80b7bd-d593-4cdd-bc39-4d2bdd18788e",
  "file_id": "f52906bb-eca6-408c-a929-504ea8954e76",
  "message": "SUCCESS - output fetched for file_id f52906bb-eca6-408c-a929-504ea8954e76.Output saved to location(s) listed in process_output_files.",
  "warnings": [],
  "process_output": null,
  "process_output_files": [
    "../../../data/output/f52906bb-eca6-408c-a929-504ea8954e76.faiss"
  ]
}

Busqueda Semantica

El método semantic_search de Krixik habilita búsqueda semántica sobre documentos procesados a través de ciertos pipelines. Dado que el método semantic_search hace embedding (encaje léxico) con la consulta y luego lleva a cabo la búsqueda, solo se puede usar con pipelines que de manera consecutiva contienen los módulos text-embedder (encaje léxico) y vector-db (base de datos vectorial).

Ya que tu pipeline satisface esta condición tiene acceso al método semantic_search. Úsalo de la siguiente manera para consultar el texto con lengua natural:

# haz búsqueda semántica sobre el texto procesado por el pipeline
semantic_output = pipeline.semantic_search(query="it was cold night", file_ids=[process_output["file_id"]])

# nítidamente reproduce la salida de esta búsqueda
print(json.dumps(semantic_output, indent=2))

{
  "status_code": 200,
  "request_id": "4df32bdf-bb82-44d4-8151-ffaf2fc99c18",
  "message": "Successfully queried 1 user file.",
  "warnings": [],
  "items": [
    {
      "file_id": "f52906bb-eca6-408c-a929-504ea8954e76",
      "file_metadata": {
        "file_name": "krixik_generated_file_name_xongatwbce.json",
        "symbolic_directory_path": "/etc",
        "file_tags": [],
        "num_vectors": 2,
        "created_at": "2024-06-05 15:31:41",
        "last_updated": "2024-06-05 15:31:41"
      },
      "search_results": [
        {
          "snippet": "It was a bright cold day in April, and the clocks were striking thirteen.",
          "line_numbers": [
            1
          ],
          "distance": 0.236
        },
        {
          "snippet": "Winston Smith, his chin nuzzled into his breast in an effort to escape the\nvile wind, slipped quickly through the glass doors of Victory Mansions,\nthough not quickly enough to prevent a swirl of gritty dust from entering\nalong with him.",
          "line_numbers": [
            2,
            3,
            4,
            5
          ],
          "distance": 0.429
        }
      ]
    }
  ]
}