[fl] feat: add support for writing filonov results to tables

* Add support for writing filonov results to files / tables
  * Add GenerateDashboardRequest to handle writing; rename
    CreativeMapGenerateRequest to GenerateCreativeMapRequest and extract
    common functionality between two into BaseRequest class
  * Update CLI to have two new flags - output (either `map` or
    `dashboard`) and `writer` (to handle writing dashboard sources); parse
    writer parameters from CLI as well.
  * Update server to handle dashboard generation and unify structure of
    routes (`/filonov/<OUTPUT>/<SOURCE_TYPE>`)

* Server entrypoint updates:
  * Add support for enabling cache via `FILONOV_ENABLE_CACHE` env variable
  * Add `dbm` source
  * Add support for specifying port

* Update and simplify documentation

Change-Id: I93d8ff2fd8d8da7b1e70692f39c8ae4a39f4d3a2

Author: AndreyMarkinPPC

docs/get-started/customization.md

@@ -20,12 +20,17 @@
 """
 
 from filonov.creative_map import CreativeMap
-from filonov.filonov_service import CreativeMapGenerateRequest, FilonovService
+from filonov.filonov_service import (
+  FilonovService,
+  GenerateCreativeMapRequest,
+  GenerateTablesRequest,
+)
 
 __all__ = [
   'FilonovService',
-  'CreativeMapGenerateRequest',
+  'GenerateCreativeMapRequest',
+  'GenerateTablesRequest',
   'CreativeMap',
 ]
 
-__version__ = '0.9.0'
+__version__ = '0.10.0'

docs/get-started/load.png

@@ -15,13 +15,15 @@
 
 # pylint: disable=C0330, g-bad-import-order, g-multiple-import
 
+import enum
 from typing import Optional
 
 import media_fetching
 import media_similarity
 import media_tagging
 import typer
 from garf_executors.entrypoints import utils as garf_utils
+from garf_io import writer as garf_writer
 from media_fetching.sources import models
 from media_tagging import media
 from media_tagging.entrypoints import utils as tagging_utils
@@ -36,6 +38,24 @@
 initialize_tracer()
 typer_app = typer.Typer()
 
+Tagger = Annotated[
+  Optional[str],
+  typer.Option(
+    help='Type of tagger',
+  ),
+]
+Writer = Annotated[
+  garf_writer.WriterOption,
+  typer.Option(
+    help='Type of writer used to write results',
+  ),
+]
+
+
+class Output(str, enum.Enum):
+  map = 'map'
+  tables = 'tables'
+
 
 def _version_callback(show_version: bool) -> None:
   if show_version:
@@ -64,13 +84,14 @@ def main(
       case_sensitive=False,
     ),
   ] = 'IMAGE',
-  tagger: Annotated[
-    Optional[str],
+  tagger: Tagger = None,
+  output: Annotated[
+    Output,
     typer.Option(
-      help='Type of tagger',
-      case_sensitive=False,
+      help='Type of output',
     ),
-  ] = None,
+  ] = Output.map,
+  writer: Writer = 'csv',
   output_name: Annotated[
     str,
     typer.Option(
@@ -143,7 +164,7 @@ def main(
     media_fetching.enrichers.enricher.AVAILABLE_MODULES.keys()
   )
   parsed_param_keys = set(
-    [source, 'tagger', 'similarity'] + list(supported_enrichers)
+    [source, 'tagger', 'similarity', writer] + list(supported_enrichers)
   )
   extra_parameters = garf_utils.ParamsParser(parsed_param_keys).parse(ctx.args)
   fetching_service = media_fetching.MediaFetchingService.from_source_alias(
@@ -179,33 +200,44 @@ def main(
   if source == 'youtube':
     media_type = 'YOUTUBE_VIDEO'
     tagger = 'gemini'
-  request = filonov.CreativeMapGenerateRequest(
-    source=source,
-    media_type=media_type,
-    tagger=tagger,
-    tagger_parameters=extra_parameters.get('tagger'),
-    similarity_parameters=extra_parameters.get('similarity'),
-    source_parameters=extra_parameters.get(source),
-    output_parameters=filonov.filonov_service.OutputParameters(
-      output_name=output_name
-    ),
-    parallel_threshold=parallel_threshold,
-    trim_tags_threshold=trim_tags_threshold,
-    embed_previews=embed_previews,
-    omit_series=omit_series,
-    context=extra_parameters,
-  )
-  span.set_attribute(
-    'filonov.cli.command', utils.build_cli_command(request, db_uri)
-  )
+  params = {
+    'source': source,
+    'media_type': media_type,
+    'tagger': tagger,
+    'tagger_parameters': extra_parameters.get('tagger'),
+    'similarity_parameters': extra_parameters.get('similarity'),
+    'source_parameters': extra_parameters.get(source),
+    'parallel_threshold': parallel_threshold,
+    'trim_tags_threshold': trim_tags_threshold,
+    'context': extra_parameters,
+  }
   filonov_service = filonov.FilonovService(
     fetching_service, tagging_service, similarity_service
   )
-  generated_map = filonov_service.generate_creative_map(request)
-  destination = utils.build_creative_map_destination(
-    request.output_parameters.output_name
+  if output == 'tables':
+    request = filonov.GenerateTablesRequest(
+      **params,
+      writer=writer,
+      writer_parameters=extra_parameters.get(writer, {}),
+    )
+    filonov_service.generate_tables(request)
+  else:
+    request = filonov.GenerateCreativeMapRequest(
+      **params,
+      output_parameters=filonov.filonov_service.OutputParameters(
+        output_name=output_name
+      ),
+      embed_previews=embed_previews,
+      omit_series=omit_series,
+    )
+    generated_map = filonov_service.generate_creative_map(request)
+    destination = utils.build_creative_map_destination(
+      request.output_parameters.output_name
+    )
+    generated_map.save(destination)
+  span.set_attribute(
+    'filonov.cli.command', utils.build_cli_command(request, db_uri)
   )
-  generated_map.save(destination)
 
 
 if __name__ == '__main__':