Skip to content

The easy-to-use open source Business Intelligence and Embedded Analytics tool that lets everyone work with data :bar_chart:

Auto-update documentation for master (#76566)

github-automation-metabase362883f8294e
diff --git a/docs/api.json b/docs/api.json
index 9cc04ef520f..b8f60d9e3eb 100644
--- a/docs/api.json
+++ b/docs/api.json
@@ -17338,7 +17338,7 @@
"post" : {
"operationId" : "post-api-card-card-id-query-export-format",
"summary" : "POST /api/card/{card-id}/query/{export-format}",
- "description" : "Run the query associated with a Card, and return its results as a file in the specified format.\n\n `parameters`, `pivot-results?` and `format-rows?` should be passed as application/x-www-form-urlencoded form content\n or json in the body. This is because this endpoint is normally used to power 'Download Results' buttons that use\n HTML `form` actions).",
+ "description" : "Run the query associated with a Card, and return its results as a file in the specified format.\n\n `csv_include_bom`, `parameters`, `pivot-results?` and `format-rows?` should be passed as application/x-www-form-urlencoded form content\n or json in the body. This is because this endpoint is normally used to power 'Download Results' buttons that use\n HTML `form` actions).",
"parameters" : [ {
"in" : "path",
"name" : "card-id",
@@ -17373,6 +17373,10 @@
"schema" : {
"type" : "object",
"properties" : {
+ "csv_include_bom" : {
+ "default" : false,
+ "type" : "boolean"
+ },
"format_rows" : {
"default" : false,
"type" : "boolean"
@@ -23387,6 +23391,10 @@
"schema" : {
"type" : "object",
"properties" : {
+ "csv_include_bom" : {
+ "default" : false,
+ "type" : "boolean"
+ },
"format_rows" : {
"default" : false,
"type" : "boolean"
@@ -42617,7 +42625,7 @@
"get" : {
"operationId" : "get-api-search",
"summary" : "GET /api/search",
- "description" : "Search for items in Metabase.\n For the list of supported models, check [[metabase.search.config/all-models]].\n\n `context` identifies the surface issuing the search; it selects the ranking weights and filter defaults.\n It defaults to `api`, the value for programmatic callers.\n\n Filters:\n - `archived`: set to true to search archived items only, default is false\n - `table_db_id`: search for tables, cards, and models of a certain DB\n - `models`: only search for items of specific models. If not provided, search for all models\n - `filter_items_in_personal_collection`: only search for items in personal collections\n - `created_at`: search for items created at a specific timestamp\n - `created_by`: search for items created by a specific user\n - `last_edited_at`: search for items last edited at a specific timestamp\n - `last_edited_by`: search for items last edited by a specific user\n - `search_native_query`: set to true to search the content of native queries\n - `vector_search_strategy`: for the semantic engine, `hnsw` (approximate index search, default) or `brute-force` (exact filter-first search); ignored by other engines\n - `verified`: set to true to search for verified items only (requires Content Management or Official Collections premium feature)\n - `ids`: search for items with those ids, works iff single value passed to `models`\n - `display_type`: search for cards/models with specific display types\n - `non_temporal_dim_ids`: search for cards/metrics/datasets with this exact set of non temporal dimension field IDs (requires appdb engine)\n - `has_temporal_dim`: set to true for cards/metrics/datasets with 1 or more temporal dimensions (requires appdb engine)\n\n Note that not all item types support all filters, and the results will include only models that support the provided\n filters. For example:\n\n - The `created-by` filter supports dashboards, models, actions, and cards.\n - The `verified` filter supports models and cards.\n\n A search query that has both filters applied will only return models and cards.",
+ "description" : "Search for items in Metabase.\n For the list of supported models, check [[metabase.search.config/all-models]].\n\n `context` identifies the surface issuing the search; it selects the ranking weights and filter defaults.\n It defaults to `api`, the value for programmatic callers.\n\n Filters:\n - `archived`: set to true to search archived items only, default is false\n - `table_db_id`: search for tables, cards, and models of a certain DB\n - `models`: only search for items of specific models. If not provided, search for all models\n - `filter_items_in_personal_collection`: only search for items in personal collections\n - `created_at`: search for items created at a specific timestamp\n - `created_by`: search for items created by a specific user\n - `last_edited_at`: search for items last edited at a specific timestamp\n - `last_edited_by`: search for items last edited by a specific user\n - `search_native_query`: set to true to search the content of native queries\n - `vector_search_strategy`: for the semantic engine: `hnsw` (approximate index search, default),\n `brute-force` (exact filter-first search), or `hnsw-iterative-relaxed` / `hnsw-iterative-strict`\n (index-backed iterative scans with inline filters); ignored by other engines\n - `vector_search_ef_search`: override pgvector's `hnsw.ef_search` (1-1000) for the iterative strategies; (admin only)\n - `vector_search_max_scan_tuples`: override pgvector's `hnsw.max_scan_tuples` for the iterative strategies; (admin only)\n - `vector_search_explain`: set to true to record vector-scan instrumentation for this search (expensive); (admin only)\n - `verified`: set to true to search for verified items only (requires Content Management or Official Collections premium feature)\n - `ids`: search for items with those ids, works iff single value passed to `models`\n - `display_type`: search for cards/models with specific display types\n - `non_temporal_dim_ids`: search for cards/metrics/datasets with this exact set of non temporal dimension field IDs (requires appdb engine)\n - `has_temporal_dim`: set to true for cards/metrics/datasets with 1 or more temporal dimensions (requires appdb engine)\n\n Note that not all item types support all filters, and the results will include only models that support the provided\n filters. For example:\n\n - The `created-by` filter supports dashboards, models, actions, and cards.\n - The `verified` filter supports models and cards.\n\n A search query that has both filters applied will only return models and cards.",
"parameters" : [ {
"in" : "query",
"name" : "q",
@@ -42804,7 +42812,44 @@
"schema" : {
"oneOf" : [ {
"type" : "string",
- "enum" : [ "hnsw", "brute-force" ]
+ "enum" : [ "hnsw", "brute-force", "hnsw-iterative-relaxed", "hnsw-iterative-strict" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "vector_search_ef_search",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1,
+ "maximum" : 1000
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "vector_search_max_scan_tuples",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1,
+ "maximum" : 2147483647
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "vector_search_explain",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
}, {
"type" : "null"
} ]
@@ -43111,7 +43156,44 @@
"schema" : {
"oneOf" : [ {
"type" : "string",
- "enum" : [ "hnsw", "brute-force" ]
+ "enum" : [ "hnsw", "brute-force", "hnsw-iterative-relaxed", "hnsw-iterative-strict" ]
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "vector_search_ef_search",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1,
+ "maximum" : 1000
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "vector_search_max_scan_tuples",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "integer",
+ "minimum" : 1,
+ "maximum" : 2147483647
+ }, {
+ "type" : "null"
+ } ]
+ }
+ }, {
+ "in" : "query",
+ "name" : "vector_search_explain",
+ "required" : false,
+ "schema" : {
+ "oneOf" : [ {
+ "type" : "boolean"
}, {
"type" : "null"
} ]
@@ -46712,6 +46794,17 @@
"minimum" : 1
}
},
+ "table_dependencies" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
"can_write" : {
"type" : "boolean"
},
@@ -47065,6 +47158,17 @@
"minimum" : 1
}
},
+ "table_dependencies" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
"can_write" : {
"type" : "boolean"
},
@@ -49586,6 +49690,17 @@
"minimum" : 1
}
},
+ "table_dependencies" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
"can_write" : {
"type" : "boolean"
},
@@ -49947,6 +50062,17 @@
"minimum" : 1
}
},
+ "table_dependencies" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
"can_write" : {
"type" : "boolean"
},
@@ -50445,6 +50571,17 @@
"minimum" : 1
}
},
+ "table_dependencies" : {
+ "oneOf" : [ {
+ "type" : "array",
+ "items" : {
+ "type" : "object",
+ "properties" : { }
+ }
+ }, {
+ "type" : "null"
+ } ]
+ },
"can_write" : {
"type" : "boolean"
},