Microsoft Azure Auto Suggest Client

swagger: '2.0'
info:
  title: Microsoft Azure AutoSuggest Client
  description: >-
    Autosuggest supplies search terms derived from a root text sent to the
    service.  The terms Autosuggest supplies are related to the root text based
    on similarity and their frequency or ratings of usefulness in other
    searches. For examples that show how to use Autosuggest, see [Search using
    AutoSuggest](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-api-v7-reference).
  version: '1.0'
parameters:
  x-bingapis-sdk:
    name: X-BingApis-SDK
    description: Activate swagger compliance
    x-ms-parameter-location: method
    required: true
    type: string
    in: header
    x-ms-enum:
      name: XBingApisSDK
      modelAsString: true
    enum:
      - 'true'
x-ms-parameterized-host:
  hostTemplate: '{Endpoint}'
  useSchemePrefix: false
  parameters:
    - $ref: ../../../Common/Parameters.json#/parameters/GlobalEndpoint
host: api.cognitive.microsoft.com
basePath: /bing/v7.0
schemes:
  - https
produces:
  - application/json
securityDefinitions:
  apiKeyHeader:
    name: Ocp-Apim-Subscription-Key
    type: apiKey
    in: header
security:
  - apiKeyHeader: []
paths:
  /Suggestions:
    get:
      summary: >-
        Microsoft Azure The Autosuggest Api Lets You Send A Search Query To Bing And Get Back A List Of Query Suggestions This Section Provides Technical Details About The Query Parameters And Headers That You Use To Request Suggestions And The Json Response Objects That Contain Them
      operationId: microsoftAzureAutosuggest
      tags:
        - AutoSuggest
      parameters:
        - $ref: '#/parameters/x-bingapis-sdk'
        - name: Accept
          in: header
          description: >-
            The default media type is application/json. To specify that the
            response use [JSON-LD](http://json-ld.org/), set the Accept header
            to application/ld+json.
          required: false
          type: string
        - name: Accept-Language
          x-ms-client-name: AcceptLanguage
          in: header
          description: >-
            A comma-delimited list of one or more languages to use for user
            interface strings. The list is in decreasing order of preference.
            For additional information, including expected format, see
            [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
            This header and the setLang query parameter are mutually exclusive;
            do not specify both. If you set this header, you must also specify
            the
            [cc](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-api-v7-reference#cc)
            query parameter. To determine the market to return results for, Bing
            uses the first supported language it finds from the list and
            combines it with the cc parameter value. If the list does not
            include a supported language, Bing finds the closest language and
            market that supports the request or it uses an aggregated or default
            market for the results. To determine the market that Bing used, see
            the BingAPIs-Market header. Use this header and the cc query
            parameter only if you specify multiple languages. Otherwise, use the
            [mkt](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-api-v7-reference#mkt)
            and
            [setLang](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-autosuggest-api-v7-reference#setlang)
            query parameters. A user interface string is a string that's used as
            a label in a user interface. There are few user interface strings in
            the JSON response objects. Any links to Bing.com properties in the
            response objects apply the specified language.
          required: false
          type: string
        - name: Pragma
          in: header
          description: >-
            By default, Bing returns cached content, if available. To prevent
            Bing from returning cached content, set the Pragma header to
            no-cache (for example, Pragma: no-cache).
          required: false
          type: string
        - name: User-Agent
          x-ms-client-name: UserAgent
          in: header
          description: >-
            The user agent originating the request. Bing uses the user agent to
            provide mobile users with an optimized experience. Although
            optional, you are encouraged to always specify this header. The
            user-agent should be the same string that any commonly used browser
            sends. For information about user agents, see [RFC
            2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). The
            following are examples of user-agent strings. Windows Phone:
            Mozilla/5.0 (compatible; MSIE 10.0; Windows Phone 8.0; Trident/6.0;
            IEMobile/10.0; ARM; Touch; NOKIA; Lumia 822). Android: Mozilla / 5.0
            (Linux; U; Android 2.3.5; en - us; SCH - I500 Build / GINGERBREAD)
            AppleWebKit / 533.1 (KHTML; like Gecko) Version / 4.0 Mobile Safari
            / 533.1. iPhone: Mozilla / 5.0 (iPhone; CPU iPhone OS 6_1 like Mac
            OS X) AppleWebKit / 536.26 (KHTML; like Gecko) Mobile / 10B142
            iPhone4; 1 BingWeb / 3.03.1428.20120423. PC: Mozilla / 5.0 (Windows
            NT 6.3; WOW64; Trident / 7.0; Touch; rv:11.0) like Gecko. iPad:
            Mozilla / 5.0 (iPad; CPU OS 7_0 like Mac OS X) AppleWebKit /
            537.51.1 (KHTML, like Gecko) Version / 7.0 Mobile / 11A465 Safari /
            9537.53
          required: false
          type: string
        - name: X-MSEdge-ClientID
          x-ms-client-name: ClientId
          in: header
          description: >-
            Bing uses this header to provide users with consistent behavior
            across Bing API calls. Bing often flights new features and
            improvements, and it uses the client ID as a key for assigning
            traffic on different flights. If you do not use the same client ID
            for a user across multiple requests, then Bing may assign the user
            to multiple conflicting flights. Being assigned to multiple
            conflicting flights can lead to an inconsistent user experience. For
            example, if the second request has a different flight assignment
            than the first, the experience may be unexpected. Also, Bing can use
            the client ID to tailor web results to that client ID’s search
            history, providing a richer experience for the user. Bing also uses
            this header to help improve result rankings by analyzing the
            activity generated by a client ID. The relevance improvements help
            with better quality of results delivered by Bing APIs and in turn
            enables higher click-through rates for the API consumer. IMPORTANT:
            Although optional, you should consider this header required.
            Persisting the client ID across multiple requests for the same end
            user and device combination enables 1) the API consumer to receive a
            consistent user experience, and 2) higher click-through rates via
            better quality of results from the Bing APIs. Each user that uses
            your application on the device must have a unique, Bing generated
            client ID. If you do not include this header in the request, Bing
            generates an ID and returns it in the X-MSEdge-ClientID response
            header. The only time that you should NOT include this header in a
            request is the first time the user uses your app on that device. Use
            the client ID for each Bing API request that your app makes for this
            user on the device. Persist the client ID. To persist the ID in a
            browser app, use a persistent HTTP cookie to ensure the ID is used
            across all sessions. Do not use a session cookie. For other apps
            such as mobile apps, use the device's persistent storage to persist
            the ID. The next time the user uses your app on that device, get the
            client ID that you persisted. Bing responses may or may not include
            this header. If the response includes this header, capture the
            client ID and use it for all subsequent Bing requests for the user
            on that device. If you include the X-MSEdge-ClientID, you must not
            include cookies in the request.
          required: false
          type: string
        - name: X-MSEdge-ClientIP
          x-ms-client-name: ClientIp
          in: header
          description: >-
            The IPv4 or IPv6 address of the client device. The IP address is
            used to discover the user's location. Bing uses the location
            information to determine safe search behavior. Although optional,
            you are encouraged to always specify this header and the
            X-Search-Location header. Do not obfuscate the address (for example,
            by changing the last octet to 0). Obfuscating the address results in
            the location not being anywhere near the device's actual location,
            which may result in Bing serving erroneous results.
          required: false
          type: string
        - name: X-Search-Location
          x-ms-client-name: Location
          in: header
          description: >-
            A semicolon-delimited list of key/value pairs that describe the
            client's geographical location. Bing uses the location information
            to determine safe search behavior and to return relevant local
            content. Specify the key/value pair as <key>:<value>. The following
            are the keys that you use to specify the user's location. lat
            (required): The latitude of the client's location, in degrees. The
            latitude must be greater than or equal to -90.0 and less than or
            equal to +90.0. Negative values indicate southern latitudes and
            positive values indicate northern latitudes. long (required): The
            longitude of the client's location, in degrees. The longitude must
            be greater than or equal to -180.0 and less than or equal to +180.0.
            Negative values indicate western longitudes and positive values
            indicate eastern longitudes. re (required): The radius, in meters,
            which specifies the horizontal accuracy of the coordinates. Pass the
            value returned by the device's location service. Typical values
            might be 22m for GPS/Wi-Fi, 380m for cell tower triangulation, and
            18,000m for reverse IP lookup. ts (optional): The UTC UNIX timestamp
            of when the client was at the location. (The UNIX timestamp is the
            number of seconds since January 1, 1970.) head (optional): The
            client's relative heading or direction of travel. Specify the
            direction of travel as degrees from 0 through 360, counting
            clockwise relative to true north. Specify this key only if the sp
            key is nonzero. sp (optional): The horizontal velocity (speed), in
            meters per second, that the client device is traveling. alt
            (optional): The altitude of the client device, in meters. are
            (optional): The radius, in meters, that specifies the vertical
            accuracy of the coordinates. Specify this key only if you specify
            the alt key. Although many of the keys are optional, the more
            information that you provide, the more accurate the location results
            are. Although optional, you are encouraged to always specify the
            user's geographical location. Providing the location is especially
            important if the client's IP address does not accurately reflect the
            user's physical location (for example, if the client uses VPN). For
            optimal results, you should include this header and the
            X-MSEdge-ClientIP header, but at a minimum, you should include this
            header.
          required: false
          type: string
        - name: cc
          x-ms-client-name: CountryCode
          in: query
          description: >-
            A 2-character country code of the country where the results come
            from. This API supports only the United States market. If you
            specify this query parameter, it must be set to us. If you set this
            parameter, you must also specify the Accept-Language header. Bing
            uses the first supported language it finds from the languages list,
            and combine that language with the country code that you specify to
            determine the market to return results for. If the languages list
            does not include a supported language, Bing finds the closest
            language and market that supports the request, or it may use an
            aggregated or default market for the results instead of a specified
            one. You should use this query parameter and the Accept-Language
            query parameter only if you specify multiple languages; otherwise,
            you should use the mkt and setLang query parameters. This parameter
            and the mkt query parameter are mutually exclusive—do not specify
            both.
          required: false
          type: string
        - name: mkt
          x-ms-client-name: Market
          in: query
          description: >-
            The market where the results come from. You are strongly encouraged
            to always specify the market, if known. Specifying the market helps
            Bing route the request and return an appropriate and optimal
            response. This parameter and the cc query parameter are mutually
            exclusive—do not specify both.
          required: false
          type: string
          default: en-us
        - name: q
          x-ms-client-name: Query
          in: query
          description: The user's search term.
          required: true
          type: string
        - name: safeSearch
          x-ms-client-name: SafeSearch
          in: query
          description: >-
            Filter suggestions for adult content. The following are the possible
            filter values. Off: Return suggestions with adult text, images, or
            videos. Moderate: Return suggestion with adult text but not adult
            images or videos. Strict: Do not return news articles with adult
            text, images, or videos. If the request comes from a market that
            Bing's adult policy requires that safeSearch is set to Strict, Bing
            ignores the safeSearch value and uses Strict. If you use the site:
            query operator, there is the chance that the response may contain
            adult content regardless of what the safeSearch query parameter is
            set to. Use site: only if you are aware of the content on the site
            and your scenario supports the possibility of adult content.
          required: false
          type: string
          enum:
            - 'Off'
            - Moderate
            - Strict
          x-ms-enum:
            name: SafeSearch
            modelAsString: true
        - name: setLang
          x-ms-client-name: SetLang
          in: query
          description: >-
            The language to use for user interface strings. Specify the language
            using the ISO 639-1 2-letter language code. For example, the
            language code for English is EN. The default is EN (English).
            Although optional, you should always specify the language.
            Typically, you set setLang to the same language specified by mkt
            unless the user wants the user interface strings displayed in a
            different language. This parameter and the Accept-Language header
            are mutually exclusive; do not specify both. A user interface string
            is a string that's used as a label in a user interface. There are
            few user interface strings in the JSON response objects. Also, any
            links to Bing.com properties in the response objects apply the
            specified language.
          required: false
          type: string
        - name: ResponseFormat
          in: query
          description: >-
            The media type to use for the response. The following are the
            possible case-insensitive values: JSON, JSONLD. The default is JSON.
            If you specify JSONLD, the response body includes JSON-LD objects
            that contain the search results.
          required: false
          type: array
          items:
            type: string
            enum:
              - Json
              - JsonLd
            x-ms-enum:
              name: ResponseFormat
              modelAsString: true
          collectionFormat: csv
      responses:
        '200':
          description: Success.
          schema:
            $ref: '#/definitions/Suggestions'
        default:
          description: >-
            An error has occurred. Check the response type and/or status code
            for more details.
          schema:
            $ref: '#/definitions/ErrorResponse'
      x-ms-examples:
        Successful query:
          $ref: ./examples/SuccessfulQueryRequest.json
      description: Needs a more full description created.
definitions:
  Suggestions:
    allOf:
      - $ref: '#/definitions/SearchResultsAnswer'
    type: object
    required:
      - suggestionGroups
    properties:
      suggestionGroups:
        type: array
        items:
          $ref: '#/definitions/SuggestionsSuggestionGroup'
  SearchResultsAnswer:
    description: Defines a search result answer.
    allOf:
      - $ref: '#/definitions/Answer'
    type: object
    properties:
      queryContext:
        $ref: '#/definitions/QueryContext'
        readOnly: true
  SuggestionsSuggestionGroup:
    x-ms-discriminator-value: Suggestions/SuggestionGroup
    discriminator: _type
    type: object
    required:
      - name
      - searchSuggestions
      - _type
    properties:
      name:
        type: string
        default: Unknown
        enum:
          - Unknown
          - Web
          - StoreApps
          - SearchHistory
          - PersonalSearchDocuments
          - PersonalSearchTags
          - Custom
        x-ms-enum:
          name: ScenarioType
          modelAsString: true
      searchSuggestions:
        type: array
        items:
          $ref: '#/definitions/SearchAction'
      _type:
        type: string
  Answer:
    description: Defines an answer.
    allOf:
      - $ref: '#/definitions/Response'
    type: object
    properties: {}
  QueryContext:
    description: Defines the query context that Bing used for the request.
    discriminator: _type
    type: object
    required:
      - originalQuery
      - _type
    properties:
      originalQuery:
        description: The query string as specified in the request.
        type: string
      alteredQuery:
        description: >-
          The query string used by Bing to perform the query. Bing uses the
          altered query string if the original query string contained spelling
          mistakes. For example, if the query string is "saling downwind", the
          altered query string will be "sailing downwind". This field is
          included only if the original query string contains a spelling
          mistake.
        readOnly: true
        type: string
      alterationOverrideQuery:
        description: >-
          The query string to use to force Bing to use the original string. For
          example, if the query string is "saling downwind", the override query
          string will be "+saling downwind". Remember to encode the query string
          which results in "%2Bsaling+downwind". This field is included only if
          the original query string contains a spelling mistake.
        readOnly: true
        type: string
      adultIntent:
        description: >-
          A Boolean value that indicates whether the specified query has adult
          intent. The value is true if the query has adult intent; otherwise,
          false.
        readOnly: true
        type: boolean
      askUserForLocation:
        description: >-
          A Boolean value that indicates whether Bing requires the user's
          location to provide accurate results. If you specified the user's
          location by using the X-MSEdge-ClientIP and X-Search-Location headers,
          you can ignore this field. For location aware queries, such as
          "today's weather" or "restaurants near me" that need the user's
          location to provide accurate results, this field is set to true. For
          location aware queries that include the location (for example,
          "Seattle weather"), this field is set to false. This field is also set
          to false for queries that are not location aware, such as "best
          sellers".
        readOnly: true
        type: boolean
      isTransactional:
        readOnly: true
        type: boolean
      _type:
        type: string
  SearchAction:
    allOf:
      - $ref: '#/definitions/Action'
    type: object
    properties:
      displayText:
        readOnly: true
        type: string
      query:
        readOnly: true
        type: string
      searchKind:
        readOnly: true
        type: string
        default: WebSearch
        enum:
          - WebSearch
          - HistorySearch
          - DocumentSearch
          - TagSearch
          - LocationSearch
          - CustomSearch
        x-ms-enum:
          name: SearchKind
          modelAsString: true
  Response:
    description: >-
      Defines a response. All schemas that could be returned at the root of a
      response should inherit from this
    allOf:
      - $ref: '#/definitions/Identifiable'
    type: object
    properties:
      readLink:
        description: The URL that returns this resource.
        readOnly: true
        type: string
      webSearchUrl:
        description: The URL To Bing's search result for this item.
        readOnly: true
        type: string
      potentialAction:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/Action'
      immediateAction:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/Action'
      preferredClickthroughUrl:
        readOnly: true
        type: string
      adaptiveCard:
        readOnly: true
        type: string
  Action:
    allOf:
      - $ref: '#/definitions/CreativeWork'
    type: object
    properties:
      result:
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/Thing'
      displayName:
        readOnly: true
        type: string
      isTopAction:
        readOnly: true
        type: boolean
      serviceUrl:
        readOnly: true
        type: string
  Identifiable:
    description: Defines the identity of a resource.
    allOf:
      - $ref: '#/definitions/ResponseBase'
    type: object
    properties:
      id:
        description: A String identifier.
        readOnly: true
        type: string
  ErrorResponse:
    description: The top-level response that represents a failed request.
    allOf:
      - $ref: '#/definitions/Response'
    type: object
    required:
      - errors
    properties:
      errors:
        description: A list of errors that describe the reasons why the request failed.
        type: array
        items:
          $ref: '#/definitions/Error'
  Thing:
    description: Defines a thing.
    allOf:
      - $ref: '#/definitions/Response'
    type: object
    properties:
      url:
        description: >-
          The URL to get more information about the thing represented by this
          object.
        readOnly: true
        type: string
  CreativeWork:
    description: >-
      The most generic kind of creative work, including books, movies,
      photographs, software programs, etc.
    allOf:
      - $ref: '#/definitions/Thing'
    type: object
    properties:
      thumbnailUrl:
        description: The URL to a thumbnail of the item.
        readOnly: true
        type: string
      about:
        description: For internal use only.
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/Thing'
      mentions:
        description: For internal use only.
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/Thing'
      provider:
        description: The source of the creative work.
        readOnly: true
        type: array
        items:
          $ref: '#/definitions/Thing'
      creator:
        $ref: '#/definitions/Thing'
        readOnly: true
      text:
        description: Text content of this creative work
        readOnly: true
        type: string
      discussionUrl:
        readOnly: true
        type: string
      commentCount:
        readOnly: true
        type: integer
        format: int32
      mainEntity:
        $ref: '#/definitions/Thing'
        readOnly: true
      headLine:
        readOnly: true
        type: string
      copyrightHolder:
        $ref: '#/definitions/Thing'
        readOnly: true
      copyrightYear:
        readOnly: true
        type: integer
        format: int32
      disclaimer:
        readOnly: true
        type: string
      isAccessibleForFree:
        readOnly: true
        type: boolean
      genre:
        readOnly: true
        type: array
        items:
          type: string
      isFamilyFriendly:
        readOnly: true
        type: boolean
  ResponseBase:
    description: Response base
    discriminator: _type
    type: object
    required:
      - _type
    properties:
      _type:
        type: string
  Error:
    description: Defines the error that occurred.
    discriminator: _type
    type: object
    required:
      - code
      - message
      - _type
    properties:
      code:
        description: The error code that identifies the category of error.
        type: string
        default: None
        enum:
          - None
          - ServerError
          - InvalidRequest
          - RateLimitExceeded
          - InvalidAuthorization
          - InsufficientAuthorization
        x-ms-enum:
          name: ErrorCode
          modelAsString: true
      message:
        description: A description of the error.
        type: string
      moreDetails:
        description: A description that provides additional information about the error.
        readOnly: true
        type: string
      parameter:
        description: The parameter in the request that caused the error.
        readOnly: true
        type: string
      value:
        description: The parameter's value in the request that was not valid.
        readOnly: true
        type: string
      _type:
        type: string
tags:
  - name: AutoSuggest