phrase

Single Phrase Example

The following Atlas Search example performs a basic search of the title field for the query string new york. There is no slop in the query and so the slop value defaults to 0, which means the position of the words must exactly match the query string to be included in the results. The query also includes a:

• $limit stage to limit the output to 10 results.

• $project stage to exclude all fields except title and add a field named score.

1
db.movies.aggregate([
2
  {
3
    "$search": {
4
      "phrase": {
5
        "path": "title",
6
        "query": "new york"
7
      }
8
    }
9
  },
10
  { $limit: 10 },
11
  {
12
    $project: {
13
      "_id": 0,
14
      "title": 1,
15
      score: { $meta: "searchScore" }
16
    }
17
  }
18
])

1
[
2
  { title: 'New York, New York', score: 6.786321640014648 }
3
  { title: 'New York', score: 6.258549213409424 }
4
  { title: 'New York Stories', score: 5.3813982009887695 }
5
  { title: 'New York Minute', score: 5.3813982009887695 }
6
  { title: 'Synecdoche, New York', score: 5.3813982009887695 }
7
  { title: 'New York Doll', score: 5.3813982009887695 }
8
  { title: 'Little New York', score: 5.3813982009887695 }
9
  { title: 'Escape from New York', score: 4.719893455505371 }
10
  { title: 'Naked in New York', score: 4.719893455505371 }
11
  { title: 'Autumn in New York', score: 4.719893455505371 }
12
]

Multiple Phrases Example

The following Atlas Search example performs a basic search of the title field for the query strings the man and the moon. There is no slop in the query and so the slop value defaults to 0, which means the position of the words must exactly match the query string to be included in the results. The query also includes a:

1
db.movies.aggregate([
2
  {
3
    "$search": {
4
      "phrase": {
5
        "path": "title",
6
        "query": ["the man", "the moon"]
7
      }
8
    }
9
  },
10
  { $limit: 10 },
11
  {
12
    $project: {
13
      "_id": 0,
14
      "title": 1,
15
      score: { $meta: "searchScore" }
16
    }
17
  }
18
])

1
[
2
  { title: 'The Man in the Moon', score: 4.4830474853515625 },
3
  { title: 'Shoot the Moon', score: 3.252699851989746 },
4
  { title: 'Kick the Moon', score: 3.252699851989746 },
5
  { title: 'The Man', score: 2.8923356533050537 },
6
  { title: 'The Moon and Sixpence', score: 2.8528637886047363 },
7
  { title: 'The Moon Is Blue', score: 2.8528637886047363 },
8
  { title: 'Racing with the Moon', score: 2.8528637886047363 },
9
  { title: 'Mountains of the Moon', score: 2.8528637886047363 },
10
  { title: 'Man on the Moon', score: 2.8528637886047363 },
11
  { title: 'Castaway on the Moon', score: 2.8528637886047363 }
12
]

Slop Example

The following Atlas Search example performs a search of the title field for the query string men women. The slop value of 5 in the query allows greater movement of the words and distance between the words men and women. The query includes a $project stage to:

• Exclude all fields except title

• Add a field named score

1
db.movies.aggregate([
2
  {
3
    "$search": {
4
      "phrase": {
5
        "path": "title",
6
        "query": "men women",
7
        "slop": 5
8
      }
9
    }
10
  },
11
  {
12
    $project: {
13
      "_id": 0,
14
      "title": 1,
15
      score: { $meta: "searchScore" }
16
    }
17
  }
18
])

1
[
2
  { title: 'Men Without Women', score: 3.367523193359375 },
3
  { title: 'Men Vs Women', score: 3.367523193359375 },
4
  { title: 'Good Men, Good Women', score: 2.8529787063598633 },
5
  { title: 'The War Between Men and Women', score: 2.1851978302001953 },
6
  { title: 'Women Without Men', score: 1.9656763076782227 },
7
  { title: 'Women Vs Men', score: 1.9656763076782227 }
8
]

Synonyms Example

The following queries search the plot field in the movies collection for the terms in the given query string. Atlas Search returns results based on the type of mapping in the synonym source collection, synonymous_terms, specified in the synonym mapping definition of the index for the sample_mflix.movies collection.

The following query searches for the phrase automobile race anywhere in the plot field with a distance of up to 5 between the terms.

db.movies.aggregate([
  {
    $search: {
      "phrase": {
        "path": "plot",
        "query": "automobile race",
        "slop": 5,
        "synonyms": "my_synonyms"
      }
    }
  },
  {
    "$limit": 5
  },
  {
    $project: {
      "_id": 0,
      "plot": 1,
      "title": 1,
      score: { $meta: "searchScore" }
    }
  }
])

[
  {
    plot: 'When a popular daredevil proposes an automobile race across three continents, his arch rival vows to beat him, while an ambitious female reporter has her own plans for victory.',
    title: 'The Great Race',
    score: 29.569732666015625
  },
  {
    plot: 'A wide variety of eccentric competitors participate in a wild and illegal cross-country car race.',
    title: 'The Cannonball Run',
    score: 25.50379180908203
  },
  {
    plot: 'A mechanic takes his family to a car race and a series of events occur which brings problems, betrayals, violence and the unexpected death of an elderly person.',
    title: 'National Mechanics',
    score: 21.538257598876953
  },
  {
    plot: "It's time for the annual London to Brighton antique car rally, and Alan McKim and Ambrose Claverhouse are not going to let their friendship stop them from trying to humiliate each other. ...",
    title: 'Genevieve',
    score: 20.19266128540039
  },
  {
    plot: "A naive drifter runs away from his army father in hopes of making it on the car racing circuit. In Las Vegas, he meets a young scam artist, who develops a crush on him. He is then ...",
    title: 'Speedway Junky',
    score: 18.639965057373047
  }
]

The documents in the results contain the following terms in the plot field with up to a distance of 5 between the terms:

• automobile, car, or vehicle, which are defined as equivalent synonyms in the synonymous_terms collection,

• race, contest, or rally, which are defined as explicit synonyms in the sy``synonymous_terms`` collection,

Atlas Search returns similar results for a search for car race or vehicle race because we configured automobile, car, and vehicle to be equivalent synonyms. However, the results for automobile contest wouldn't include documents with race or rally and the results for automobile rally wouldn't include documents with race or contest because we didn't configure contest or rally to be synonym of any terms.