WebSearchOptionalParams interface

套件:

@azure/cognitiveservices-websearch

選擇性參數。

Extends

RequestOptionsBase

屬性

acceptLanguage	要用於使用者介面字串之一或多種語言的逗號分隔清單。 清單的喜好設定順序會遞減。 如需其他資訊，包括預期的格式，請參閱 RFC2616。 這個標頭和 setLang 查詢參數互斥;請勿同時指定兩者。 如果您設定此標頭，也必須指定cc查詢參數。 Bing 會使用從清單中找到的第一個支持語言，並將該語言與cc參數值結合，以判斷要傳回結果的市場。 如果清單不包含支持的語言，Bing 會找到支援要求的最接近的語言和市場，而且可能會針對結果使用匯總或預設市場，而不是指定的語言。 只有當您指定多種語言時，才應該使用此標頭和cc查詢參數;否則，您應該使用 mkt 和 setLang 查詢參數。 使用者介面字串是做為使用者介面中標籤的字串。 JSON 回應物件中很少有使用者介面字串。 回應物件中 Bing.com 屬性的任何鏈接都會套用指定的語言。
answerCount	您要包含回應的答案數目。 Bing 傳回的答案是以排名為基礎。 例如，如果 Bing 針對要求傳回網頁、影像、影片和相關搜尋，而且您將此參數設定為兩個 （2），回應會包含網頁和影像。如果您在相同的要求中包含 responseFilter 查詢參數，並將其設定為網頁和新聞，則回應只會包含網頁。
clientId	Bing 會使用此標頭來為使用者提供 Bing API 呼叫之間的一致行為。 Bing 通常會提供新功能和改進功能，並使用用戶端識別符作為指派不同航班流量的密鑰。 如果您未針對多個要求的使用者使用相同的用戶端標識符，則 Bing 可能會將使用者指派給多個衝突的航班。 指派給多個衝突的正式發行前小眾測試版可能會導致不一致的用戶體驗。 例如，如果第二個要求具有與第一個不同的正式發行前小眾測試版指派，則體驗可能會非預期。 此外，Bing 也可以使用用戶端標識符來針對該用戶端標識碼的搜尋歷程記錄量身打造 Web 結果，為使用者提供更豐富的體驗。 Bing 也會使用此標頭，藉由分析用戶端標識碼所產生的活動，協助改善結果排名。 相關性改善有助於提升 Bing API 所提供的結果品質，進而為 API 取用者啟用更高的點擊率。 重要：雖然是選擇性的，但您應該考慮此標頭。 將用戶端識別碼保存在相同使用者和裝置組合的多個要求之間，可讓 1） API 取用者接收一致的用戶體驗，以及 2） 透過 Bing API 結果品質更佳提高的點擊率來獲得更高的點擊率。 在裝置上使用應用程式的每個使用者都必須具有唯一的 Bing 產生的用戶端識別碼。 如果您未在要求中包含此標頭，Bing 會產生標識碼，並在 X-MSEdge-ClientID 回應標頭中傳回它。 您唯一不應該在要求中包含此標頭的時間，就是使用者第一次在該裝置上使用您的應用程式。 針對您應用程式針對裝置上的這個使用者所做的每個 Bing API 要求，使用用戶端識別碼。 保存用戶端識別碼。 若要在瀏覽器應用程式中保存識別碼，請使用持續性 HTTP Cookie 來確保所有作業階段都使用識別碼。 請勿使用會話 Cookie。 對於行動應用程式等其他應用程式，請使用裝置的永續性記憶體來保存標識碼。 下次使用者使用該裝置上的應用程式時，取得您保存的用戶端識別符。 Bing 回應不一定包含此標頭。 如果回應包含此標頭，請擷取用戶端標識碼，並將其用於該裝置上使用者的所有後續 Bing 要求。 如果您包含 X-MSEdge-ClientID，則不得在要求中包含 Cookie。
clientIp	用戶端裝置的 IPv4 或 IPv6 位址。 IP 位址用來探索使用者的位置。 Bing 會使用位置信息來判斷安全搜尋行為。 雖然是選擇性的，但建議您一律指定此標頭和 X-Search-Location 標頭。 請勿模糊位址（例如，將最後一個八位變更為 0）。 模糊位址會導致位置不在裝置的實際位置附近，這可能會導致 Bing 提供錯誤的結果。
count	回應中要傳回的搜尋結果數目。 默認值為 10，最大值為 50。 實際傳遞的數位可能小於要求。使用此參數搭配 offset 參數來分頁結果。例如，如果您的使用者介面顯示每頁 10 個搜尋結果，請將計數設定為 10，並將位移設為 0 以取得結果的第一頁。 針對每個後續頁面，遞增位移 10（例如 0、10、20）。 多個頁面有可能在結果中包含一些重疊。
countryCode	結果的來源國家/地區 2 個字元國家/地區代碼。 此 API 僅支援美國市場。 如果您指定此查詢參數，則必須將其設定為我們。 如果您設定此參數，也必須指定 Accept-Language 標頭。 Bing 會使用從語言清單中找到的第一個支持語言，並將該語言與您指定要決定要傳回結果的市場代碼的國家/地區代碼結合。 如果語言清單不包含支持的語言，Bing 會尋找支援要求的最接近的語言和市場，或者可能會針對結果使用匯總或默認市場，而不是指定的語言。 只有當您指定多種語言時，才應該使用這個查詢參數和 Accept-Language 查詢參數;否則，您應該使用 mkt 和 setLang 查詢參數。 此參數和 mkt 查詢參數互斥，請勿同時指定兩者。
freshness	依下列年齡值篩選搜尋結果：Day — 傳回 Bing 在過去 24 小時內探索到的網頁。 Week - 傳回 Bing 在過去 7 天內探索到的網頁。 Month - 傳回在過去 30 天內探索到的網頁。 此篩選僅適用於網頁結果，不適用於其他結果，例如新聞和影像。 可能的值包括：'Day'、'Week'、'Month'
location	以分號分隔的索引鍵/值組清單，描述用戶端的地理位置。 Bing 會使用位置信息來判斷安全搜尋行為，並傳回相關的本機內容。 將索引鍵/值組指定為 <索引鍵>：<值>。 以下是您用來指定使用者位置的金鑰。 lat （必要）：用戶端位置的緯度，以度為單位。 緯度必須大於或等於 -90.0，且小於或等於 +90.0。 負值表示南緯度，正值表示北緯度。 long （必要）：用戶端位置的經度，以度為單位。 經度必須大於或等於 -180.0，且小於或等於 +180.0。 負值表示西部經度，正值表示東部經度。 re （必要）：半徑，以公尺為單位，指定座標的水平精確度。 傳遞裝置位置服務所傳回的值。 一般值可能是 22m 用於 GPS/Wi-Fi、380m 用於細胞塔三角，以及 18,000m 的反向 IP 查閱。 ts （選擇性）：用戶端位於位置時的 UTC UNIX 時間戳。 （UNIX 時間戳是自 1970 年 1 月 1 日起的秒數。head （選擇性）：客戶端的相對標題或移動方向。 將移動方向指定為從 0 到 360 的度數，以順時針方式計算相對於 true north。 只有在sp機碼不是零時，才指定此索引鍵。 sp （選擇性）：用戶端裝置正在移動的水準速度（速度），以公尺為單位。 alt （選擇性）：用戶端裝置的高度，以公尺為單位。 為 （選擇性）：半徑，以公尺為單位，指定座標的垂直精確度。 只有在您指定alt鍵時，才指定此索引鍵。 雖然許多索引鍵都是選擇性的，但您提供的資訊越多，位置結果就越準確。 雖然是選擇性的，但建議您一律指定使用者的地理位置。 如果用戶端的IP位址未準確地反映用戶的實體位置，則提供位置特別重要（例如，如果用戶端使用 VPN）。 為了獲得最佳結果，您應該包含此標頭和 X-MSEdge-ClientIP 標頭，但至少應該包含此標頭。
market	結果來自的市場。 一般而言，mkt 是使用者提出要求的國家/地區。 不過，如果使用者不在 Bing 提供結果的國家/地區，它可能是不同的國家/地區。 市場必須採用語言代碼>-<國家代碼>的形式<。 例如，en-US。 字串不區分大小寫。 如果知道，建議您一律指定市場。 指定市場可協助 Bing 路由要求，並傳回適當且最佳的回應。 如果您指定市場代碼中未列出的市場，Bing 會根據可能會變更的內部對應，使用最適合的市場代碼。 此參數和cc查詢參數互斥，請勿同時指定兩者。 預設值：'en-us'。
offset	以零起始的位移，表示傳回結果之前要略過的搜尋結果數目。 預設值為 0。 位移應小於 （totalEstimatedMatches - count）。 使用此參數搭配 count 參數來分頁結果。 例如，如果您的使用者介面顯示每頁 10 個搜尋結果，請將計數設定為 10，並將位移設為 0 以取得結果的第一頁。 針對每個後續頁面，遞增位移 10（例如 0、10、20）。 多個頁面有可能在結果中包含一些重疊。
pragma	根據預設，Bing 會傳回快取的內容，如果有的話。 若要防止 Bing 傳回快取的內容，請將 Pragma 標頭設定為 no-cache（例如 Pragma：no-cache）。
promote	不論回應的排名為何，您都希望回應包含的以逗號分隔的答案清單。 例如，如果您將 answerCount） 設定為兩個 （2），因此 Bing 會傳回前兩個排名的答案，但您也希望回應包含新聞，您會將升階設定為新聞。 如果排名最高的答案是網頁、影像、影片和相關搜尋，回應會包含網頁和影像，因為新聞不是排名的答案。 但是，如果您將升級設定為影片，Bing 會將影片回應提升至回應，並傳回網頁、影像和影片。 您想要升級的答案不會計入 answerCount 限制。 例如，如果排名的答案是新聞、影像和影片，而您將 answerCount 設定為 1 並升階為新聞，則回應會包含新聞和影像。 或者，如果排名的答案是影片、影像和新聞，回應會包含影片和新聞。 可能的值為計算、影像、新聞、RelatedSearches、SpellSuggestions、TimeZone、Videos、網頁。 只有當您指定 answerCount 時，才使用 。
responseFilter	要包含在回應中的答案逗號分隔清單。 如果您未指定此參數，回應會包含相關數據的所有搜尋答案。 可能的篩選值包括計算、影像、新聞、RelatedSearches、SpellSuggestions、TimeZone、Videos、網頁。 雖然您可以使用此篩選來取得單一答案，但您應該改用答案特定的端點來取得更豐富的結果。 例如，若要只接收影像，請將要求傳送至其中一個影像搜尋 API 端點。 RelatedSearches 和 SpellSuggestions 答案不支援與影像搜尋 API 相同的個別端點（只有 Web 搜尋 API 會傳回這些端點）。 若要包含因為排名而排除的答案，請參閱升級查詢參數。
safeSearch	用來篩選成人內容的篩選。 關閉：傳回含有成人文字、影像或影片的網頁。 中度：傳回含有成人文字的網頁，但不會傳回成人影像或影片。 嚴格：不要傳回含有成人文字、影像或影片的網頁。 預設值為 [中度]。 如果要求來自 Bing 成人原則要求 safeSearch 設定為 Strict 的市場，Bing 會忽略 safeSearch 值並使用 Strict。 如果您使用網站：查詢運算符，則不論safeSearch查詢參數設定為什麼，回應都可能包含成人內容。 使用網站：只有當您知道網站上的內容，且您的案例支援成人內容的可能性時。 可能的值包括：'Off'、'Moderate'、'Strict'
setLang	要用於使用者介面字串的語言。 使用 ISO 639-1 2 字母語言代碼來指定語言。 例如，英文的語言代碼是 EN。 預設值為 EN （英文）。 雖然是選擇性的，但您應該一律指定語言。 一般而言，除非使用者想要以不同語言顯示的使用者介面字串，否則您將 setLang 設定為 mkt 所指定的相同語言。 此參數和 Accept-Language 標頭互斥;請勿同時指定兩者。 使用者介面字串是做為使用者介面中標籤的字串。 JSON 回應物件中很少有使用者介面字串。 此外，回應物件中 Bing.com 屬性的任何連結都套用指定的語言。
textDecorations	布爾值，決定顯示字串是否應該包含裝飾標記，例如點擊醒目提示字元。 如果為 true，則字串可能包含標記。 默認值為 false。 若要指定要使用 Unicode 字元或 HTML 標記做為標記，請參閱 textFormat 查詢參數。
textFormat	要用於文字裝飾的標記類型（請參閱 textDecorations 查詢參數）。 可能的值為 Raw— 使用 Unicode 字元來標記需要特殊格式的內容。 Unicode 字元的範圍為 E000 到 E019。 例如，Bing 會使用 E000 和 E001 來標記查詢字詞的開頭和結尾，以進行叫用醒目提示。 HTML- 使用 HTML 標籤需要特殊格式的內容。 例如，使用 標記來醒目提示顯示字串中的查詢字詞。 預設值為Raw。 針對包含可逸出 HTML 字元的字串，例如 <、>和 &，如果 textFormat 設定為 HTML，Bing 會適當地逸出字元（例如，< 逸出為 <）。 可能的值包括：'Raw'、'Html'
userAgent	源自要求的使用者代理程式。 Bing 會使用使用者代理程式來為行動使用者提供優化的體驗。 雖然是選擇性的，但強烈建議您一律指定此標頭。 使用者代理程式應該與任何常用瀏覽器傳送的字串相同。 如需使用者代理程式的相關信息，請參閱 RFC 2616。

