VisualSearchClientOptions interface

Paquet:

@azure/cognitiveservices-visualsearch

Interface représentant VisualSearchClientOptions.

Extends

ServiceClientOptions

Propriétés

endpoint

Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : « https://westus.api.cognitive.microsoft.com", « https://api.cognitive.microsoft.com"). Valeur par défaut : 'https://api.cognitive.microsoft.com'.

Propriétés héritées

agentSettings	Agents HTTP et HTTPS qui seront utilisés pour chaque requête HTTP (Node.js uniquement).
baseUri	Si spécifié : Il s’agit baseUri de l’URI de base sur lequel les demandes seront effectuées pour ce ServiceClient. Si correspond à baseUri un point de terminaison resource manager connu et si un TokenCredential a été passé par le constructeur, cela baseUri définit l’étendue getToken comme étant ${options.baseUri}/.default. Sinon, la valeur par défaut de l’étendue est «https://management.azure.com/.default" ; ». S’il n’est pas spécifié : Toutes les OperationSpecs doivent contenir une propriété baseUrl. Si un TokenCredential a été passé par le constructeur, l’étendue getToken est définie sur "https://management.azure.com/.default" ;.
clientRequestIdHeaderName	S’il est spécifié, un GenerateRequestIdPolicy sera ajouté au pipeline HTTP qui ajoutera un en-tête à toutes les requêtes sortantes avec ce nom d’en-tête et un UUID aléatoire comme ID de requête.
deserializationContentTypes	Types de contenu qui seront associés à la sérialisation JSON ou XML.
generateClientRequestIdHeader	Indique s’il faut ou non générer un en-tête d’ID de requête client pour chaque requête HTTP.
httpClient	HttpClient qui sera utilisé pour envoyer des requêtes HTTP.
httpPipelineLogger	HttpPipelineLogger qui peut être utilisé pour déboguer RequestPolicies dans le pipeline HTTP.
noRetryPolicy	Si la valeur est true, désactivez la stratégie de nouvelle tentative par défaut.
proxySettings	Paramètres de proxy qui seront utilisés pour chaque requête HTTP (Node.js uniquement).
redirectOptions	Options pour la façon dont les réponses de redirection sont gérées.
requestPolicyFactories	Tableau de fabriques appelées pour créer le pipeline RequestPolicy utilisé pour envoyer une requête HTTP sur le câble, ou une fonction qui accepte le defaultRequestPolicyFactories et retourne les requestPolicyFactories qui seront utilisées.
rpRegistrationRetryTimeout	Obtient ou définit le délai d’expiration des nouvelles tentatives en secondes pour AutomaticRPRegistration. La valeur par défaut est 30.
userAgent	Chaîne à définir sur l’en-tête de télémétrie lors de l’envoi de la requête, ou une fonction qui accepte la chaîne d’agent utilisateur par défaut et retourne la chaîne user-agent qui sera utilisée.
userAgentHeaderName	Nom d’en-tête à utiliser pour l’en-tête de télémétrie lors de l’envoi de la demande. Si ce n’est pas spécifié, « User-Agent » sera utilisé lors de l’exécution sur Node.js et « x-ms-command-name » sera utilisé lors de l’exécution dans un navigateur.
withCredentials	Indique s’il faut inclure des informations d’identification dans les demandes CORS dans le navigateur. Consultez la rubrique https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials (éventuellement en anglais) pour plus d'informations.

Détails de la propriété

endpoint

