다음을 통해 공유

WebSearchClientOptions interface

  • 참조
패키지:
@azure/cognitiveservices-websearch

WebSearchClientOptions를 나타내는 인터페이스입니다.

Extends
ServiceClientOptions

속성

endpoint

지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름: "https://westus.api.cognitive.microsoft.com", "https://api.cognitive.microsoft.com"). 기본값: 'https://api.cognitive.microsoft.com'.

상속된 속성

agentSettings

모든 HTTP 요청에 사용할 HTTP 및 HTTPS 에이전트(Node.js만 해당).
baseUri

지정된 경우:

  • 이 baseUri URI는 이 ServiceClient에 대해 요청이 수행되는 기본 URI가 됩니다.
  • 가 baseUri 알려진 리소스 관리자 엔드포인트와 일치하고 가 TokenCredential 생성자를 통해 전달된 경우 범위를 baseUri 로 정의합니다 getToken${options.baseUri}/.default. 그렇지 않으면 범위는 기본적으로 "https://management.azure.com/.default"로 설정됩니다.

지정되지 않은 경우:

  • 모든 OperationSpecs에는 baseUrl 속성이 포함되어야 합니다.
  • 가 TokenCredential 생성자를 getToken 통해 전달된 경우 범위는 "https://management.azure.com/.default"로 설정됩니다.
clientRequestIdHeaderName

지정한 경우 이 헤더 이름과 임의 UUID를 요청 ID로 사용하여 나가는 모든 요청에 헤더를 추가하는 GenerateRequestIdPolicy가 HTTP 파이프라인에 추가됩니다.
deserializationContentTypes

JSON 또는 XML serialization과 연결할 콘텐츠 형식입니다.
generateClientRequestIdHeader

각 HTTP 요청에 대한 클라이언트 요청 ID 헤더를 생성할지 여부입니다.
httpClient

HTTP 요청을 보내는 데 사용할 HttpClient입니다.
httpPipelineLogger

HTTP 파이프라인 내에서 RequestPolicies를 디버그하는 데 사용할 수 있는 HttpPipelineLogger입니다.
noRetryPolicy

true로 설정하면 기본 다시 시도 정책을 끕니다.
proxySettings

모든 HTTP 요청에 사용할 프록시 설정(Node.js만 해당).
redirectOptions

리디렉션 응답을 처리하는 방법에 대한 옵션입니다.
requestPolicyFactories

유선에서 HTTP 요청을 보내는 데 사용되는 RequestPolicy 파이프라인을 만들기 위해 호출되는 팩터리 배열 또는 defaultRequestPolicyFactories를 사용하고 사용할 requestPolicyFactories를 반환하는 함수입니다.
rpRegistrationRetryTimeout

AutomaticRPRegistration에 대한 재시도 시간 제한(초)을 가져오거나 설정합니다. 기본값은 30입니다.
userAgent

요청을 보내는 동안 원격 분석 헤더로 설정할 문자열 또는 기본 사용자 에이전트 문자열을 사용하고 사용할 사용자 에이전트 문자열을 반환하는 함수입니다.
userAgentHeaderName

요청을 보내는 동안 원격 분석 헤더에 사용할 헤더 이름입니다. 이 옵션을 지정하지 않으면 Node.js 실행할 때 "User-Agent"가 사용되고 브라우저에서 실행할 때 "x-ms-command-name"이 사용됩니다.
withCredentials

브라우저의 CORS 요청에 자격 증명을 포함할지 여부입니다. 자세한 내용은 https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials 을 참조하세요.

속성 세부 정보

endpoint

지원되는 Cognitive Services 엔드포인트(프로토콜 및 호스트 이름: "https://westus.api.cognitive.microsoft.com", "https://api.cognitive.microsoft.com"). 기본값: 'https://api.cognitive.microsoft.com'.

endpoint?: string

속성 값

string

상속된 속성 세부 정보

agentSettings

모든 HTTP 요청에 사용할 HTTP 및 HTTPS 에이전트(Node.js만 해당).

