Update a feature store

patchhttps://api.faraday.ai/v1/feature_stores/{feature_store_id}

Update the configuration of a feature store

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

feature_store_idstring<uuid>required

The UUID of a feature store

Responses

200Information about the feature store

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.

default_selector_by_purposeobjectrequired

Default selector hints organized by purpose (modeling, inference, append). These serve as fallbacks when individual attributes don't specify their own selectors.

Properties of object

appendobject

Selector hints for append purposes.

Properties of object

authorityarray[string]

List of allowed authorities.

Example: ["epsilon","verisk"]

derivationsarray[string]

List of allowed derivation methods.

Example: ["modeled","collected"]

precisionarray[string]

List of allowed precision levels.

Example: ["person"]

qualityarray[string]

List of allowed quality levels.

Example: ["1"]

inferenceobject

Selector hints for inference purposes.

Properties of object

authorityarray[string]

List of allowed authorities.

Example: ["epsilon","verisk"]

derivationsarray[string]

List of allowed derivation methods.

Example: ["modeled","collected"]

precisionarray[string]

List of allowed precision levels.

Example: ["person"]

qualityarray[string]

List of allowed quality levels.

Example: ["1"]

modelingobject

Selector hints for modeling purposes.

Properties of object

authorityarray[string]

List of allowed authorities.

Example: ["epsilon","verisk"]

derivationsarray[string]

List of allowed derivation methods.

Example: ["modeled","collected"]

precisionarray[string]

List of allowed precision levels.

Example: ["person"]

qualityarray[string]

List of allowed quality levels.

Example: ["1"]

descriptionstringrequired

A description of the feature store and its contents.

Example: "Curated collection of demographic and behavioral attributes"

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.

literatestringrequired

A human-readable name for the feature store.

Example: "Faraday Internal Graph"

namestringrequired

The slug name of the feature store. Must start with a letter and contain only lowercase letters, numbers, and underscores.

Example: "fig"

Match pattern: ^[a-z][a-z0-9_]*$

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.

updated_atstring<date-time>required

When this resource was last updated.

versionintegerrequired

The version number of the feature store.

Example: 1

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

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

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

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

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

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

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

feature_stores

Test request

API key

Prefer using test/development API keys here.

Path parameters

feature_store_id*

Request body (JSON)

Request snippet

curl -X PATCH 'https://api.faraday.ai/v1/feature_stores/{feature_store_id}' \
  -H 'Content-Type: application/json+merge-patch' \
  -H 'Authorization: Bearer YOUR_API_KEY' \
  -d '{
      "default_selector_by_purpose": {
        "append": {
          "authority": [
            "epsilon",
            "verisk"
          ],
          "derivations": [
            "modeled",
            "collected"
          ],
          "precision": [
            "person"
          ],
          "quality": [
            "1"
          ]
        },
        "inference": {
          "authority": [
            "epsilon",
            "verisk"
          ],
          "derivations": [
            "modeled",
            "collected"
          ],
          "precision": [
            "person"
          ],
          "quality": [
            "1"
          ]
        },
        "modeling": {
          "authority": [
            "epsilon",
            "verisk"
          ],
          "derivations": [
            "modeled",
            "collected"
          ],
          "precision": [
            "person"
          ],
          "quality": [
            "1"
          ]
        }
      },
      "description": "Curated collection of demographic and behavioral attributes",
      "literate": "Faraday Internal Graph",
      "name": "fig",
      "version": 1
    }'

Example response

application/json

{
  "archived_at": "2024-01-01T12:00:00Z",
  "created_at": "2024-01-01T12:00:00Z",
  "default_selector_by_purpose": {
    "append": {
      "authority": [
        "epsilon",
        "verisk"
      ],
      "derivations": [
        "modeled",
        "collected"
      ],
      "precision": [
        "person"
      ],
      "quality": [
        "1"
      ]
    },
    "inference": {
      "authority": [
        "epsilon",
        "verisk"
      ],
      "derivations": [
        "modeled",
        "collected"
      ],
      "precision": [
        "person"
      ],
      "quality": [
        "1"
      ]
    },
    "modeling": {
      "authority": [
        "epsilon",
        "verisk"
      ],
      "derivations": [
        "modeled",
        "collected"
      ],
      "precision": [
        "person"
      ],
      "quality": [
        "1"
      ]
    }
  },
  "description": "Curated collection of demographic and behavioral attributes",
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "last_read_input_at": "2024-01-01T12:00:00Z",
  "last_updated_config_at": "2024-01-01T12:00:00Z",
  "last_updated_output_at": "2024-01-01T12:00:00Z",
  "literate": "Faraday Internal Graph",
  "name": "fig",
  "resource_type": "string",
  "status": "pending",
  "status_changed_at": "2024-01-01T12:00:00Z",
  "status_error": "string",
  "updated_at": "2024-01-01T12:00:00Z",
  "version": 1
}