Class ChatModelUnitTests<CallOptions, OutputMessageType, ConstructorArgs>`Abstract`

Type Parameters

CallOptions extends BaseChatModelCallOptions = BaseChatModelCallOptions
OutputMessageType extends BaseMessageChunk = BaseMessageChunk
ConstructorArgs extends RecordStringAny = RecordStringAny

Hierarchy

BaseChatModelsTests<CallOptions, OutputMessageType, ConstructorArgs>
- ChatModelUnitTests

Index

Constructors

Properties

Cls chatModelHasStructuredOutput chatModelHasToolCalling constructorArgs

Accessors

multipleApiKeysRequiredMessage

Methods

expectedLsParams runTests skipTestMessage testChatModelInit testChatModelInitApiKey testChatModelInitStreaming testChatModelWithBindTools testChatModelWithStructuredOutput testStandardParams

Constructors

constructor

new ChatModelUnitTests<CallOptions, OutputMessageType, ConstructorArgs>(fields): ChatModelUnitTests<CallOptions, OutputMessageType, ConstructorArgs>
Type Parameters
- CallOptions extends BaseChatModelCallOptions = BaseChatModelCallOptions
- OutputMessageType extends BaseMessageChunk = BaseMessageChunk
- ConstructorArgs extends RecordStringAny = RecordStringAny
Parameters
- fields: BaseChatModelsTestsFields<CallOptions, OutputMessageType, ConstructorArgs>
Returns ChatModelUnitTests<CallOptions, OutputMessageType, ConstructorArgs>
Overrides BaseChatModelsTests<CallOptions, OutputMessageType, ConstructorArgs>.constructor
- Defined in unit_tests/chat_models.ts:39

Properties

Cls

Cls: BaseChatModelConstructor<CallOptions, OutputMessageType, ConstructorArgs>

chatModelHasStructuredOutput

chatModelHasStructuredOutput: boolean

chatModelHasToolCalling

chatModelHasToolCalling: boolean

constructorArgs

constructorArgs: ConstructorArgs

Accessors

multipleApiKeysRequiredMessage

get multipleApiKeysRequiredMessage(): string
Returns string
Inherited from BaseChatModelsTests.multipleApiKeysRequiredMessage
- Defined in base.ts:65

Methods

expectedLsParams

expectedLsParams(): Partial<LangSmithParams>
Override this method if the chat model being tested does not support all expected LangSmith parameters.

Returns Partial<LangSmithParams>
The LangSmith parameters expected by the chat model.
- Defined in unit_tests/chat_models.ts:67

runTests

runTests(): boolean
Run all unit tests for the chat model. Each test is wrapped in a try/catch block to prevent the entire test suite from failing. If a test fails, the error is logged to the console, and the test suite continues.

Returns boolean
- Defined in unit_tests/chat_models.ts:128

skipTestMessage

skipTestMessage(testName, chatClassName, extra?): void
Log a warning message when skipping a test.
Parameters
- testName: string
- chatClassName: string
- Optionalextra: string
Returns void
Inherited from BaseChatModelsTests.skipTestMessage
- Defined in base.ts:72

testChatModelInit

testChatModelInit(): void
Returns void
- Defined in unit_tests/chat_models.ts:78

testChatModelInitApiKey

testChatModelInitApiKey(): void
Returns void
- Defined in unit_tests/chat_models.ts:83

testChatModelInitStreaming

testChatModelInitStreaming(): void
Returns void
- Defined in unit_tests/chat_models.ts:89

testChatModelWithBindTools

testChatModelWithBindTools(): void
Returns void
- Defined in unit_tests/chat_models.ts:95

testChatModelWithStructuredOutput

testChatModelWithStructuredOutput(): void
Returns void
- Defined in unit_tests/chat_models.ts:103

testStandardParams

testStandardParams(): void
Returns void
- Defined in unit_tests/chat_models.ts:111