agentSettings?: AgentSettings

속성 값

AgentSettings

상속된 위치에서 ServiceClientOptions.agentSettings

baseUri

지정된 경우:

  • 이 baseUri URI는 이 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

속성 값

string

상속된 위치에서 ServiceClientOptions.baseUri

clientRequestIdHeaderName

지정한 경우 이 헤더 이름과 임의 UUID를 요청 ID로 사용하여 나가는 모든 요청에 헤더를 추가하는 GenerateRequestIdPolicy가 HTTP 파이프라인에 추가됩니다.

clientRequestIdHeaderName?: string

속성 값

string

상속된 위치에서 ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

JSON 또는 XML serialization과 연결할 콘텐츠 형식입니다.

deserializationContentTypes?: DeserializationContentTypes

속성 값

DeserializationContentTypes

상속된 위치에서 ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

각 HTTP 요청에 대한 클라이언트 요청 ID 헤더를 생성할지 여부입니다.

generateClientRequestIdHeader?: boolean

속성 값

boolean

상속된 위치에서 ServiceClientOptions.generateClientRequestIdHeader

httpClient

HTTP 요청을 보내는 데 사용할 HttpClient입니다.

httpClient?: HttpClient

속성 값

HttpClient

상속된 위치에서 ServiceClientOptions.httpClient

httpPipelineLogger

HTTP 파이프라인 내에서 RequestPolicies를 디버그하는 데 사용할 수 있는 HttpPipelineLogger입니다.

httpPipelineLogger?: HttpPipelineLogger

속성 값

HttpPipelineLogger

상속된 위치에서 ServiceClientOptions.httpPipelineLogger

noRetryPolicy

true로 설정하면 기본 다시 시도 정책을 끕니다.

noRetryPolicy?: boolean

속성 값

boolean

상속된 위치에서 ServiceClientOptions.noRetryPolicy

proxySettings

모든 HTTP 요청에 사용할 프록시 설정(Node.js만 해당).

proxySettings?: ProxySettings

속성 값

ProxySettings

상속된 위치에서 ServiceClientOptions.proxySettings

redirectOptions

리디렉션 응답을 처리하는 방법에 대한 옵션입니다.

redirectOptions?: RedirectOptions

속성 값

RedirectOptions

상속된 위치에서 ServiceClientOptions.redirectOptions

requestPolicyFactories

유선에서 HTTP 요청을 보내는 데 사용되는 RequestPolicy 파이프라인을 만들기 위해 호출되는 팩터리 배열 또는 defaultRequestPolicyFactories를 사용하고 사용할 requestPolicyFactories를 반환하는 함수입니다.

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

속성 값

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

상속된 위치에서 ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

AutomaticRPRegistration에 대한 재시도 시간 제한(초)을 가져오거나 설정합니다. 기본값은 30입니다.

rpRegistrationRetryTimeout?: number

속성 값

number

상속된 위치에서 ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

요청을 보내는 동안 원격 분석 헤더로 설정할 문자열 또는 기본 사용자 에이전트 문자열을 사용하고 사용할 사용자 에이전트 문자열을 반환하는 함수입니다.

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

속성 값

string | (defaultUserAgent: string) => string

상속된 위치에서 ServiceClientOptions.userAgent

userAgentHeaderName

요청을 보내는 동안 원격 분석 헤더에 사용할 헤더 이름입니다. 이 옵션을 지정하지 않으면 Node.js 실행할 때 "User-Agent"가 사용되고 브라우저에서 실행할 때 "x-ms-command-name"이 사용됩니다.

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

속성 값

string | (defaultUserAgentHeaderName: string) => string

상속된 위치에서 ServiceClientOptions.userAgentHeaderName

withCredentials

브라우저의 CORS 요청에 자격 증명을 포함할지 여부입니다. 자세한 내용은 https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials 을 참조하세요.

withCredentials?: boolean

속성 값

boolean

상속된 위치에서 ServiceClientOptions.withCredentials