Edit a recommender

patchhttps://api.faraday.ai/v1/recommenders/{recommender_id}

Edit configuration of a recommender

Authentication

Bearer Authentication

Provide your API key in the Authorization header. You can find your API key in the Settings page of the dashboard.

Authorization: Bearer YOUR_TOKEN

path parameters

recommender_idstring<uuid>required

The UUID of a recommender

Body

Fields to update on the existing recommender. To delete an optional field, set it to null.

namestring

Human-readable label for this recommender. Each recommender must have a unique name.

Match pattern: ^(?!\s*$).+
Maximum characters: 64
predictorsone of 2 types
Properties of one of 2 types
One of:
blockedone of 2 types
Properties of one of 2 types
One of:
attributesone of 2 types

Attributes to block, named as in GET /attributes. Only for accounts that use attributes.

Properties of one of 2 types
One of:
Array of:
string
Match pattern: ^fig/[a-z_][a-z_0-9]*$
categoriesone of 2 types

Categories to block. Blocks every trait or attribute in the category.

Properties of one of 2 types
One of:
Array of:
stringenum:
"fig/demography""fig/environment""fig/geography""fig/identity""fig/lifestyle""fig/life_event""fig/property""fig/reachability""fig/society""fig/financial""fig/vehicles""fig/civic""fig/engagement""user_defined"
providersone of 2 types

The name of a provider whose features should be blocked from consideration.

Options:

  • self: refers to the Account the resource belongs to.
Properties of one of 2 types
One of:
Array of:
string
Example: "self"
Match pattern: ^[a-zA-Z0-9-]*$
streamsone of 2 types

Stream-derived predictors to block, one entry per stream. An entry with only name blocks every
predictor built from the stream. An entry that lists properties or aggregates blocks only those.

Properties of one of 2 types
One of:
Items of array[object]
aggregatesone of 2 types

Patterns for the aggregates of this stream to block. Each pattern is a regular expression with no
delimiters, and it must match the whole aggregate name. Patterns block aggregates as a family, since a...

Properties of one of 2 types
One of:
Array of:
string
Minimum characters: 1
Maximum characters: 256
namestring

Name of the stream, as in GET /streams.

Example: "orders"
Maximum characters: 64
propertiesone of 2 types

Properties of this stream to block. Blocks every predictor built from each property.

Properties of one of 2 types
One of:
Array of:
string
Maximum characters: 64
traitsone of 2 types

Traits to block, named as in GET /traits. First-party traits use their plain name. On accounts without
attributes, third-party traits use their fig/ name.

Properties of one of 2 types
One of:
Array of:
string
Match pattern: ^(fig/)?[a-z][_a-z0-9]*$
max_observation_dateone of 2 types

The maximum date for FIG attribute observations used during modeling. When set, only attribute data observed on or before this date will be used. If not set, the freshest available data is used.

Properties of one of 2 types
One of:
string (date)

Pass this value to overwrite the existing value.

Title: Overwrite
previewone of 2 types

A recommender in preview mode will not build until preview is turned off.

Properties of one of 2 types
One of:
boolean

Pass this value to overwrite the existing value.

Title: Overwrite
Example: true
stream_namestring

Name of the stream to use for recommendations

Example: "orders"
stream_property_namestring

Name of the stream property

Example: "product"

Responses

200The updated recommender
archived_atstring<date-time>

If not null, this resource will no longer receive updates, but will still be visable.

created_atstring<date-time>required

When this resource was created.

idstring<uuid>required

A unique ID for this resource.

last_read_input_atstring<date-time>

The last time this resource's input was read.

last_updated_config_atstring<date-time>

The last time this resource's configuration was updated. If this is more recent than last_updated_output_at, the resource will be rebuilt.

last_updated_output_atstring<date-time>

The last time this resource successfully built.

namestringrequired

Human-readable label for this recommender. Each recommender must have a unique name.

Match pattern: ^(?!\s*$).+
Maximum characters: 64
predictorsobject

