/**
 * Copyright (c) Microsoft Corporation. All rights reserved.
 * Licensed under the MIT License. See License.txt in the project root for
 * license information.
 *
 * Code generated by Microsoft (R) AutoRest Code Generator.
 */

package com.microsoft.azure.cognitiveservices.search.visualsearch;

import com.microsoft.azure.cognitiveservices.search.visualsearch.models.VisualSearchOptionalParameter;
import com.microsoft.azure.cognitiveservices.search.visualsearch.models.ErrorResponseException;
import com.microsoft.azure.cognitiveservices.search.visualsearch.models.ImageKnowledge;
import rx.Observable;

/**
 * An instance of this class provides access to all the operations defined
 * in BingImages.
 */
public interface BingImages {
    /**
     * Visual Search API lets you discover insights about an image such as visually similar images, shopping
     *   sources, and related searches. The API can also perform text recognition, identify entities (people, places,
     *   things), return other topical content for the user to explore, and more. For more information, see [Visual
     *   Search Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).
     *
     * @param visualSearchOptionalParameter the object representing the optional parameters to be set before calling this API
     * @throws IllegalArgumentException thrown if parameters fail the validation
     * @throws ErrorResponseException thrown if the request is rejected by server
     * @throws RuntimeException all other wrapped checked exceptions if the request fails to be sent
     * @return the ImageKnowledge object if successful.
     */
    
    ImageKnowledge visualSearch(VisualSearchOptionalParameter visualSearchOptionalParameter);

    /**
     * Visual Search API lets you discover insights about an image such as visually similar images, shopping
     *   sources, and related searches. The API can also perform text recognition, identify entities (people, places,
     *   things), return other topical content for the user to explore, and more. For more information, see [Visual
     *   Search Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).
     *
     * @param visualSearchOptionalParameter the object representing the optional parameters to be set before calling this API
     * @throws IllegalArgumentException thrown if parameters fail the validation
     * @return the observable to the ImageKnowledge object
     */
    
    Observable<ImageKnowledge> visualSearchAsync(VisualSearchOptionalParameter visualSearchOptionalParameter);

    /**
     * Visual Search API lets you discover insights about an image such as visually similar images, shopping
     *   sources, and related searches. The API can also perform text recognition, identify entities (people, places,
     *   things), return other topical content for the user to explore, and more. For more information, see [Visual
     *   Search Overview](https://docs.microsoft.com/azure/cognitive-services/bing-visual-search/overview).
     *
     * @return the first stage of the visualSearch call
     */
    BingImagesVisualSearchDefinitionStages.WithExecute visualSearch();

    /**
     * Grouping of visualSearch definition stages.
     */
    interface BingImagesVisualSearchDefinitionStages {

        /**
         * The stage of the definition which allows for any other optional settings to be specified.
         */
        interface WithAllOptions {
            /**
             * 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
             [setLa*   ng](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-api-v7-reference#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-visual-search-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-visual-search-api-v7-reference#mkt)
             *   and
             [setLa*   ng](https://docs.microsoft.com/en-us/rest/api/cognitiveservices/bing-visual-search-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.
             *
             * @return next definition stage
             */
            BingImagesVisualSearchDefinitionStages.WithExecute withAcceptLanguage(String acceptLanguage);

            /**
             * Must be set to multipart/form-data and include a boundary parameter (for example, multipart/form-data;
             *   boundary=&lt;boundary string&gt;). For more details, see [Content form types](
             *   https://docs.microsoft.com/en-us/azure/cognitive-services/bing-visual-search/overview#content-form-types).
             *
             * @return next definition stage
             */
            BingImagesVisualSearchDefinitionStages.WithExecute withContentType(String contentType);

            /**
             * 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.
             *
             * @return next definition stage
             */
            BingImagesVisualSearchDefinitionStages.WithExecute withUserAgent(String userAgent);

            /**
             * 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. ATTENTION: You must ensure that this Client ID is not linkable to any
             *   authenticatable user account information. If you include the X-MSEdge-ClientID, you must not include cookies
             *   in the request.
             *
             * @return next definition stage
             */
            BingImagesVisualSearchDefinitionStages.WithExecute withClientId(String clientId);

            /**
             * 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.
             *
             * @return next definition stage
             */
            BingImagesVisualSearchDefinitionStages.WithExecute withClientIp(String clientIp);

            /**
             * 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 &lt;key&gt;:&lt;value&gt;. 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.
             *
             * @return next definition stage
             */
            BingImagesVisualSearchDefinitionStages.WithExecute withLocation(String location);

            /**
             * The form data is a JSON object that identifies the image using an insights token or URL to the image. The
             *   object may also include an optional crop area that identifies an area of interest in the image. The insights
             *   token and URL are mutually exclusive – do not specify both. You may specify knowledgeRequest form data and
             *   image form data in the same request only if knowledgeRequest form data specifies the cropArea field only (it
             *   must not include an insights token or URL).
             *
             * @return next definition stage
             */
            BingImagesVisualSearchDefinitionStages.WithExecute withKnowledgeRequest(String knowledgeRequest);

            /**
             * The form data is an image binary. The Content-Disposition header's filename parameter must be set to
             *   "image". You must specify an image binary if you do not use knowledgeRequest form data to specify the image;
             *   you may not use both forms to specify an image. You may specify knowledgeRequest form data and image form
             *   data in the same request only if knowledgeRequest form data specifies the cropArea field only  (it must not
             *   include an insights token or URL).
             *
             * @return next definition stage
             */
            BingImagesVisualSearchDefinitionStages.WithExecute withImage(byte[] image);

        }

        /**
         * The last stage of the definition which will make the operation call.
        */
        interface WithExecute extends BingImagesVisualSearchDefinitionStages.WithAllOptions {
            /**
             * Execute the request.
             *
             * @return the ImageKnowledge object if successful.
             */
            ImageKnowledge execute();

            /**
             * Execute the request asynchronously.
             *
             * @return the observable to the ImageKnowledge object
             */
            Observable<ImageKnowledge> executeAsync();
        }
    }

    /**
     * The entirety of visualSearch definition.
     */
    interface BingImagesVisualSearchDefinition extends
        BingImagesVisualSearchDefinitionStages.WithExecute {
    }

}