繼承的屬性

abortSignal	可用來中止要求的訊號。
customHeaders	使用者定義自定義要求標頭，將在傳送要求之前套用。
onDownloadProgress	下載進度引發的回呼。
onUploadProgress	上傳進度時引發的回呼。
timeout	要求在自動終止之前可能需要的毫秒數。

屬性詳細資料

acceptLanguage

要用於使用者介面字串之一或多種語言的逗號分隔清單。 清單的喜好設定順序會遞減。 如需其他資訊，包括預期的格式，請參閱 RFC2616。 這個標頭和 setLang 查詢參數互斥;請勿同時指定兩者。 如果您設定此標頭，也必須指定cc查詢參數。 Bing 會使用從清單中找到的第一個支持語言，並將該語言與cc參數值結合，以判斷要傳回結果的市場。 如果清單不包含支持的語言，Bing 會找到支援要求的最接近的語言和市場，而且可能會針對結果使用匯總或預設市場，而不是指定的語言。 只有當您指定多種語言時，才應該使用此標頭和cc查詢參數;否則，您應該使用 mkt 和 setLang 查詢參數。 使用者介面字串是做為使用者介面中標籤的字串。 JSON 回應物件中很少有使用者介面字串。 回應物件中 Bing.com 屬性的任何鏈接都會套用指定的語言。

