Action Class

Defines an action.

You probably want to use the sub-classes and not this class directly. Known sub-classes are: ImageAction

Variables are only populated by the server, and will be ignored when sending a request.

All required parameters must be populated in order to send to Azure.

Inheritance

CreativeWork

Action

Constructor

Action(**kwargs)

Parameters

_type

str

Required

Required. Constant filled by server.

Variables

id

str

A String identifier.

read_link

str

The URL that returns this resource. To use the URL, append query parameters as appropriate and include the Ocp-Apim-Subscription-Key header.

web_search_url

str

The URL to Bing's search result for this item.

name

str

The name of the thing represented by this object.

url

str

The URL to get more information about the thing represented by this object.

image

ImageObject

An image of the item.

description

str

A short description of the item.

alternate_name

str

An alias for the item.

bing_id

str

An ID that uniquely identifies this item.

thumbnail_url

str

The URL to a thumbnail of the item.

provider

list[Thing]

The source of the creative work.

date_published

str

The date on which the CreativeWork was published.

text

str

Text content of this creative work.

result

list[Thing]

The result produced in the action.

display_name

str

A display name for the action.

is_top_action

bool

A Boolean representing whether this result is the top action.

service_url

str

Use this URL to get additional data to determine how to take the appropriate action. For example, the serviceUrl might return JSON along with an image URL.