Skip to content

Gen AI Evaluation Toolkit on AWS

v2.0.0

AWS

Copyright © 2026 Amazon Web Services, Inc. and/or its affiliates. All rights reserved. Amazon’s trademarks and trade dress may not be used in connection with any product or service that is not Amazon’s, in any manner that is likely to cause confusion among customers, or in any manner that disparages or discredits Amazon. All other trademarks not owned by Amazon are the property of their respective owners, who may or may not be affiliated with, connected to, or sponsored by Amazon.

Table of contents

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

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

Interface: GenAiEvaluationToolkitClientConfig

The configuration interface of GenAiEvaluationToolkitClient class constructor that set the region, credentials and other options.

Extends

Properties

authSchemePreference?

optional authSchemePreference?: string[] | 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

GenAiEvaluationToolkitClientConfigType.authSchemePreference

base64Decoder?

optional base64Decoder?: Decoder

Internal

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

Inherited from

GenAiEvaluationToolkitClientConfigType.base64Decoder

base64Encoder?

optional base64Encoder?: Encoder

Internal

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

Inherited from

GenAiEvaluationToolkitClientConfigType.base64Encoder

bodyLengthChecker?

optional bodyLengthChecker?: BodyLengthCalculator

Internal

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

Inherited from

GenAiEvaluationToolkitClientConfigType.bodyLengthChecker

~~credentialDefaultProvider?~~

optional credentialDefaultProvider?: (input) => AwsCredentialIdentityProvider

Internal

Default credentials provider; Not available in browser runtime.

Parameters

input

any

Returns

AwsCredentialIdentityProvider

Deprecated

Inherited from

GenAiEvaluationToolkitClientConfigType.credentialDefaultProvider

defaultsMode?

optional 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

GenAiEvaluationToolkitClientConfigType.defaultsMode

defaultUserAgentProvider?

optional defaultUserAgentProvider?: Provider\<UserAgent>

Internal

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

Inherited from

GenAiEvaluationToolkitClientConfigType.defaultUserAgentProvider

disableHostPrefix?

optional disableHostPrefix?: boolean

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

Inherited from

GenAiEvaluationToolkitClientConfigType.disableHostPrefix

endpoint?

optional endpoint?: (string | Endpoint | Provider\<Endpoint> | EndpointV2 | Provider\<EndpointV2>) & (string | Provider\<string> | Endpoint | Provider\<...> | EndpointV2 | Provider\<...>)

The fully qualified endpoint of the webservice. This is only for using a custom endpoint (for example, when using a local version of S3).

Endpoint transformations such as S3 applying a bucket to the hostname are still applicable to this custom endpoint.

Inherited from

GenAiEvaluationToolkitClientConfigType.endpoint

extensions?

optional extensions?: RuntimeExtension[]

Optional extensions

Inherited from

GenAiEvaluationToolkitClientConfigType.extensions

httpAuthSchemeProvider?

optional httpAuthSchemeProvider?: GenAiEvaluationToolkitHttpAuthSchemeProvider

Internal

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

Inherited from

GenAiEvaluationToolkitClientConfigType.httpAuthSchemeProvider

httpAuthSchemes?

optional httpAuthSchemes?: HttpAuthScheme[]

Internal

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

Inherited from

GenAiEvaluationToolkitClientConfigType.httpAuthSchemes

logger?

optional logger?: Logger

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

Inherited from

GenAiEvaluationToolkitClientConfigType.logger

maxAttempts?

optional maxAttempts?: number | Provider\<number>

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

Inherited from

GenAiEvaluationToolkitClientConfigType.maxAttempts

profile?

optional 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

GenAiEvaluationToolkitClientConfigType.profile

region?

optional region?: (string | Provider\<string>) & (string | Provider\<string | undefined>)

The AWS region to which this client will send requests

Inherited from

GenAiEvaluationToolkitClientConfigType.region

requestHandler?

optional requestHandler?: (NodeHttpHandlerOptions | FetchHttpHandlerOptions | Record\<string, unknown> | RequestHandler\<any, any, HttpHandlerOptions>) & HttpHandlerUserInput

Inherited from

GenAiEvaluationToolkitClientConfigType.requestHandler

retryMode?

optional 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

GenAiEvaluationToolkitClientConfigType.retryMode

runtime?

optional runtime?: string

Internal

The runtime environment.

Inherited from

GenAiEvaluationToolkitClientConfigType.runtime

serviceId?

optional serviceId?: string

Internal

Unique service identifier.

Inherited from

GenAiEvaluationToolkitClientConfigType.serviceId

sha256?

optional 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

GenAiEvaluationToolkitClientConfigType.sha256

streamCollector?

optional streamCollector?: StreamCollector

Internal

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

Inherited from

GenAiEvaluationToolkitClientConfigType.streamCollector

urlParser?

optional urlParser?: UrlParser

Internal

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

Inherited from

GenAiEvaluationToolkitClientConfigType.urlParser

useDualstackEndpoint?

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

Enables IPv6/IPv4 dualstack endpoint.

Inherited from

GenAiEvaluationToolkitClientConfigType.useDualstackEndpoint

useFipsEndpoint?

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

Enables FIPS compatible endpoints.

Inherited from

GenAiEvaluationToolkitClientConfigType.useFipsEndpoint

utf8Decoder?

optional utf8Decoder?: Decoder

Internal

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

Inherited from

GenAiEvaluationToolkitClientConfigType.utf8Decoder

utf8Encoder?

optional utf8Encoder?: Encoder

Internal

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

Inherited from

GenAiEvaluationToolkitClientConfigType.utf8Encoder