Targets

Where you want your predictions to go

Now that you've declared the predictions you want to deploy with a scope, you'll add one or more Targets to indicate where they should be deployed.

Targets

Faraday continuously renders each scope in the system to produce a spreadsheet-like table where each payload element gets a column and each member of the population gets a row. When you add a target, you're telling Faraday to copy the "spreadsheet" to a place where you can retrieve the predictions you need to support your business.

Available targets

Faraday natively supports many deployment targets. They organize into two categories:

  • Publication targets — Faraday hosts your predictions for convenient retrieval as needed.
  • Replication targets — Faraday copies your predictions to systems you control.

Publication targets

Often the easiest to start with, publication targets are securely hosted by Faraday, so they don't require you to establish connections to your systems up front.

Currently supported:

  • CSV — Faraday hosts a CSV for you to retrieve by your choice of protocol: HTTPS, S3, GCS, or SFTP.
  • API — Faraday hosts your predictions in a high-speed JSON key-value store for you to retrieve individually in real time using an HTTP API.

Coming soon:

  • SQL — Faraday hosts your predictions in a SQL-compatible database table for you to query as needed.

Replication targets

Faraday can also copy your predictions to a system you control. You'll first need to establish a Connection to that system, then you can add the corresponding target to your scope.

Under the hood, Faraday uses its open-source dbcrossbar tool to replicate your data from the Faraday platform to your systems. Currently, dbcrossbar supports the following:

System

Format

Redshift

Table

BigQuery

Table

PostgreSQL

Table

AWS S3

CSV file

Google Cloud Storage (GCS)

CSV file

Adding a target

You'll use POST /targets queries to add targets. Here's a sample request:

curl --request POST \
     --url https://api.faraday.io/v1/targets \
     --header 'Authorization: Bearer YOUR_API_TOKEN' \
     --header 'Content-Type: application/json' \
     --data '
{
     "scope_id": "YOUR_SCOPE_ID",
     "options": {
         "type": "hosted_csv"
     }
}
'

Adding publication targets only requires a type parameter; replication targets require an existing Connection and additional parameters. See the docs on individual targets for more information.

👍

You're done!

That's all there is to making and deploying predictions with Faraday. If you haven't already, check out one of the quickstart tutorials listed below. Also, feel free to join our Discord anytime to share ideas and get help.


What's next

Give Faraday a try with one of our quickstart tutorials: