< Summary

Class:Microsoft.Azure.CognitiveServices.Search.EntitySearch.EntitiesOperationsExtensions
Assembly:Microsoft.Azure.CognitiveServices.Search.BingEntitySearch
File(s):C:\Git\azure-sdk-for-net\sdk\cognitiveservices\Search.BingEntitySearch\src\Generated\EntitySearch\EntitiesOperationsExtensions.cs
Covered lines:4
Uncovered lines:0
Coverable lines:4
Total lines:401
Line coverage:100% (4 of 4)
Covered branches:0
Total branches:0

Metrics

MethodCyclomatic complexity Line coverage Branch coverage
Search(...)-100%100%
SearchAsync()-100%100%

File(s)

C:\Git\azure-sdk-for-net\sdk\cognitiveservices\Search.BingEntitySearch\src\Generated\EntitySearch\EntitiesOperationsExtensions.cs

#LineLine coverage
 1// <auto-generated>
 2// Code generated by Microsoft (R) AutoRest Code Generator.
 3// Changes may cause incorrect behavior and will be lost if the code is
 4// regenerated.
 5// </auto-generated>
 6
 7namespace Microsoft.Azure.CognitiveServices.Search.EntitySearch
 8{
 9    using Models;
 10    using System.Collections;
 11    using System.Collections.Generic;
 12    using System.Threading;
 13    using System.Threading.Tasks;
 14
 15    /// <summary>
 16    /// Extension methods for EntitiesOperations.
 17    /// </summary>
 18    public static partial class EntitiesOperationsExtensions
 19    {
 20            /// <summary>
 21            /// The Entity Search API lets you send a search query to Bing and get back
 22            /// search results that include entities and places. Place results include
 23            /// restaurants, hotel, or other local businesses. For places, the query can
 24            /// specify the name of the local business or it can ask for a list (for
 25            /// example, restaurants near me). Entity results include persons, places, or
 26            /// things. Place in this context is tourist attractions, states, countries,
 27            /// etc.
 28            /// </summary>
 29            /// <param name='operations'>
 30            /// The operations group for this extension method.
 31            /// </param>
 32            /// <param name='query'>
 33            /// The user's search term.
 34            /// </param>
 35            /// <param name='acceptLanguage'>
 36            /// A comma-delimited list of one or more languages to use for user interface
 37            /// strings. The list is in decreasing order of preference. For additional
 38            /// information, including expected format, see
 39            /// [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This
 40            /// header and the setLang query parameter are mutually exclusive; do not
 41            /// specify both. If you set this header, you must also specify the cc query
 42            /// parameter. Bing will use the first supported language it finds from the
 43            /// list, and combine that language with the cc parameter value to determine
 44            /// the market to return results for. If the list does not include a supported
 45            /// language, Bing will find the closest language and market that supports the
 46            /// request, and may use an aggregated or default market for the results
 47            /// instead of a specified one. You should use this header and the cc query
 48            /// parameter only if you specify multiple languages; otherwise, you should use
 49            /// the mkt and setLang query parameters. A user interface string is a string
 50            /// that's used as a label in a user interface. There are very few user
 51            /// interface strings in the JSON response objects. Any links in the response
 52            /// objects to Bing.com properties will apply the specified language.
 53            /// </param>
 54            /// <param name='pragma'>
 55            /// By default, Bing returns cached content, if available. To prevent Bing from
 56            /// returning cached content, set the Pragma header to no-cache (for example,
 57            /// Pragma: no-cache).
 58            /// </param>
 59            /// <param name='userAgent'>
 60            /// The user agent originating the request. Bing uses the user agent to provide
 61            /// mobile users with an optimized experience. Although optional, you are
 62            /// strongly encouraged to always specify this header. The user-agent should be
 63            /// the same string that any commonly used browser would send. For information
 64            /// about user agents, see [RFC
 65            /// 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
 66            /// </param>
 67            /// <param name='clientId'>
 68            /// Bing uses this header to provide users with consistent behavior across Bing
 69            /// API calls. Bing often flights new features and improvements, and it uses
 70            /// the client ID as a key for assigning traffic on different flights. If you
 71            /// do not use the same client ID for a user across multiple requests, then
 72            /// Bing may assign the user to multiple conflicting flights. Being assigned to
 73            /// multiple conflicting flights can lead to an inconsistent user experience.
 74            /// For example, if the second request has a different flight assignment than
 75            /// the first, the experience may be unexpected. Also, Bing can use the client
 76            /// ID to tailor web results to that client ID’s search history, providing a
 77            /// richer experience for the user. Bing also uses this header to help improve
 78            /// result rankings by analyzing the activity generated by a client ID. The
 79            /// relevance improvements help with better quality of results delivered by
 80            /// Bing APIs and in turn enables higher click-through rates for the API
 81            /// consumer. IMPORTANT: Although optional, you should consider this header
 82            /// required. Persisting the client ID across multiple requests for the same
 83            /// end user and device combination enables 1) the API consumer to receive a
 84            /// consistent user experience, and 2) higher click-through rates via better
 85            /// quality of results from the Bing APIs. Each user that uses your application
 86            /// on the device must have a unique, Bing generated client ID. If you do not
 87            /// include this header in the request, Bing generates an ID and returns it in
 88            /// the X-MSEdge-ClientID response header. The only time that you should NOT
 89            /// include this header in a request is the first time the user uses your app
 90            /// on that device. Use the client ID for each Bing API request that your app
 91            /// makes for this user on the device. Persist the client ID. To persist the ID
 92            /// in a browser app, use a persistent HTTP cookie to ensure the ID is used
 93            /// across all sessions. Do not use a session cookie. For other apps such as
 94            /// mobile apps, use the device's persistent storage to persist the ID. The
 95            /// next time the user uses your app on that device, get the client ID that you
 96            /// persisted. Bing responses may or may not include this header. If the
 97            /// response includes this header, capture the client ID and use it for all
 98            /// subsequent Bing requests for the user on that device. If you include the
 99            /// X-MSEdge-ClientID, you must not include cookies in the request.
 100            /// </param>
 101            /// <param name='clientIp'>
 102            /// The IPv4 or IPv6 address of the client device. The IP address is used to
 103            /// discover the user's location. Bing uses the location information to
 104            /// determine safe search behavior. Although optional, you are encouraged to
 105            /// always specify this header and the X-Search-Location header. Do not
 106            /// obfuscate the address (for example, by changing the last octet to 0).
 107            /// Obfuscating the address results in the location not being anywhere near the
 108            /// device's actual location, which may result in Bing serving erroneous
 109            /// results.
 110            /// </param>
 111            /// <param name='location'>
 112            /// A semicolon-delimited list of key/value pairs that describe the client's
 113            /// geographical location. Bing uses the location information to determine safe
 114            /// search behavior and to return relevant local content. Specify the key/value
 115            /// pair as &lt;key&gt;:&lt;value&gt;. The following are the keys that you use
 116            /// to specify the user's location. lat (required): The latitude of the
 117            /// client's location, in degrees. The latitude must be greater than or equal
 118            /// to -90.0 and less than or equal to +90.0. Negative values indicate southern
 119            /// latitudes and positive values indicate northern latitudes. long (required):
 120            /// The longitude of the client's location, in degrees. The longitude must be
 121            /// greater than or equal to -180.0 and less than or equal to +180.0. Negative
 122            /// values indicate western longitudes and positive values indicate eastern
 123            /// longitudes. re (required): The radius, in meters, which specifies the
 124            /// horizontal accuracy of the coordinates. Pass the value returned by the
 125            /// device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m
 126            /// for cell tower triangulation, and 18,000m for reverse IP lookup. ts
 127            /// (optional): The UTC UNIX timestamp of when the client was at the location.
 128            /// (The UNIX timestamp is the number of seconds since January 1, 1970.) head
 129            /// (optional): The client's relative heading or direction of travel. Specify
 130            /// the direction of travel as degrees from 0 through 360, counting clockwise
 131            /// relative to true north. Specify this key only if the sp key is nonzero. sp
 132            /// (optional): The horizontal velocity (speed), in meters per second, that the
 133            /// client device is traveling. alt (optional): The altitude of the client
 134            /// device, in meters. are (optional): The radius, in meters, that specifies
 135            /// the vertical accuracy of the coordinates. Specify this key only if you
 136            /// specify the alt key. Although many of the keys are optional, the more
 137            /// information that you provide, the more accurate the location results are.
 138            /// Although optional, you are encouraged to always specify the user's
 139            /// geographical location. Providing the location is especially important if
 140            /// the client's IP address does not accurately reflect the user's physical
 141            /// location (for example, if the client uses VPN). For optimal results, you
 142            /// should include this header and the X-MSEdge-ClientIP header, but at a
 143            /// minimum, you should include this header.
 144            /// </param>
 145            /// <param name='countryCode'>
 146            /// A 2-character country code of the country where the results come from. This
 147            /// API supports only the United States market. If you specify this query
 148            /// parameter, it must be set to us. If you set this parameter, you must also
 149            /// specify the Accept-Language header. Bing uses the first supported language
 150            /// it finds from the languages list, and combine that language with the
 151            /// country code that you specify to determine the market to return results
 152            /// for. If the languages list does not include a supported language, Bing
 153            /// finds the closest language and market that supports the request, or it may
 154            /// use an aggregated or default market for the results instead of a specified
 155            /// one. You should use this query parameter and the Accept-Language query
 156            /// parameter only if you specify multiple languages; otherwise, you should use
 157            /// the mkt and setLang query parameters. This parameter and the mkt query
 158            /// parameter are mutually exclusive—do not specify both.
 159            /// </param>
 160            /// <param name='market'>
 161            /// The market where the results come from. You are strongly encouraged to
 162            /// always specify the market, if known. Specifying the market helps Bing route
 163            /// the request and return an appropriate and optimal response. This parameter
 164            /// and the cc query parameter are mutually exclusive—do not specify both.
 165            /// </param>
 166            /// <param name='responseFilter'>
 167            /// A comma-delimited list of answers to include in the response. If you do not
 168            /// specify this parameter, the response includes all search answers for which
 169            /// there's relevant data.
 170            /// </param>
 171            /// <param name='responseFormat'>
 172            /// The media type to use for the response. The following are the possible
 173            /// case-insensitive values: JSON, JSONLD. The default is JSON. If you specify
 174            /// JSONLD, the response body includes JSON-LD objects that contain the search
 175            /// results.
 176            /// </param>
 177            /// <param name='safeSearch'>
 178            /// A filter used to filter adult content. Off: Return webpages with adult
 179            /// text, images, or videos. Moderate: Return webpages with adult text, but not
 180            /// adult images or videos. Strict: Do not return webpages with adult text,
 181            /// images, or videos. The default is Moderate. If the request comes from a
 182            /// market that Bing's adult policy requires that safeSearch is set to Strict,
 183            /// Bing ignores the safeSearch value and uses Strict. If you use the site:
 184            /// query operator, there is the chance that the response may contain adult
 185            /// content regardless of what the safeSearch query parameter is set to. Use
 186            /// site: only if you are aware of the content on the site and your scenario
 187            /// supports the possibility of adult content. Possible values include: 'Off',
 188            /// 'Moderate', 'Strict'
 189            /// </param>
 190            /// <param name='setLang'>
 191            /// The language to use for user interface strings. Specify the language using
 192            /// the ISO 639-1 2-letter language code. For example, the language code for
 193            /// English is EN. The default is EN (English). Although optional, you should
 194            /// always specify the language. Typically, you set setLang to the same
 195            /// language specified by mkt unless the user wants the user interface strings
 196            /// displayed in a different language. This parameter and the Accept-Language
 197            /// header are mutually exclusive; do not specify both. A user interface string
 198            /// is a string that's used as a label in a user interface. There are few user
 199            /// interface strings in the JSON response objects. Also, any links to Bing.com
 200            /// properties in the response objects apply the specified language.
 201            /// </param>
 202            public static SearchResponse Search(this IEntitiesOperations operations, string query, string acceptLanguage
 203            {
 2204                return operations.SearchAsync(query, acceptLanguage, pragma, userAgent, clientId, clientIp, location, co
 205            }
 206
 207            /// <summary>
 208            /// The Entity Search API lets you send a search query to Bing and get back
 209            /// search results that include entities and places. Place results include
 210            /// restaurants, hotel, or other local businesses. For places, the query can
 211            /// specify the name of the local business or it can ask for a list (for
 212            /// example, restaurants near me). Entity results include persons, places, or
 213            /// things. Place in this context is tourist attractions, states, countries,
 214            /// etc.
 215            /// </summary>
 216            /// <param name='operations'>
 217            /// The operations group for this extension method.
 218            /// </param>
 219            /// <param name='query'>
 220            /// The user's search term.
 221            /// </param>
 222            /// <param name='acceptLanguage'>
 223            /// A comma-delimited list of one or more languages to use for user interface
 224            /// strings. The list is in decreasing order of preference. For additional
 225            /// information, including expected format, see
 226            /// [RFC2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html). This
 227            /// header and the setLang query parameter are mutually exclusive; do not
 228            /// specify both. If you set this header, you must also specify the cc query
 229            /// parameter. Bing will use the first supported language it finds from the
 230            /// list, and combine that language with the cc parameter value to determine
 231            /// the market to return results for. If the list does not include a supported
 232            /// language, Bing will find the closest language and market that supports the
 233            /// request, and may use an aggregated or default market for the results
 234            /// instead of a specified one. You should use this header and the cc query
 235            /// parameter only if you specify multiple languages; otherwise, you should use
 236            /// the mkt and setLang query parameters. A user interface string is a string
 237            /// that's used as a label in a user interface. There are very few user
 238            /// interface strings in the JSON response objects. Any links in the response
 239            /// objects to Bing.com properties will apply the specified language.
 240            /// </param>
 241            /// <param name='pragma'>
 242            /// By default, Bing returns cached content, if available. To prevent Bing from
 243            /// returning cached content, set the Pragma header to no-cache (for example,
 244            /// Pragma: no-cache).
 245            /// </param>
 246            /// <param name='userAgent'>
 247            /// The user agent originating the request. Bing uses the user agent to provide
 248            /// mobile users with an optimized experience. Although optional, you are
 249            /// strongly encouraged to always specify this header. The user-agent should be
 250            /// the same string that any commonly used browser would send. For information
 251            /// about user agents, see [RFC
 252            /// 2616](http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html).
 253            /// </param>
 254            /// <param name='clientId'>
 255            /// Bing uses this header to provide users with consistent behavior across Bing
 256            /// API calls. Bing often flights new features and improvements, and it uses
 257            /// the client ID as a key for assigning traffic on different flights. If you
 258            /// do not use the same client ID for a user across multiple requests, then
 259            /// Bing may assign the user to multiple conflicting flights. Being assigned to
 260            /// multiple conflicting flights can lead to an inconsistent user experience.
 261            /// For example, if the second request has a different flight assignment than
 262            /// the first, the experience may be unexpected. Also, Bing can use the client
 263            /// ID to tailor web results to that client ID’s search history, providing a
 264            /// richer experience for the user. Bing also uses this header to help improve
 265            /// result rankings by analyzing the activity generated by a client ID. The
 266            /// relevance improvements help with better quality of results delivered by
 267            /// Bing APIs and in turn enables higher click-through rates for the API
 268            /// consumer. IMPORTANT: Although optional, you should consider this header
 269            /// required. Persisting the client ID across multiple requests for the same
 270            /// end user and device combination enables 1) the API consumer to receive a
 271            /// consistent user experience, and 2) higher click-through rates via better
 272            /// quality of results from the Bing APIs. Each user that uses your application
 273            /// on the device must have a unique, Bing generated client ID. If you do not
 274            /// include this header in the request, Bing generates an ID and returns it in
 275            /// the X-MSEdge-ClientID response header. The only time that you should NOT
 276            /// include this header in a request is the first time the user uses your app
 277            /// on that device. Use the client ID for each Bing API request that your app
 278            /// makes for this user on the device. Persist the client ID. To persist the ID
 279            /// in a browser app, use a persistent HTTP cookie to ensure the ID is used
 280            /// across all sessions. Do not use a session cookie. For other apps such as
 281            /// mobile apps, use the device's persistent storage to persist the ID. The
 282            /// next time the user uses your app on that device, get the client ID that you
 283            /// persisted. Bing responses may or may not include this header. If the
 284            /// response includes this header, capture the client ID and use it for all
 285            /// subsequent Bing requests for the user on that device. If you include the
 286            /// X-MSEdge-ClientID, you must not include cookies in the request.
 287            /// </param>
 288            /// <param name='clientIp'>
 289            /// The IPv4 or IPv6 address of the client device. The IP address is used to
 290            /// discover the user's location. Bing uses the location information to
 291            /// determine safe search behavior. Although optional, you are encouraged to
 292            /// always specify this header and the X-Search-Location header. Do not
 293            /// obfuscate the address (for example, by changing the last octet to 0).
 294            /// Obfuscating the address results in the location not being anywhere near the
 295            /// device's actual location, which may result in Bing serving erroneous
 296            /// results.
 297            /// </param>
 298            /// <param name='location'>
 299            /// A semicolon-delimited list of key/value pairs that describe the client's
 300            /// geographical location. Bing uses the location information to determine safe
 301            /// search behavior and to return relevant local content. Specify the key/value
 302            /// pair as &lt;key&gt;:&lt;value&gt;. The following are the keys that you use
 303            /// to specify the user's location. lat (required): The latitude of the
 304            /// client's location, in degrees. The latitude must be greater than or equal
 305            /// to -90.0 and less than or equal to +90.0. Negative values indicate southern
 306            /// latitudes and positive values indicate northern latitudes. long (required):
 307            /// The longitude of the client's location, in degrees. The longitude must be
 308            /// greater than or equal to -180.0 and less than or equal to +180.0. Negative
 309            /// values indicate western longitudes and positive values indicate eastern
 310            /// longitudes. re (required): The radius, in meters, which specifies the
 311            /// horizontal accuracy of the coordinates. Pass the value returned by the
 312            /// device's location service. Typical values might be 22m for GPS/Wi-Fi, 380m
 313            /// for cell tower triangulation, and 18,000m for reverse IP lookup. ts
 314            /// (optional): The UTC UNIX timestamp of when the client was at the location.
 315            /// (The UNIX timestamp is the number of seconds since January 1, 1970.) head
 316            /// (optional): The client's relative heading or direction of travel. Specify
 317            /// the direction of travel as degrees from 0 through 360, counting clockwise
 318            /// relative to true north. Specify this key only if the sp key is nonzero. sp
 319            /// (optional): The horizontal velocity (speed), in meters per second, that the
 320            /// client device is traveling. alt (optional): The altitude of the client
 321            /// device, in meters. are (optional): The radius, in meters, that specifies
 322            /// the vertical accuracy of the coordinates. Specify this key only if you
 323            /// specify the alt key. Although many of the keys are optional, the more
 324            /// information that you provide, the more accurate the location results are.
 325            /// Although optional, you are encouraged to always specify the user's
 326            /// geographical location. Providing the location is especially important if
 327            /// the client's IP address does not accurately reflect the user's physical
 328            /// location (for example, if the client uses VPN). For optimal results, you
 329            /// should include this header and the X-MSEdge-ClientIP header, but at a
 330            /// minimum, you should include this header.
 331            /// </param>
 332            /// <param name='countryCode'>
 333            /// A 2-character country code of the country where the results come from. This
 334            /// API supports only the United States market. If you specify this query
 335            /// parameter, it must be set to us. If you set this parameter, you must also
 336            /// specify the Accept-Language header. Bing uses the first supported language
 337            /// it finds from the languages list, and combine that language with the
 338            /// country code that you specify to determine the market to return results
 339            /// for. If the languages list does not include a supported language, Bing
 340            /// finds the closest language and market that supports the request, or it may
 341            /// use an aggregated or default market for the results instead of a specified
 342            /// one. You should use this query parameter and the Accept-Language query
 343            /// parameter only if you specify multiple languages; otherwise, you should use
 344            /// the mkt and setLang query parameters. This parameter and the mkt query
 345            /// parameter are mutually exclusive—do not specify both.
 346            /// </param>
 347            /// <param name='market'>
 348            /// The market where the results come from. You are strongly encouraged to
 349            /// always specify the market, if known. Specifying the market helps Bing route
 350            /// the request and return an appropriate and optimal response. This parameter
 351            /// and the cc query parameter are mutually exclusive—do not specify both.
 352            /// </param>
 353            /// <param name='responseFilter'>
 354            /// A comma-delimited list of answers to include in the response. If you do not
 355            /// specify this parameter, the response includes all search answers for which
 356            /// there's relevant data.
 357            /// </param>
 358            /// <param name='responseFormat'>
 359            /// The media type to use for the response. The following are the possible
 360            /// case-insensitive values: JSON, JSONLD. The default is JSON. If you specify
 361            /// JSONLD, the response body includes JSON-LD objects that contain the search
 362            /// results.
 363            /// </param>
 364            /// <param name='safeSearch'>
 365            /// A filter used to filter adult content. Off: Return webpages with adult
 366            /// text, images, or videos. Moderate: Return webpages with adult text, but not
 367            /// adult images or videos. Strict: Do not return webpages with adult text,
 368            /// images, or videos. The default is Moderate. If the request comes from a
 369            /// market that Bing's adult policy requires that safeSearch is set to Strict,
 370            /// Bing ignores the safeSearch value and uses Strict. If you use the site:
 371            /// query operator, there is the chance that the response may contain adult
 372            /// content regardless of what the safeSearch query parameter is set to. Use
 373            /// site: only if you are aware of the content on the site and your scenario
 374            /// supports the possibility of adult content. Possible values include: 'Off',
 375            /// 'Moderate', 'Strict'
 376            /// </param>
 377            /// <param name='setLang'>
 378            /// The language to use for user interface strings. Specify the language using
 379            /// the ISO 639-1 2-letter language code. For example, the language code for
 380            /// English is EN. The default is EN (English). Although optional, you should
 381            /// always specify the language. Typically, you set setLang to the same
 382            /// language specified by mkt unless the user wants the user interface strings
 383            /// displayed in a different language. This parameter and the Accept-Language
 384            /// header are mutually exclusive; do not specify both. A user interface string
 385            /// is a string that's used as a label in a user interface. There are few user
 386            /// interface strings in the JSON response objects. Also, any links to Bing.com
 387            /// properties in the response objects apply the specified language.
 388            /// </param>
 389            /// <param name='cancellationToken'>
 390            /// The cancellation token.
 391            /// </param>
 392            public static async Task<SearchResponse> SearchAsync(this IEntitiesOperations operations, string query, stri
 393            {
 2394                using (var _result = await operations.SearchWithHttpMessagesAsync(query, acceptLanguage, pragma, userAge
 395                {
 2396                    return _result.Body;
 397                }
 2398            }
 399
 400    }
 401}
Generated by: ReportGenerator 4.6.4.0
8/12/2020 - 3:47:14 PM
GitHub | www.palmmedia.de

Methods/Properties

Search(...)
SearchAsync()