Conversational Actions built-in intents

Built-in intents model some of the common ways that users express tasks they're trying to do or information they seek, such as ordering a meal, booking a ride, or checking an account balance.

You can use these built-in intents to build conversational Actions, but we are still fine tuning Action discovery and ranking. Note that built-in intents intended for App Actions won't work for conversational Actions and vice versa.

  • If you are building conversational Actions, you should create and test implicit invocations in addition to registering for built-in intents. To learn more about using and deploying these intents, see the Built-in intents guide.
  • If you are building App Actions, see the App Actions built-in intent reference instead.

Entertainment

Get fortune

Action ID actions.intent.GET_FORTUNE
Description Get your fortune from a fortune teller.
Example queries

Get my fortune

What's my fortune for June 10

JSON-LD sample
[
  {
    "exampleValues": [
      "2018-03-26T00:00:00/2018-03-26T11:59:59"
    ],
    "name": "attributes",
    "schemaType": []
  },
  {
    "exampleValues": [
      "2018-03-26T00:00:00/2018-03-26T11:59:59"
    ],
    "name": "temporalCoverage",
    "schemaType": []
  }
]

Get horoscope

Action ID actions.intent.GET_HOROSCOPE
Description Get a horoscope by date of birth or sign.
Example queries

Get horoscope

What's today's horoscope for taurus?

JSON-LD sample
[
  {
    "exampleValues": [
      {
        "@context": "https://schema.googleapis.org",
        "@type": "Horoscope",
        "category": "love",
        "inLanguage": {
          "identifier": "fr"
        },
        "relatedAstrologicalSign": "https://m.wikidata.org/wiki/Q164272",
        "relatedAstrologicalSystem": "https://m.wikidata.org/wiki/Q1976204",
        "temporalCoverage": "2019-01-08T00:00:00/2019-01-08T23:59:59"
      }
    ],
    "name": "astrologySign",
    "schemaType": [
      "https://schema.googleapis.org/Horoscope"
    ]
  },
  {
    "exampleValues": [
      {
        "@context": "https://schema.googleapis.org",
        "@type": "Horoscope",
        "category": "love",
        "inLanguage": {
          "identifier": "fr"
        },
        "relatedAstrologicalSign": "https://m.wikidata.org/wiki/Q164272",
        "relatedAstrologicalSystem": "https://m.wikidata.org/wiki/Q1976204",
        "temporalCoverage": "2019-01-08T00:00:00/2019-01-08T23:59:59"
      }
    ],
    "name": "horoscope",
    "schemaType": [
      "https://schema.googleapis.org/Horoscope"
    ]
  }
]

Get joke

Action ID actions.intent.GET_JOKE
Description Get a joke about a topic or from a creative work.
Example queries

Let me hear a joke

Tell me a joke about dogs

JSON-LD sample
[
  {
    "exampleValues": [
      {
        "@context": "https://schema.googleapis.org",
        "@type": "Joke",
        "about": {
          "name": "dogs"
        },
        "author": {
          "name": "Jane Austen"
        },
        "inLanguage": {
          "identifier": "hin"
        },
        "isPartOf": {
          "name": "Pride and Prejudice"
        },
        "temporalCoverage": "1990-01-01T00:00:00/1990-12-31T11:59:59"
      }
    ],
    "name": "joke",
    "schemaType": [
      "https://schema.googleapis.org/Joke"
    ]
  }
]

Get a quotation

Action ID actions.intent.GET_QUOTATION
Description Get a quotation from a particular author or creative work.
Example queries

Get a quote

Hear a quote from Abraham Lincoln

JSON-LD sample
[
  {
    "exampleValues": [
      {
        "@context": "https://pending.schema.org",
        "@type": "Quotation",
        "inLanguage": {
          "identifier": "jpn"
        },
        "isPartOf": {
          "name": "Long Walk to Freedom"
        },
        "keywords": "inspirational",
        "spokenByCharacter": {
          "name": "Nelson Mandela"
        },
        "temporalCoverage": "2000-01-01T03:00:00/2099-12-12T23:59:59"
      }
    ],
    "name": "quotation",
    "schemaType": [
      "https://pending.schema.org/Quotation"
    ]
  }
]

