Actions7
- Document & Key-Value Actions
- Search Actions
Search → Search & Retrieve
AI-generatedSummary
Performs a full-text search against a configured Couchbase Search index and returns matching documents.
Inputs
- searchQuery (required) — The full-text search query string to execute against the index.
- indexName (required) — The name of the search index to query. Can be selected from a list or typed manually.
- fieldsToReturn — Comma-separated list of fields to return in results. Defaults to '*' (all fields).
- resultsLimit — Maximum number of results to return. Defaults to 5.
- includeLocations — Whether to include term locations in the search results. Defaults to false.
- advancedMode — Enables advanced mode to provide a raw JSON query instead of a simple string.
- rawQuery — A raw search query in JSON format. Only visible when advancedMode is enabled.
Output shape
A list of items, each representing a search result document.
If no results are found, returns a single item with a 'message' field stating 'No results found'.
Examples
Example 1: Simple keyword search
Index: 'my_index', Search Query: 'error', Limit: 10
Example 2: Filtered search with specific fields
Index: 'products', Search Query: 'laptop', Fields to Return: 'name,price,description', Limit: 5
Example 3: Advanced JSON query
Advanced Mode: On, Raw Query: { 'query': { 'match': { 'title': { 'query': 'couchbase' } } }, 'limit': 20 }