acceptLanguage?: string

屬性值

string

answerCount

您要包含回應的答案數目。 Bing 傳回的答案是以排名為基礎。 例如，如果 Bing 針對要求傳回網頁、影像、影片和相關搜尋，而且您將此參數設定為兩個 （2），回應會包含網頁和影像。如果您在相同的要求中包含 responseFilter 查詢參數，並將其設定為網頁和新聞，則回應只會包含網頁。

answerCount?: number

屬性值

number

clientId

Bing 會使用此標頭來為使用者提供 Bing API 呼叫之間的一致行為。 Bing 通常會提供新功能和改進功能，並使用用戶端識別符作為指派不同航班流量的密鑰。 如果您未針對多個要求的使用者使用相同的用戶端標識符，則 Bing 可能會將使用者指派給多個衝突的航班。 指派給多個衝突的正式發行前小眾測試版可能會導致不一致的用戶體驗。 例如，如果第二個要求具有與第一個不同的正式發行前小眾測試版指派，則體驗可能會非預期。 此外，Bing 也可以使用用戶端標識符來針對該用戶端標識碼的搜尋歷程記錄量身打造 Web 結果，為使用者提供更豐富的體驗。 Bing 也會使用此標頭，藉由分析用戶端標識碼所產生的活動，協助改善結果排名。 相關性改善有助於提升 Bing API 所提供的結果品質，進而為 API 取用者啟用更高的點擊率。 重要：雖然是選擇性的，但您應該考慮此標頭。 將用戶端識別碼保存在相同使用者和裝置組合的多個要求之間，可讓 1） API 取用者接收一致的用戶體驗，以及 2） 透過 Bing API 結果品質更佳提高的點擊率來獲得更高的點擊率。 在裝置上使用應用程式的每個使用者都必須具有唯一的 Bing 產生的用戶端識別碼。 如果您未在要求中包含此標頭，Bing 會產生標識碼，並在 X-MSEdge-ClientID 回應標頭中傳回它。 您唯一不應該在要求中包含此標頭的時間，就是使用者第一次在該裝置上使用您的應用程式。 針對您應用程式針對裝置上的這個使用者所做的每個 Bing API 要求，使用用戶端識別碼。 保存用戶端識別碼。 若要在瀏覽器應用程式中保存識別碼，請使用持續性 HTTP Cookie 來確保所有作業階段都使用識別碼。 請勿使用會話 Cookie。 對於行動應用程式等其他應用程式，請使用裝置的永續性記憶體來保存標識碼。 下次使用者使用該裝置上的應用程式時，取得您保存的用戶端識別符。 Bing 回應不一定包含此標頭。 如果回應包含此標頭，請擷取用戶端標識碼，並將其用於該裝置上使用者的所有後續 Bing 要求。 如果您包含 X-MSEdge-ClientID，則不得在要求中包含 Cookie。