Provides control over the features used during modeling for a recommender.

Additional properties: not allowed
Properties of object
blockedobject

Predictors that modeling must not use.

Additional properties: not allowed
Properties of object
attributesarray[string]

Attributes to block, named as in GET /attributes. Only for accounts that use attributes.

Example: ["fig/age"]
categoriesarray[string enum]

Categories to block. Blocks every trait or attribute in the category.

Example: ["fig/property"]
Allowed values: fig/demography, fig/environment, fig/geography, fig/identity, fig/lifestyle, fig/life_event, fig/property, fig/reachability, fig/society, fig/financial, fig/vehicles, fig/civic, fig/engagement, user_defined
providersarray[string]

The name of a provider whose features should be blocked from consideration.

Options:

  • self: refers to the Account the resource belongs to.
streamsarray[object]

Stream-derived predictors to block, one entry per stream. An entry with only name blocks every
predictor built from the stream. An entry that lists properties or aggregates blocks only those.

Items of array[object]
aggregatesarray[string]

Patterns for the aggregates of this stream to block. Each pattern is a regular expression with no
delimiters, and it must match the whole aggregate name. Patterns block aggregates as a family, since a...

Example: ["COUNT_.*"]
Minimum items: 1
namestringrequired

Name of the stream, as in GET /streams.

Example: "orders"
Maximum characters: 64
propertiesarray[string]

Properties of this stream to block. Blocks every predictor built from each property.

Example: ["total"]
Minimum items: 1
traitsarray[string]

Traits to block, named as in GET /traits. First-party traits use their plain name. On accounts without
attributes, third-party traits use their fig/ name.

Example: ["fav_cookie"]
max_observation_datestring<date>

The maximum date for FIG attribute observations used during modeling. When set, only attribute data observed on or before this date will be used. If not set, the freshest available data is used.

previewboolean

A recommender in preview mode will not build until preview is turned off.

Example: true
report_urlstring

URL of an HTML report containing information such as the objective of the model, performance, and important features.

resource_typestringrequired

The type of this resource.

statusstringrequired

The current state of this resource and any updates.

Example: "pending"
Allowed values: new, starting, running, ready, error
status_changed_atstring<date-time>

When the status of this resource was last updated.

status_errorstring

If this resource has status == "error", this will contain an error message.

stream_namestringrequired

Name of the stream to use for recommendations

Example: "orders"
stream_property_namestringrequired

Name of the stream property

Example: "product"
updated_atstring<date-time>required

When this resource was last updated.

400The request was invalid.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

401No API key was supplied.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

403Access to this resource was forbidden.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

404The requested resource ID was not found.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

409The request was formatted correctly, but conflicted with an existing resource.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

500An internal server error occurred.
errorstringrequired

A Faraday error code.

Some possible values include:

Generic HTTP Errors

  • BAD_REQUEST: The request could not be validated.
  • FORBIDDEN: You do not have permission to access the specified resour...
Example: "ERROR_TYPE"
Allowed values: BAD_REQUEST, FORBIDDEN, MAX_RESOURCES_REACHED, INTERNAL_SERVER_ERROR, INVALID_AUTHORIZATION, NOT_FOUND, MALFORMED_API_KEY, MISSING_API_KEY, EXPIRED_API_KEY, VALIDATION_FAILED, CONFLICT, QUOTA_EXCEEDED
idstring<uuid>required

A unique ID for this error. Please include this in bug reports.

Example: "082f9513-901c-4308-8081-902a8fe22d7e"
notestringrequired

A human-readable description of the error.

Example: "An error occurred"
validationErrorsarray[object]

JSON Schema validation errors, if any.

Items of array[object]
contextobjectrequired

More information about the error.

Properties of object
errorTypestringrequired

The type of validation error which occurred.

messagestringrequired

A human-readable error message.

pathstringrequired

The location in the document that failed validation.

suggestionstring

A suggestion for fixing this error.

Tags

recommenders