{"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"search","__idx":0},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search"]}]},{"$$mdtype":"Tag","name":"ConfigOptionRequirements","attributes":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Pro","Enterprise","Enterprise+"]},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Customize the search functionality in your project."," ","By default, search appears in the top navigation bar in the far right corner."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search"]}," configuration to:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["hide the search bar"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["add keyboard shortcuts for search activation"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["add suggested pages to the search modal"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["configure search facets for advanced filtering"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["boost the ranking of pages for specific search terms"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["prevent pages from appearing for specific search terms"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To query search programmatically (for example, with scripts or Model Context Protocol), use the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/customization/search-api/openapi"},"children":["Search API"]}," which contains authentication, request parameters, and response format."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search"]}," option also supports page-level configuration using front matter."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"search-engines","__idx":1},"children":["Search engines"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Redocly supports two types of search engines for your project:"]},{"$$mdtype":"Tag","name":"ol","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["FlexSearch"]},": The default search engine that supports limited facets configuration."," ","You can only adjust the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#group-facets"},"children":["group facet"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Typesense"]},": An advanced search engine with full facets configuration capabilities."," ","Requires an Enterprise or Enterprise+ plan."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"default-search-configuration","__idx":2},"children":["Default search configuration"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"default-categories","__idx":3},"children":["Default categories"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The default search configuration applies to all documents and includes two predefined search categories:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Documentation"]},": Includes all Markdown files present in the project."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["API Reference"]},": All OpenAPI, GraphQL, AsyncAPI, and SOAP API definitions."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["These categories are configured using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_category"]}," facet field and are visible when you open the search dialog."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"default-facets","__idx":4},"children":["Default facets"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["For search engines that support full facets configuration capabilities (Typesense), Redocly provides an additional filter panel featuring predefined facets:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"search:\n  filters:\n    facets:\n      - name: Category\n        field: redocly_category\n        type: multi-select\n      - name: HTTP Method\n        field: httpMethod\n        type: tags\n      - name: HTTP Path\n        field: httpPath\n        type: multi-select\n      - name: API Title\n        field: apiTitle\n        type: multi-select\n      - name: API Version\n        field: apiVersion\n        type: select\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"options","__idx":5},"children":["Options"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["engine"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Specifies the search engine type."," ","Typesense requires an Enterprise or Enterprise+ plan."," ","Possible values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flexsearch"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["typesense"]},"."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["flexsearch"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hide"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hides the search bar when set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."," ","Search cannot be opened with keyboard shortcuts."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["shortcuts"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Keyboard shortcuts that activate search (for example, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ctrl+f"]},")."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["⌘+k"]}," or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ctrl+k"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["suggestedPages"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#page-item-object"},"children":["Page item"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of suggested pages."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["filters"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#filters-item-object"},"children":["Filters item"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Advanced filters configuration."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["ai"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["[",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#ai-search-options"},"children":["AI search options"]},"]"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AI search options."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Deprecated configuration"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ai"]}," property is deprecated."," ","Use ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/ai-assistant"},"children":["AI Assistant"]}," option instead."]}]}]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"page-item-object","__idx":6},"children":["Page item object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["page"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," ","Path to the file representing the linked page."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["label"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Link text displayed for the item."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["labelTranslationKey"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Link text key used for ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/l10n"},"children":["localization"]},"."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"filters-item-object","__idx":7},"children":["Filters item object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hide"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hides the search filter panel when set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["facets"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"#facet-item-object"},"children":["Facet item"]},"]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of user-defined search facets."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"facet-item-object","__idx":8},"children":["Facet item object"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["name"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," ","Name of the facet."," ","Acts as a label for the filtering control in the search dialog."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["field"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," ","Facet ID."," ","Use this ID as a key in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadata"]}," section when adding facets to a page."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["type"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["REQUIRED."]}," ","Control displayed in the search dialog."," ","Values: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["multi-select"]}," (select multiple filter values), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["select"]}," (select a single filter value), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["tags"]}," (applies only to HTTP method facet)."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["isTop"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Indicates whether the facet is a top-level facet."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"ai-search-options","__idx":9},"children":["AI search options"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Deprecated configuration"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ai"]}," property is deprecated."," ","Use ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/ai-assistant"},"children":["AI Assistant"]}," option instead."]}]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["hide"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["boolean"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Hides the AI search button when set to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["true"]},"."," ","Default: ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["false"]},"."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["prompt"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["string"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Built-in instructions for AI search."," ","Applied to all AI searches in the project and not visible to users."," ","Use to set greeting, tone, or other answer conditions."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["suggestions"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of suggestions displayed in the AI search interface."]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Data usage and privacy:"]}," Curious how the AI assistant uses your data?"," ","The Redocly AI assistant runs in ",{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["inference-only mode"]}," and does not train or fine-tune AI models on your content."," ","For details, see the ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/faq/ai-governance"},"children":["AI governance and security FAQ"]},"."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Make content private"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excludeFromSearch"]}," option excludes content from search (both AI search and keyword search), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["llms.txt"]},", and sitemap."," ","See ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/front-matter-config#front-matter-only-options"},"children":["excludeFromSearch documentation"]}," for details."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["AI search and Typesense search indexes are only built on the production branch."," ","Changes to search configuration or content exclusions, like the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excludeFromSearch"]}," front matter option, appear in search results after the next production build."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"apply-facets-to-files","__idx":10},"children":["Apply facets to files"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["To apply facets to files, use metadata properties."," ","You can assign specific metadata to your files, such as custom facet fields for advanced filtering or predefined ones like ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_category"]}," for grouping."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"markdown-files","__idx":11},"children":["Markdown files"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Apply facets to Markdown files using front matter:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"index.md","header":{"title":"index.md","controls":{"copy":{}}},"source":"---\nmetadata: \n  redocly_category: Custom \n  owner: Redocly\n---\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"openapi-definitions","__idx":12},"children":["OpenAPI definitions"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Apply facets to OpenAPI definitions using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-metadata"]}," extension:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"museum.yaml","header":{"title":"museum.yaml","controls":{"copy":{}}},"source":"openapi: 3.1.0\ninfo:\n  version: 2.3.3\n  title: Museum\n  x-metadata:\n    redocly_category: Custom\n    owner: Redocly\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"use-metadataglobs","__idx":13},"children":["Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadataGlobs"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["metadataGlobs"]}," property in your ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly.yaml"]}," configuration file to apply facets to files using glob patterns:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"metadataGlobs:\n  'museum/**':\n    redocly_category: Museum\n  'payments/**':\n    redocly_category: Payments\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"group-facets","__idx":14},"children":["Group facets"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The group facet categorizes search results and is displayed in the top panel of the search dialog for quick switching between categories."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Only ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_category"]}," facet field is used as a group facet."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"curate-search-results","__idx":15},"children":["Curate search results"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Influence the ranking of specific pages in search results for particular search terms."," ","Use the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keywords"]}," option in the front matter of a page or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-keywords"]}," in an OpenAPI description file."," ","These options boost the page to the top of search results or exclude the page from appearing for certain keywords."]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Curation is only available for the Typesense search engine, which requires an Enterprise or Enterprise+ plan."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Behavior of pages with keywords:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["For each keyword in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["includes"]},", the page is promoted to the top position in search results."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You can use the same keyword in multiple pages."," ","The pages appear at the top of search results in the order they were indexed by the search engine."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Keywords are not case-sensitive."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The word order in keywords is preserved: searching for \"pay apple\" won't trigger a keyword \"apple pay\"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The first matching keyword triggers curation and stops additional keywords from being processed for that search."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"curation-parameters","__idx":16},"children":["Curation parameters"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Configure curation using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["keywords"]}," object:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Option"},"children":["Option"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Type"},"children":["Type"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Description"},"children":["Description"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["includes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of keywords or phrases that promote this page to the top of search results when these terms are used in the search query."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["excludes"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["[string]"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["List of keywords or phrases that prevent this page from appearing in search results when these terms are used in the search query."," ","Overrides ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["includes"]}," for the same keyword."]}]}]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"apply-curation-to-files","__idx":17},"children":["Apply curation to files"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"markdown-files-1","__idx":18},"children":["Markdown files"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Apply curation to Markdown files using front matter:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"payments.md","header":{"title":"payments.md","controls":{"copy":{}}},"source":"---\nkeywords:\n  includes:\n    - apple pay\n    - apple wallet\n    - digital wallet\n  excludes:\n    - google pay\n    - paypal\n---\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"openapi-description-files","__idx":19},"children":["OpenAPI description files"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Apply curation to OpenAPI definitions using the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["x-keywords"]}," extension."," ","You can apply curation at three different levels:"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"description-level","__idx":20},"children":["Description level"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Apply curation to the root document of the API description."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["includes"]}," keywords boost the root document to the top of search results."," ","The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excludes"]}," keywords remove the entire description file from search results for these terms."]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"payments.yaml","header":{"title":"payments.yaml","controls":{"copy":{}}},"source":"openapi: 3.0.0\nx-keywords:\n  includes:\n    - payment api\n    - transaction\n  excludes:\n    - deprecated\ninfo:\n  version: 1.0.0\n  title: Payment API\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"tag-level","__idx":21},"children":["Tag level"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Apply curation to a specific tag:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"payments.yaml","header":{"title":"payments.yaml","controls":{"copy":{}}},"source":"tags:\n  - name: payments\n    description: Payment operations\n    x-keywords:\n      includes:\n        - wallet\n        - checkout\n      excludes:\n        - refund\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":5,"id":"operation-level","__idx":22},"children":["Operation level"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Apply curation to individual operations:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"payments.yaml","header":{"title":"payments.yaml","controls":{"copy":{}}},"source":"paths:\n  /payments:\n    post:\n      tags:\n        - payments\n      summary: Create a payment\n      description: Process a new payment transaction.\n      operationId: createPayment\n      x-keywords:\n        includes:\n          - apple pay\n          - credit card\n        excludes:\n          - google pay\n          - paypal\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":4,"id":"react-pages","__idx":23},"children":["React pages"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Apply curation to React pages using front matter:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"tsx","data-title":"index.page.tsx","header":{"title":"index.page.tsx","controls":{"copy":{}}},"source":"export const frontmatter = {\n  search: {\n    title: 'React gitlab page',\n    description: 'Test description for search',\n    keywords: {\n      includes: ['github', 'swc', 'page'],\n      excludes: ['git', 'gitlab'],\n    },\n  }\n};\n","lang":"tsx"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"examples","__idx":24},"children":["Examples"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"basic-search-configuration","__idx":25},"children":["Basic search configuration"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Hide the search bar:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"search:\n  hide: true\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set keyboard shortcuts for search:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"search:\n  shortcuts:\n    - ctrl+f\n    - cmd+k\n    - /\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set suggested pages for the search modal:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"search:\n  suggestedPages:\n    - label: Home page\n      page: index.page.tsx\n    - page: /catalog/\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"search-facets","__idx":26},"children":["Search facets"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Override the default ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["redocly_category"]}," facet:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"search:\n  filters:\n    facets:\n      - name: Custom \n        field: redocly_category\n        type: select           \n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Create a custom facet:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"search:\n  filters:\n    facets:\n      - name: Owner\n        field: owner\n        type: select            \n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Override all default search facets:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"search:\n  filters:\n    facets:\n      - name: Category\n        field: redocly_category\n        type: multi-select\n      - name: HTTP Method\n        field: httpMethod\n        type: tags\n      - name: HTTP Path\n        field: httpPath\n        type: multi-select\n      - name: API Title\n        field: apiTitle\n        type: multi-select\n      - name: API Version\n        field: apiVersion\n        type: select\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"ai-search","__idx":27},"children":["AI search"]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"warning","name":"Deprecated configuration"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ai"]}," property is deprecated."," ","Use ",{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/ai-assistant"},"children":["AI Assistant"]}," option instead."]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Display the AI search button with a custom prompt:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"search:\n  ai:\n    hide: false\n    prompt: Speak only in rhymes\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Set AI search suggestions:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"yaml","data-title":"redocly.yaml","header":{"title":"redocly.yaml","controls":{"copy":{}}},"source":"search:\n  ai:\n    hide: false\n    suggestions:\n      - How to create a new API?\n      - What is Redocly?\n      - How to manage an organization?\n","lang":"yaml"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"resources","__idx":28},"children":["Resources"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/metadata-globs"},"children":["MetadataGlobs configuration"]}]}," - Configure metadata extraction patterns for enhanced search functionality and content organization"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/l10n"},"children":["Localization configuration"]}]}," - Configure search functionality for multiple languages and international content support"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/navbar"},"children":["Configure navbar"]}]}," - Configure navigation bar settings including search integration and search button customization"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/navigation"},"children":["Build navigation"]}]}," - Configure navigation elements in your project for comprehensive site structure and search integration"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/content/localization/translation-keys"},"children":["Predefined translation keys"]}]}," - Use predefined translation keys for search interface localization and internationalization"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config/front-matter-config"},"children":["Front matter configuration options"]}]}," - Configure search dialog behavior on individual pages using front matter, including ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["excludeFromSearch"]}," option to exclude specific pages from search results"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":[{"$$mdtype":"Tag","name":"Link","attributes":{"href":"/docs/realm/config"},"children":["Configuration options"]}]}," - Explore other project configuration options for comprehensive documentation and platform customization"]}]}]},"frontmatter":{"products":["Redoc","Revel","Reef","Realm"],"plans":["Pro","Enterprise","Enterprise+"],"description":"Customize the search functionality in your project."},"tagList":["admonition","configOptionRequirements","html","partial","table"],"title":"search","lastModified":"2026-10-01T23:00:57.000Z"}