clientId?: string

屬性值

string

clientIp

用戶端裝置的 IPv4 或 IPv6 位址。 IP 位址用來探索使用者的位置。 Bing 會使用位置信息來判斷安全搜尋行為。 雖然是選擇性的，但建議您一律指定此標頭和 X-Search-Location 標頭。 請勿模糊位址（例如，將最後一個八位變更為 0）。 模糊位址會導致位置不在裝置的實際位置附近，這可能會導致 Bing 提供錯誤的結果。

clientIp?: string

屬性值

string

count

回應中要傳回的搜尋結果數目。 默認值為 10，最大值為 50。 實際傳遞的數位可能小於要求。使用此參數搭配 offset 參數來分頁結果。例如，如果您的使用者介面顯示每頁 10 個搜尋結果，請將計數設定為 10，並將位移設為 0 以取得結果的第一頁。 針對每個後續頁面，遞增位移 10（例如 0、10、20）。 多個頁面有可能在結果中包含一些重疊。

count?: number

屬性值

number

countryCode

結果的來源國家/地區 2 個字元國家/地區代碼。 此 API 僅支援美國市場。 如果您指定此查詢參數，則必須將其設定為我們。 如果您設定此參數，也必須指定 Accept-Language 標頭。 Bing 會使用從語言清單中找到的第一個支持語言，並將該語言與您指定要決定要傳回結果的市場代碼的國家/地區代碼結合。 如果語言清單不包含支持的語言，Bing 會尋找支援要求的最接近的語言和市場，或者可能會針對結果使用匯總或默認市場，而不是指定的語言。 只有當您指定多種語言時，才應該使用這個查詢參數和 Accept-Language 查詢參數;否則，您應該使用 mkt 和 setLang 查詢參數。 此參數和 mkt 查詢參數互斥，請勿同時指定兩者。

