WebSearchClientOptions interface

サポートされている Cognitive Services エンドポイント (プロトコルとホスト名:"https://westus.api.cognitive.microsoft.com"、"https://api.cognitive.microsoft.com")。 既定値: 'https://api.cognitive.microsoft.com'。

endpoint?: string

プロパティ値

すべての HTTP 要求に使用される HTTP および HTTPS エージェント (Node.jsのみ)。

agentSettings?: AgentSettings

プロパティ値

継承元 ServiceClientOptions.agentSettings

指定した場合:

• これは baseUri 、この ServiceClient に対して要求が行われるベース URI になります。
• が baseUri 既知のリソース マネージャー エンドポイントと一致し、 がコンストラクターを介して渡された場合 TokenCredential 、スコープ baseUri は getToken に ${options.baseUri}/.default定義されます。 それ以外の場合、スコープは既定で "https://management.azure.com/.default"" になります。

指定されていない場合:

• すべての OperationSpecs に baseUrl プロパティが含まれている必要があります。
• TokenCredentialがコンストラクターを介して渡された場合、getTokenスコープは "https://management.azure.com/.default"" に設定されます。

baseUri?: string

プロパティ値

継承元 ServiceClientOptions.baseUri

指定した場合、GenerateRequestIdPolicy は HTTP パイプラインに追加され、このヘッダー名とランダム UUID を要求 ID として持つすべての送信要求にヘッダーが追加されます。

clientRequestIdHeaderName?: string

プロパティ値

継承元 ServiceClientOptions.clientRequestIdHeaderName

JSON または XML シリアル化に関連付けられるコンテンツ タイプ。

deserializationContentTypes?: DeserializationContentTypes

プロパティ値

継承元 ServiceClientOptions.deserializationContentTypes

HTTP 要求ごとにクライアント要求 ID ヘッダーを生成するかどうか。

generateClientRequestIdHeader?: boolean

プロパティ値

継承元 ServiceClientOptions.generateClientRequestIdHeader

HTTP 要求の送信に使用される HttpClient。

httpClient?: HttpClient

プロパティ値

継承元 ServiceClientOptions.httpClient

HTTP パイプライン内で RequestPolicies をデバッグするために使用できる HttpPipelineLogger。

httpPipelineLogger?: HttpPipelineLogger

プロパティ値

継承元 ServiceClientOptions.httpPipelineLogger

true に設定されている場合は、既定の再試行ポリシーをオフにします。

noRetryPolicy?: boolean

プロパティ値

継承元 ServiceClientOptions.noRetryPolicy

すべての HTTP 要求に使用されるプロキシ設定 (Node.jsのみ)。

proxySettings?: ProxySettings

プロパティ値

継承元 ServiceClientOptions.proxySettings

リダイレクト応答の処理方法のオプション。

redirectOptions?: RedirectOptions

プロパティ値

継承元 ServiceClientOptions.redirectOptions

ネットワーク上で HTTP 要求を送信するために使用される RequestPolicy パイプラインを作成するために呼び出されるファクトリの配列、または defaultRequestPolicyFactories を受け取って使用される requestPolicyFactories を返す関数。

requestPolicyFactories?: RequestPolicyFactory[] | (defaultRequestPolicyFactories: RequestPolicyFactory[]) => void | RequestPolicyFactory[]

プロパティ値

継承元 ServiceClientOptions.requestPolicyFactories

AutomaticRPRegistration の再試行タイムアウトを秒単位で取得または設定します。 既定値は 30 です。

rpRegistrationRetryTimeout?: number

プロパティ値

継承元 ServiceClientOptions.rpRegistrationRetryTimeout

要求の送信中にテレメトリ ヘッダーに設定される文字列、または既定のユーザー エージェント文字列を受け取り、使用されるユーザー エージェント文字列を返す関数。

userAgent?: string | (defaultUserAgent: string) => string

プロパティ値

継承元 ServiceClientOptions.userAgent

要求の送信中にテレメトリ ヘッダーに使用するヘッダー名。 これが指定されていない場合は、Node.jsで実行するときに "User-Agent" が使用され、ブラウザーで実行するときに "x-ms-command-name" が使用されます。

userAgentHeaderName?: string | (defaultUserAgentHeaderName: string) => string

プロパティ値

継承元 ServiceClientOptions.userAgentHeaderName

ブラウザーの CORS 要求に資格情報を含めるかどうか。 詳細については、「https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials」を参照してください。

withCredentials?: boolean

プロパティ値

継承元 ServiceClientOptions.withCredentials