Skip to main content

marqo_index (Resource)

Schema

Required

  • index_name (String) The name of the index.
  • settings (Attributes) The settings for the index. (see below for nested schema)

Optional

Read-Only

  • marqo_endpoint (String) The Marqo endpoint used by the index

Nested Schema for settings

Required:

  • inference_type (String)
  • model (String)
  • number_of_inferences (Number)
  • number_of_replicas (Number)
  • number_of_shards (Number)
  • storage_class (String)
  • type (String)

Optional:

Nested Schema for settings.all_fields

Optional:

  • dependent_fields (Map of Number)
  • features (List of String)
  • name (String)
  • type (String)

Nested Schema for settings.ann_parameters

Optional:

Nested Schema for settings.ann_parameters.parameters

Optional:

  • ef_construction (Number)
  • m (Number)

Nested Schema for settings.audio_preprocessing

Optional:

  • split_length (Number)
  • split_overlap (Number)

Nested Schema for settings.collapse_fields

Optional:

  • min_groups (Number)
  • name (String)

Nested Schema for settings.image_preprocessing

Optional:

  • patch_method (String)

Nested Schema for settings.model_properties

Optional:

  • dimensions (Number)
  • is_marqtuned_model (Boolean)
  • model_location (Attributes) (see below for nested schema)
  • name (String)
  • tokens (Number)
  • trust_remote_code (Boolean)
  • type (String)
  • url (String)

Nested Schema for settings.model_properties.model_location

Optional:

Nested Schema for settings.model_properties.model_location.s3

Optional:

  • filename (String)
  • repo_id (String)

Nested Schema for settings.model_properties.model_location.s3

Optional:

  • bucket (String)
  • key (String)

Nested Schema for settings.text_preprocessing

Optional:

  • split_length (Number)
  • split_method (String)
  • split_overlap (Number)

Nested Schema for settings.video_preprocessing

Optional:

  • split_length (Number)
  • split_overlap (Number)

Nested Schema for timeouts

Optional:

  • create (String) Time to wait for index to be ready (e.g., '30m', '1h'). Default is 30m.
  • delete (String) Time to wait for index to be deleted (e.g., '15m', '1h'). Default is 15m.
  • update (String) Time to wait for index to be updated (e.g., '30m', '1h'). Default is 30m.