VisualSearchModels.ImageRecipesAction.yml

### YamlMime:TSType
name: ImageRecipesAction
uid: '@azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction'
package: '@azure/cognitiveservices-visualsearch'
summary: Defines an recipe action.
fullName: ImageRecipesAction
remarks: ''
isDeprecated: false
type: interface
properties:
  - name: actionType
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.actionType
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      A string representing the type of action.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: actionType
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'actionType?: string'
      return:
        description: ''
        type: string
  - name: alternateName
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.alternateName
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      An alias for the item.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: alternateName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'alternateName?: string'
      return:
        description: ''
        type: string
  - name: bingId
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.bingId
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      An ID that uniquely identifies this item.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: bingId
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'bingId?: string'
      return:
        description: ''
        type: string
  - name: data
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.data
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      A list of recipes related to the image.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: data
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'data?: RecipesModule'
      return:
        description: ''
        type: >-
          <xref
          uid="@azure/cognitiveservices-visualsearch.VisualSearchModels.RecipesModule"
          />
  - name: datePublished
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.datePublished
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      The date on which the CreativeWork was published.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: datePublished
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'datePublished?: string'
      return:
        description: ''
        type: string
  - name: description
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.description
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      A short description of the item.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: description
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'description?: string'
      return:
        description: ''
        type: string
  - name: displayName
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.displayName
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      A display name for the action.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: displayName
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'displayName?: string'
      return:
        description: ''
        type: string
  - name: id
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.id
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      A String identifier.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: id
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'id?: string'
      return:
        description: ''
        type: string
  - name: image
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.image
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      An image of the item.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: image
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'image?: ImageObject'
      return:
        description: ''
        type: >-
          <xref
          uid="@azure/cognitiveservices-visualsearch.VisualSearchModels.ImageObject"
          />
  - name: isTopAction
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.isTopAction
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      A Boolean representing whether this result is the top action.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: isTopAction
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'isTopAction?: boolean'
      return:
        description: ''
        type: boolean
  - name: name
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.name
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      The name of the thing represented by this object.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: name
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'name?: string'
      return:
        description: ''
        type: string
  - name: provider
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.provider
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      The source of the creative work.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: provider
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'provider?: ThingUnion[]'
      return:
        description: ''
        type: >-
          <xref
          uid="@azure/cognitiveservices-visualsearch.VisualSearchModels.ThingUnion"
          />[]
  - name: readLink
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.readLink
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      The URL that returns this resource. To use the URL, append query
      parameters as appropriate and

      include the Ocp-Apim-Subscription-Key header.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: readLink
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'readLink?: string'
      return:
        description: ''
        type: string
  - name: result
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.result
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      The result produced in the action.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: result
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'result?: ThingUnion[]'
      return:
        description: ''
        type: >-
          <xref
          uid="@azure/cognitiveservices-visualsearch.VisualSearchModels.ThingUnion"
          />[]
  - name: serviceUrl
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.serviceUrl
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      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.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: serviceUrl
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'serviceUrl?: string'
      return:
        description: ''
        type: string
  - name: text
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.text
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      Text content of this creative work.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: text
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'text?: string'
      return:
        description: ''
        type: string
  - name: thumbnailUrl
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.thumbnailUrl
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      The URL to a thumbnail of the item.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: thumbnailUrl
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'thumbnailUrl?: string'
      return:
        description: ''
        type: string
  - name: url
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.url
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      The URL to get more information about the thing represented by this
      object.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: url
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'url?: string'
      return:
        description: ''
        type: string
  - name: webSearchUrl
    uid: >-
      @azure/cognitiveservices-visualsearch.VisualSearchModels.ImageRecipesAction.webSearchUrl
    package: '@azure/cognitiveservices-visualsearch'
    summary: >-
      The URL to Bing's search result for this item.

      **NOTE: This property will not be serialized. It can only be populated by
      the server.**
    fullName: webSearchUrl
    remarks: ''
    isDeprecated: false
    syntax:
      content: 'webSearchUrl?: string'
      return:
        description: ''
        type: string