countryCode?: string

屬性值

string

freshness

依下列年齡值篩選搜尋結果：Day — 傳回 Bing 在過去 24 小時內探索到的網頁。 Week - 傳回 Bing 在過去 7 天內探索到的網頁。 Month - 傳回在過去 30 天內探索到的網頁。 此篩選僅適用於網頁結果，不適用於其他結果，例如新聞和影像。 可能的值包括：'Day'、'Week'、'Month'

freshness?: Freshness

屬性值

Freshness

location

以分號分隔的索引鍵/值組清單，描述用戶端的地理位置。 Bing 會使用位置信息來判斷安全搜尋行為，並傳回相關的本機內容。 將索引鍵/值組指定為 <索引鍵>：<值>。 以下是您用來指定使用者位置的金鑰。 lat （必要）：用戶端位置的緯度，以度為單位。 緯度必須大於或等於 -90.0，且小於或等於 +90.0。 負值表示南緯度，正值表示北緯度。 long （必要）：用戶端位置的經度，以度為單位。 經度必須大於或等於 -180.0，且小於或等於 +180.0。 負值表示西部經度，正值表示東部經度。 re （必要）：半徑，以公尺為單位，指定座標的水平精確度。 傳遞裝置位置服務所傳回的值。 一般值可能是 22m 用於 GPS/Wi-Fi、380m 用於細胞塔三角，以及 18,000m 的反向 IP 查閱。 ts （選擇性）：用戶端位於位置時的 UTC UNIX 時間戳。 （UNIX 時間戳是自 1970 年 1 月 1 日起的秒數。head （選擇性）：客戶端的相對標題或移動方向。 將移動方向指定為從 0 到 360 的度數，以順時針方式計算相對於 true north。 只有在sp機碼不是零時，才指定此索引鍵。 sp （選擇性）：用戶端裝置正在移動的水準速度（速度），以公尺為單位。 alt （選擇性）：用戶端裝置的高度，以公尺為單位。 為 （選擇性）：半徑，以公尺為單位，指定座標的垂直精確度。 只有在您指定alt鍵時，才指定此索引鍵。 雖然許多索引鍵都是選擇性的，但您提供的資訊越多，位置結果就越準確。 雖然是選擇性的，但建議您一律指定使用者的地理位置。 如果用戶端的IP位址未準確地反映用戶的實體位置，則提供位置特別重要（例如，如果用戶端使用 VPN）。 為了獲得最佳結果，您應該包含此標頭和 X-MSEdge-ClientIP 標頭，但至少應該包含此標頭。