Finance

Get credit score

Action ID actions.intent.GET_CREDIT_SCORE
Description Get credit score from a credit agency
Example queries

What is my credit score?

Check my credit score

JSON-LD sample
[
  {
    "exampleValues": [
      {
        "@context": "https://schema.org",
        "@type": "Corporation"
      }
    ],
    "name": "creditAgency",
    "schemaType": [
      "https://schema.org/Corporation"
    ]
  }
]

Get cryptocurrency prices

Action ID actions.intent.GET_CRYPTOCURRENCY_PRICE
Description Get prices for a particular cryptocurrency
Example queries

What is the value of bitcoin?

Check the price of bitcoin

JSON-LD sample
[
  {
    "exampleValues": [
      {
        "@context": "https://schema.googleapis.org",
        "@type": "MonetaryAmount",
        "currency": "USD",
        "validAt": "2018-01-01T00:00:00"
      }
    ],
    "name": "cryptocurrency",
    "schemaType": [
      "https://schema.googleapis.org/MonetaryAmount"
    ]
  },
  {
    "exampleValues": [
      {
        "@context": "https://schema.googleapis.org",
        "@type": "MonetaryAmount",
        "currency": "USD",
        "validAt": "2018-01-01T00:00:00"
      }
    ],
    "name": "exchange",
    "schemaType": [
      "https://schema.googleapis.org/MonetaryAmount"
    ]
  },
  {
    "exampleValues": [
      {
        "@context": "https://schema.googleapis.org",
        "@type": "MonetaryAmount",
        "currency": "USD",
        "validAt": "2018-01-01T00:00:00"
      }
    ],
    "name": "targetMonetarySpec",
    "schemaType": [
      "https://schema.googleapis.org/MonetaryAmount"
    ]
  }
]

Games

Play game

Action ID actions.intent.PLAY_GAME
Description Play a game. If your Action is a game, you must register for this built-in intent in order to be eligible for implicit invocation.
Example queries

Play a game

Play a trivia game

JSON-LD sample
[
  {
    "exampleValues": [
      {
        "@context": "https://schema.org",
        "description": "cute animals",
        "genre": "adventure",
        "name": "Example Game 1",
        "schemaType": "Game"
      }
    ],
    "name": "game",
    "schemaType": []
  }
]

Health and fitness

Start calming activity

Action ID actions.intent.START_CALMING_ACTIVITY
Description Start a calming, meditative activity.
Example queries

I want to meditate for 10 minutes

JSON-LD sample
[
  {
    "exampleValues": [
      "PT10M"
    ],
    "name": "calmingActivity",
    "schemaType": []
  },
  {
    "exampleValues": [
      "PT10M"
    ],
    "name": "stressor",
    "schemaType": []
  },
  {
    "exampleValues": [
      "PT10M"
    ],
    "name": "duration",
    "schemaType": []
  }
]

Weather

Check air quality

Action ID actions.intent.CHECK_AIR_QUALITY
Description Check the air quality at a specific location.
Example queries

What's the air quality

How is the air quality in Mountain View

Supported fields attributes
location.geo.latitude
location.geo.longitude
location.name
temporalCoverage
JSON-LD sample
[
  {
    "exampleValues": [
      "2018-03-18T10:25:00"
    ],
    "name": "location",
    "schemaType": []
  },
  {
    "exampleValues": [
      "2018-03-18T10:25:00"
    ],
    "name": "attributes",
    "schemaType": []
  },
  {
    "exampleValues": [
      "2018-03-18T10:25:00"
    ],
    "name": "temporalCoverage",
    "schemaType": []
  }
]

Check water conditions

Action ID actions.intent.CHECK_WATER_CONDITIONS
Description Check the water conditions at a specific time or location.
Example queries

Check water conditions

How's the water in Lake Superior

JSON-LD sample
[
  {
    "exampleValues": [
      "Hurricane Katrina"
    ],
    "name": "area",
    "schemaType": []
  },
  {
    "exampleValues": [
      "Hurricane Katrina"
    ],
    "name": "time",
    "schemaType": []
  },
  {
    "exampleValues": [
      "Hurricane Katrina"
    ],
    "name": "cause",
    "schemaType": []
  }
]