AIProjectClientOptionalParams interface

Pakiet:
@azure/ai-projects

Parametry opcjonalne dla klienta.

Rozszerzenie
ClientOptions

Właściwości

apiVersion

Znane wartości KnownApiVersions akceptowane przez usługę.
tracingOptions

Opcje konfiguracji śledzenia GenAI dla tej instancji klienta. Po udostępnieniu śledzenie GenAI jest włączone dla wszystkich obsługiwanych operacji realizowanych przez tego klienta. Po pominięciu nie są emitowane żadne rozpięcia GenAI ani metryki.

Właściwości dziedziczone

additionalPolicies

Dodatkowe zasady do uwzględnienia w potoku HTTP.
agent

Opcje konfigurowania wystąpienia agenta dla żądań wychodzących
allowInsecureConnection

Opcja zezwalania na wywoływanie punktów końcowych http (niezabezpieczonych)
baseUrl

Podstawowy adres URL klienta
credentials

Informacje o poświadczeniach
endpoint

Punkt końcowy dla klienta
httpClient

Określ niestandardowy obiekt HttpClient podczas tworzenia żądań.
loggingOptions

Opcje konfigurowania rejestrowania żądań/odpowiedzi.
pipeline

Pipeline do wykorzystania dla klienta. Jeśli nie zostanie udostępniony, zostanie utworzony domyślny pipeline z wykorzystaniem dostępnych opcji. Traktuj ostrożnie — przy ustawianiu tej opcji wszystkie opcje klienta używane przy tworzeniu domyślnego potoku zostaną zignorowane.
proxyOptions

Opcje konfigurowania serwera proxy dla żądań wychodzących.
redirectOptions

Opcje obsługi odpowiedzi przekierowania.
retryOptions

Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.
telemetryOptions

Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.
tlsOptions

Opcje konfigurowania uwierzytelniania TLS
userAgentOptions

Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

Szczegóły właściwości

apiVersion

Znane wartości KnownApiVersions akceptowane przez usługę.

apiVersion?: v1

Wartość właściwości

v1

tracingOptions

Opcje konfiguracji śledzenia GenAI dla tej instancji klienta. Po udostępnieniu śledzenie GenAI jest włączone dla wszystkich obsługiwanych operacji realizowanych przez tego klienta. Po pominięciu nie są emitowane żadne rozpięcia GenAI ani metryki.

tracingOptions?: GenAITracingOptions

Wartość właściwości

GenAITracingOptions

Szczegóły właściwości dziedziczonej

additionalPolicies

Dodatkowe zasady do uwzględnienia w potoku HTTP.

additionalPolicies?: AdditionalPolicyConfig[]

Wartość właściwości

AdditionalPolicyConfig[]

dziedziczone z ClientOptions.additionalPolicies

agent

Opcje konfigurowania wystąpienia agenta dla żądań wychodzących

agent?: Agent

Wartość właściwości

Agent

dziedziczone z ClientOptions.agent

allowInsecureConnection

Opcja zezwalania na wywoływanie punktów końcowych http (niezabezpieczonych)

allowInsecureConnection?: boolean

Wartość właściwości

boolean

dziedziczone z ClientOptions.allowInsecureConnection

baseUrl

Ostrzeżenie

Ten interfejs API jest już przestarzały.

This property is deprecated and will be removed soon, please use endpoint instead

Podstawowy adres URL klienta

baseUrl?: string

Wartość właściwości

string

dziedziczone z ClientOptions.baseUrl

credentials

Informacje o poświadczeniach

credentials?: { apiKeyHeaderName?: string, scopes?: string[] }

Wartość właściwości

{ apiKeyHeaderName?: string, scopes?: string[] }

dziedziczone z ClientOptions.credentials

endpoint

Punkt końcowy dla klienta

endpoint?: string

Wartość właściwości

string

dziedziczone z ClientOptions.endpoint

httpClient

Określ niestandardowy obiekt HttpClient podczas tworzenia żądań.

httpClient?: HttpClient

Wartość właściwości

HttpClient

dziedziczone z ClientOptions.httpClient

loggingOptions

Opcje konfigurowania rejestrowania żądań/odpowiedzi.

loggingOptions?: LogPolicyOptions

Wartość właściwości

LogPolicyOptions

dziedziczone z ClientOptions.loggingOptions

pipeline

Pipeline do wykorzystania dla klienta. Jeśli nie zostanie udostępniony, zostanie utworzony domyślny pipeline z wykorzystaniem dostępnych opcji. Traktuj ostrożnie — przy ustawianiu tej opcji wszystkie opcje klienta używane przy tworzeniu domyślnego potoku zostaną zignorowane.

pipeline?: Pipeline

Wartość właściwości

Pipeline

Dziedziczone od ClientOptions.pipeline

proxyOptions

Opcje konfigurowania serwera proxy dla żądań wychodzących.

proxyOptions?: ProxySettings

Wartość właściwości

ProxySettings

dziedziczone z ClientOptions.proxyOptions

redirectOptions

Opcje obsługi odpowiedzi przekierowania.

redirectOptions?: RedirectPolicyOptions

Wartość właściwości

RedirectPolicyOptions

dziedziczone z ClientOptions.redirectOptions

retryOptions

Opcje kontrolujące sposób ponawiania żądań, które zakończyły się niepowodzeniem.

retryOptions?: PipelineRetryOptions

Wartość właściwości

PipelineRetryOptions

dziedziczone z ClientOptions.retryOptions

telemetryOptions

Opcje ustawiania typowych danych telemetrycznych i informacji śledzenia na żądania wychodzące.

telemetryOptions?: TelemetryOptions

Wartość właściwości

TelemetryOptions

dziedziczone z ClientOptions.telemetryOptions

tlsOptions

Opcje konfigurowania uwierzytelniania TLS

tlsOptions?: TlsSettings

Wartość właściwości

TlsSettings

dziedziczone z ClientOptions.tlsOptions

userAgentOptions

Opcje dodawania szczegółów agenta użytkownika do żądań wychodzących.

userAgentOptions?: UserAgentPolicyOptions

Wartość właściwości

UserAgentPolicyOptions

dziedziczone z ClientOptions.userAgentOptions