Configuration

Configuration is set through YAML. In most cases, YAML keys map to fields names in Python. The example in the previous section gave a full-featured example covering a wide array of configuration options.

Each section below describes the available configuration settings.

Embeddings

The configuration parser expects a top level embeddings key to be present in the YAML. All embeddings configuration is supported.

The following example defines an embeddings index.

  1. path: index path
  2. writable: true
  4. embeddings:
  5.   path: vector model
  6.   content: true

Three top level settings are available to control where indexes are saved and if an index is a read-only index.

path

  1. path: string

Path to save and load the embeddings index. Each API instance can only access a single index at a time.

writable

  1. writable: boolean

Determines if the input embeddings index is writable (true) or read-only (false). This allows serving a read-only index.

cloud

Cloud storage settings can be set under a cloud top level configuration group.

Pipeline

Pipelines are loaded as top level configuration parameters. Pipeline names are automatically detected in the YAML configuration and created upon startup. All pipelines are supported.

The following example defines a series of pipelines. Note that entries below are the lower-case names of the pipeline class.

  1. caption:
  3. extractor:
  4.   path: model path
  6. labels:
  8. summary:
  10. tabular:
  12. translation:

Under each pipeline name, configuration settings for the pipeline can be set.

Workflow

Workflows are defined under a top level workflow key. Each key under the workflow key is the name of the workflow. Under that is a tasks key with each task definition.

The following example defines a workflow.

  1. workflow:
  2.   sumtranslate:
  3.     tasks:
  4.         - action: summary
  5.         - action: translation

schedule

Schedules a workflow using a cron expression.

  1. workflow:
  2.   index:
  3.     schedule:
  4.       cron: 0/10 * * * * *
  5.       elements: ["api params"] 
  6.     tasks:
  7.       - task: service
  8.         url: api url
  9.       - action: index

tasks

  1. tasks: list

Expects a list of workflow tasks. Each element defines a single workflow task. All task configuration is supported.

A shorthand syntax for creating tasks is supported. This syntax will automatically map task strings to an action:value pair.

Example below.

  1. workflow:
  2.   index:
  3.     tasks:
  4.       - action1
  5.       - action2

Each task element supports the following additional arguments.

action

  1. action: string|list

Both single and multi-action tasks are supported.

The action parameter works slightly different when passed via configuration. The parameter(s) needs to be converted into callable method(s). If action is a pipeline that has been defined in the current configuration, it will use that pipeline as the action.

There are three special action names index, upsert and search. If index or upsert are used as the action, the task will collect workflow data elements and load them into defined the embeddings index. If search is used, the task will execute embeddings queries for each input data element.

Otherwise, the action must be a path to a callable object or function. The configuration parser will resolve the function name and use that as the task action.

task

  1. task: string

Optionally sets the type of task to create. For example, this could be a file task or a retrieve task. If this is not specified, a generic task is created. The list of workflow tasks can be found here.

args

  1. args: list

Optional list of static arguments to pass to the workflow task. These are combined with workflow data to pass to each __call__.