Points de terminaison Cognitive Services pris en charge (protocole et nom d’hôte, par exemple : « https://westus.api.cognitive.microsoft.com", « https://api.cognitive.microsoft.com"). Valeur par défaut : 'https://api.cognitive.microsoft.com'.

endpoint?: string

Valeur de propriété

string

Détails de la propriété héritée

agentSettings

Agents HTTP et HTTPS qui seront utilisés pour chaque requête HTTP (Node.js uniquement).

agentSettings?: AgentSettings

Valeur de propriété

AgentSettings

Hérité de ServiceClientOptions.agentSettings

baseUri

Si spécifié :

• Il s’agit baseUri de l’URI de base sur lequel les demandes seront effectuées pour ce ServiceClient.
• Si correspond à baseUri un point de terminaison resource manager connu et si un TokenCredential a été passé par le constructeur, cela baseUri définit l’étendue getToken comme étant ${options.baseUri}/.default. Sinon, la valeur par défaut de l’étendue est «https://management.azure.com/.default" ; ».

S’il n’est pas spécifié :

• Toutes les OperationSpecs doivent contenir une propriété baseUrl.
• Si un TokenCredential a été passé par le constructeur, l’étendue getToken est définie sur "https://management.azure.com/.default" ;.

baseUri?: string

Valeur de propriété

string

Hérité de ServiceClientOptions.baseUri

clientRequestIdHeaderName

S’il est spécifié, un GenerateRequestIdPolicy sera ajouté au pipeline HTTP qui ajoutera un en-tête à toutes les requêtes sortantes avec ce nom d’en-tête et un UUID aléatoire comme ID de requête.

clientRequestIdHeaderName?: string

Valeur de propriété

string

Hérité de ServiceClientOptions.clientRequestIdHeaderName

deserializationContentTypes

Types de contenu qui seront associés à la sérialisation JSON ou XML.

deserializationContentTypes?: DeserializationContentTypes

Valeur de propriété

DeserializationContentTypes

Hérité de ServiceClientOptions.deserializationContentTypes

generateClientRequestIdHeader

Indique s’il faut ou non générer un en-tête d’ID de requête client pour chaque requête HTTP.

generateClientRequestIdHeader?: boolean

Valeur de propriété

boolean

Hérité de ServiceClientOptions.generateClientRequestIdHeader

httpClient

HttpClient qui sera utilisé pour envoyer des requêtes HTTP.

httpClient?: HttpClient

Valeur de propriété

HttpClient

Hérité de ServiceClientOptions.httpClient

httpPipelineLogger

HttpPipelineLogger qui peut être utilisé pour déboguer RequestPolicies dans le pipeline HTTP.

httpPipelineLogger?: HttpPipelineLogger

Valeur de propriété

HttpPipelineLogger

Hérité de ServiceClientOptions.httpPipelineLogger

noRetryPolicy

Si la valeur est true, désactivez la stratégie de nouvelle tentative par défaut.

noRetryPolicy?: boolean

Valeur de propriété

boolean

Hérité de ServiceClientOptions.noRetryPolicy

proxySettings

Paramètres de proxy qui seront utilisés pour chaque requête HTTP (Node.js uniquement).

proxySettings?: ProxySettings

Valeur de propriété

ProxySettings

Hérité de ServiceClientOptions.proxySettings

redirectOptions

Options pour la façon dont les réponses de redirection sont gérées.

redirectOptions?: RedirectOptions

Valeur de propriété

RedirectOptions

Hérité de ServiceClientOptions.redirectOptions

requestPolicyFactories

Tableau de fabriques appelées pour créer le pipeline RequestPolicy utilisé pour envoyer une requête HTTP sur le câble, ou une fonction qui accepte le defaultRequestPolicyFactories et retourne les requestPolicyFactories qui seront utilisées.

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

Valeur de propriété

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

Hérité de ServiceClientOptions.requestPolicyFactories

rpRegistrationRetryTimeout

Obtient ou définit le délai d’expiration des nouvelles tentatives en secondes pour AutomaticRPRegistration. La valeur par défaut est 30.

rpRegistrationRetryTimeout?: number

Valeur de propriété

number

Hérité de ServiceClientOptions.rpRegistrationRetryTimeout

userAgent

Chaîne à définir sur l’en-tête de télémétrie lors de l’envoi de la requête, ou une fonction qui accepte la chaîne d’agent utilisateur par défaut et retourne la chaîne user-agent qui sera utilisée.

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

Valeur de propriété

string | (defaultUserAgent: string) => string

Hérité de ServiceClientOptions.userAgent

userAgentHeaderName

Nom d’en-tête à utiliser pour l’en-tête de télémétrie lors de l’envoi de la demande. Si ce n’est pas spécifié, « User-Agent » sera utilisé lors de l’exécution sur Node.js et « x-ms-command-name » sera utilisé lors de l’exécution dans un navigateur.

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

Valeur de propriété

string | (defaultUserAgentHeaderName: string) => string

Hérité de ServiceClientOptions.userAgentHeaderName

withCredentials

Indique s’il faut inclure des informations d’identification dans les demandes CORS dans le navigateur. Consultez la rubrique https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest/withCredentials (éventuellement en anglais) pour plus d'informations.

withCredentials?: boolean

Valeur de propriété

boolean

Hérité de ServiceClientOptions.withCredentials