Skip to content

@awssolutions/gen-ai-evaluation-toolkit-ts-client


@awssolutions/gen-ai-evaluation-toolkit-ts-client / GenAiEvaluationToolkitClientResolvedConfig

Interface: GenAiEvaluationToolkitClientResolvedConfig

The resolved configuration interface of GenAiEvaluationToolkitClient class. This is resolved and normalized from the constructor configuration interface.

Extends

Properties

authSchemePreference

readonly authSchemePreference: Provider\<string[]>

A comma-separated list of case-sensitive auth scheme names. An auth scheme name is a fully qualified auth scheme ID with the namespace prefix trimmed. For example, the auth scheme with ID aws.auth#sigv4 is named sigv4.

Inherited from

GenAiEvaluationToolkitClientResolvedConfigType.authSchemePreference


base64Decoder

base64Decoder: Decoder

Internal

The function that will be used to convert a base64-encoded string to a byte array.

Inherited from

ClientDefaults.base64Decoder


base64Encoder

base64Encoder: Encoder

Internal

The function that will be used to convert binary data to a base64-encoded string.

Inherited from

ClientDefaults.base64Encoder


bodyLengthChecker

bodyLengthChecker: BodyLengthCalculator

Internal

A function that can calculate the length of a request body.

Inherited from

ClientDefaults.bodyLengthChecker


~~credentialDefaultProvider~~

credentialDefaultProvider: (input) => AwsCredentialIdentityProvider

Internal

Default credentials provider; Not available in browser runtime.

Parameters

input

any

Returns

AwsCredentialIdentityProvider

Deprecated

Inherited from

GenAiEvaluationToolkitClientResolvedConfigType.credentialDefaultProvider


defaultSigningName

defaultSigningName: string

Inherited from

GenAiEvaluationToolkitClientResolvedConfigType.defaultSigningName


defaultsMode

defaultsMode: DefaultsMode | Provider\<DefaultsMode>

The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.

Inherited from

GenAiEvaluationToolkitClientConfig.defaultsMode


defaultUserAgentProvider

defaultUserAgentProvider: Provider\<UserAgent>

Internal

The provider populating default tracking information to be sent with user-agent, x-amz-user-agent header

Inherited from

ClientDefaults.defaultUserAgentProvider


disableHostPrefix

disableHostPrefix: boolean

Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.

Inherited from

ClientDefaults.disableHostPrefix


extensions

extensions: RuntimeExtension[]

Optional extensions

Inherited from

ClientDefaults.extensions


httpAuthSchemeProvider

readonly httpAuthSchemeProvider: GenAiEvaluationToolkitHttpAuthSchemeProvider

Internal

Configuration of an HttpAuthSchemeProvider for a client which resolves which HttpAuthScheme to use.

Inherited from

GenAiEvaluationToolkitClientResolvedConfigType.httpAuthSchemeProvider


httpAuthSchemes

readonly httpAuthSchemes: HttpAuthScheme[]

Internal

Configuration of HttpAuthSchemes for a client which provides default identity providers and signers per auth scheme.

Inherited from

GenAiEvaluationToolkitClientResolvedConfigType.httpAuthSchemes


logger

logger: Logger

Optional logger for logging debug/info/warn/error.

Inherited from

ClientDefaults.logger


maxAttempts

maxAttempts: Provider\<number> | number & Provider\<number>

Value for how many times a request will be made at most in case of retry.

Inherited from

GenAiEvaluationToolkitClientResolvedConfigType.maxAttempts


profile

profile: string

Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.

When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.

For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.

Inherited from

ClientDefaults.profile


region

region: string | Provider\<string> & Provider\<string> & string | Provider\<string> & Provider\<string | undefined>

The AWS region to which this client will send requests

Inherited from

GenAiEvaluationToolkitClientResolvedConfigType.region


requestHandler

requestHandler: RequestHandler\<any, any, HttpHandlerOptions> & HttpHandlerUserInput & RequestHandler\<any, any, {}>

The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.

Inherited from

GenAiEvaluationToolkitClientResolvedConfigType.requestHandler


retryMode

retryMode: string | Provider\<string>

Specifies which retry algorithm to use.

See

https://docs.aws.amazon.com/AWSJavaScriptSDK/v3/latest/Package/-smithy-util-retry/Enum/RETRY_MODES/

Inherited from

GenAiEvaluationToolkitClientConfig.retryMode


runtime

runtime: string

Internal

The runtime environment.

Inherited from

ClientDefaults.runtime


serviceId

serviceId: string

Internal

Unique service identifier.

Inherited from

ClientDefaults.serviceId


sha256

sha256: ChecksumConstructor | HashConstructor

Internal

A constructor for a class implementing the @smithy/types#ChecksumConstructor interface that computes the SHA-256 HMAC or checksum of a string or binary buffer.

Inherited from

GenAiEvaluationToolkitClientConfig.sha256


streamCollector

streamCollector: StreamCollector

Internal

A function that converts a stream into an array of bytes.

Inherited from

ClientDefaults.streamCollector


urlParser

urlParser: UrlParser

Internal

The function that will be used to convert strings into HTTP endpoints.

Inherited from

ClientDefaults.urlParser


useDualstackEndpoint

useDualstackEndpoint: boolean | Provider\<boolean> & Provider\<boolean> & (boolean | Provider\<boolean | undefined> | undefined)

Enables IPv6/IPv4 dualstack endpoint.

Inherited from

GenAiEvaluationToolkitClientResolvedConfigType.useDualstackEndpoint


useFipsEndpoint

useFipsEndpoint: boolean | Provider\<boolean> & Provider\<boolean> & (boolean | Provider\<boolean | undefined> | undefined)

Enables FIPS compatible endpoints.

Inherited from

GenAiEvaluationToolkitClientResolvedConfigType.useFipsEndpoint


utf8Decoder

utf8Decoder: Decoder

Internal

The function that will be used to convert a UTF8-encoded string to a byte array.

Inherited from

ClientDefaults.utf8Decoder


utf8Encoder

utf8Encoder: Encoder

Internal

The function that will be used to convert binary data to a UTF-8 encoded string.

Inherited from

ClientDefaults.utf8Encoder