location?: string

屬性值

string

market

結果來自的市場。 一般而言，mkt 是使用者提出要求的國家/地區。 不過，如果使用者不在 Bing 提供結果的國家/地區，它可能是不同的國家/地區。 市場必須採用語言代碼>-<國家代碼>的形式<。 例如，en-US。 字串不區分大小寫。 如果知道，建議您一律指定市場。 指定市場可協助 Bing 路由要求，並傳回適當且最佳的回應。 如果您指定市場代碼中未列出的市場，Bing 會根據可能會變更的內部對應，使用最適合的市場代碼。 此參數和cc查詢參數互斥，請勿同時指定兩者。 預設值：'en-us'。

market?: string

屬性值

string

offset

以零起始的位移，表示傳回結果之前要略過的搜尋結果數目。 預設值為 0。 位移應小於 （totalEstimatedMatches - count）。 使用此參數搭配 count 參數來分頁結果。 例如，如果您的使用者介面顯示每頁 10 個搜尋結果，請將計數設定為 10，並將位移設為 0 以取得結果的第一頁。 針對每個後續頁面，遞增位移 10（例如 0、10、20）。 多個頁面有可能在結果中包含一些重疊。

offset?: number

屬性值

number

pragma

根據預設，Bing 會傳回快取的內容，如果有的話。 若要防止 Bing 傳回快取的內容，請將 Pragma 標頭設定為 no-cache（例如 Pragma：no-cache）。

pragma?: string

屬性值

string

promote

不論回應的排名為何，您都希望回應包含的以逗號分隔的答案清單。 例如，如果您將 answerCount） 設定為兩個 （2），因此 Bing 會傳回前兩個排名的答案，但您也希望回應包含新聞，您會將升階設定為新聞。 如果排名最高的答案是網頁、影像、影片和相關搜尋，回應會包含網頁和影像，因為新聞不是排名的答案。 但是，如果您將升級設定為影片，Bing 會將影片回應提升至回應，並傳回網頁、影像和影片。 您想要升級的答案不會計入 answerCount 限制。 例如，如果排名的答案是新聞、影像和影片，而您將 answerCount 設定為 1 並升階為新聞，則回應會包含新聞和影像。 或者，如果排名的答案是影片、影像和新聞，回應會包含影片和新聞。 可能的值為計算、影像、新聞、RelatedSearches、SpellSuggestions、TimeZone、Videos、網頁。 只有當您指定 answerCount 時，才使用 。

promote?: AnswerType[]

屬性值

AnswerType[]

responseFilter

要包含在回應中的答案逗號分隔清單。 如果您未指定此參數，回應會包含相關數據的所有搜尋答案。 可能的篩選值包括計算、影像、新聞、RelatedSearches、SpellSuggestions、TimeZone、Videos、網頁。 雖然您可以使用此篩選來取得單一答案，但您應該改用答案特定的端點來取得更豐富的結果。 例如，若要只接收影像，請將要求傳送至其中一個影像搜尋 API 端點。 RelatedSearches 和 SpellSuggestions 答案不支援與影像搜尋 API 相同的個別端點（只有 Web 搜尋 API 會傳回這些端點）。 若要包含因為排名而排除的答案，請參閱升級查詢參數。

responseFilter?: AnswerType[]

屬性值

AnswerType[]

safeSearch

用來篩選成人內容的篩選。 關閉：傳回含有成人文字、影像或影片的網頁。 中度：傳回含有成人文字的網頁，但不會傳回成人影像或影片。 嚴格：不要傳回含有成人文字、影像或影片的網頁。 預設值為 [中度]。 如果要求來自 Bing 成人原則要求 safeSearch 設定為 Strict 的市場，Bing 會忽略 safeSearch 值並使用 Strict。 如果您使用網站：查詢運算符，則不論safeSearch查詢參數設定為什麼，回應都可能包含成人內容。 使用網站：只有當您知道網站上的內容，且您的案例支援成人內容的可能性時。 可能的值包括：'Off'、'Moderate'、'Strict'

safeSearch?: SafeSearch

屬性值

SafeSearch

setLang

要用於使用者介面字串的語言。 使用 ISO 639-1 2 字母語言代碼來指定語言。 例如，英文的語言代碼是 EN。 預設值為 EN （英文）。 雖然是選擇性的，但您應該一律指定語言。 一般而言，除非使用者想要以不同語言顯示的使用者介面字串，否則您將 setLang 設定為 mkt 所指定的相同語言。 此參數和 Accept-Language 標頭互斥;請勿同時指定兩者。 使用者介面字串是做為使用者介面中標籤的字串。 JSON 回應物件中很少有使用者介面字串。 此外，回應物件中 Bing.com 屬性的任何連結都套用指定的語言。

setLang?: string

屬性值

string

textDecorations

布爾值，決定顯示字串是否應該包含裝飾標記，例如點擊醒目提示字元。 如果為 true，則字串可能包含標記。 默認值為 false。 若要指定要使用 Unicode 字元或 HTML 標記做為標記，請參閱 textFormat 查詢參數。

textDecorations?: boolean

屬性值

boolean

textFormat

要用於文字裝飾的標記類型（請參閱 textDecorations 查詢參數）。 可能的值為 Raw— 使用 Unicode 字元來標記需要特殊格式的內容。 Unicode 字元的範圍為 E000 到 E019。 例如，Bing 會使用 E000 和 E001 來標記查詢字詞的開頭和結尾，以進行叫用醒目提示。 HTML- 使用 HTML 標籤需要特殊格式的內容。 例如，使用 標記來醒目提示顯示字串中的查詢字詞。 預設值為Raw。 針對包含可逸出 HTML 字元的字串，例如 <、>和 &，如果 textFormat 設定為 HTML，Bing 會適當地逸出字元（例如，< 逸出為 <）。 可能的值包括：'Raw'、'Html'

textFormat?: TextFormat

屬性值

TextFormat

userAgent

源自要求的使用者代理程式。 Bing 會使用使用者代理程式來為行動使用者提供優化的體驗。 雖然是選擇性的，但強烈建議您一律指定此標頭。 使用者代理程式應該與任何常用瀏覽器傳送的字串相同。 如需使用者代理程式的相關信息，請參閱 RFC 2616。

userAgent?: string

屬性值

string

繼承的屬性詳細資料

abortSignal

可用來中止要求的訊號。

abortSignal?: AbortSignalLike

屬性值

AbortSignalLike

繼承自 msRest.RequestOptionsBase.abortSignal

customHeaders

使用者定義自定義要求標頭，將在傳送要求之前套用。

customHeaders?: {[key: string]: string}

屬性值

{[key: string]: string}

繼承自 msRest.RequestOptionsBase.customHeaders

onDownloadProgress

下載進度引發的回呼。

onDownloadProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

繼承自 msRest.RequestOptionsBase.onDownloadProgress

onUploadProgress

上傳進度時引發的回呼。

onUploadProgress?: (progress: TransferProgressEvent) => void

屬性值

(progress: TransferProgressEvent) => void

繼承自 msRest.RequestOptionsBase.onUploadProgress

timeout

要求在自動終止之前可能需要的毫秒數。

timeout?: number

屬性值

number

繼承自 msRest.RequestOptionsBase.timeout