Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

community[patch]: support AWS_... env vars #6866

Merged
merged 6 commits into from
Sep 25, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 13 additions & 7 deletions libs/langchain-community/src/chat_models/bedrock/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -21,9 +21,9 @@ export interface BedrockChatFields
*
* ```bash
* npm install @langchain/openai
* export BEDROCK_AWS_REGION="your-aws-region"
* export BEDROCK_AWS_SECRET_ACCESS_KEY="your-aws-secret-access-key"
* export BEDROCK_AWS_ACCESS_KEY_ID="your-aws-access-key-id"
* export AWS_REGION="your-aws-region"
* export AWS_SECRET_ACCESS_KEY="your-aws-secret-access-key"
* export AWS_ACCESS_KEY_ID="your-aws-access-key-id"
* ```
*
* ## [Constructor args](/classes/langchain_community_chat_models_bedrock.BedrockChat.html#constructor)
Expand Down Expand Up @@ -60,15 +60,21 @@ export interface BedrockChatFields
* const llm = new BedrockChat({
* region: process.env.BEDROCK_AWS_REGION,
* maxRetries: 0,
* credentials: {
* secretAccessKey: process.env.BEDROCK_AWS_SECRET_ACCESS_KEY!,
* accessKeyId: process.env.BEDROCK_AWS_ACCESS_KEY_ID!,
* },
* model: "anthropic.claude-3-5-sonnet-20240620-v1:0",
* temperature: 0,
* maxTokens: undefined,
* // other params...
* });
*
* // You can also pass credentials in explicitly:
* const llmWithCredentials = new BedrockChat({
* region: process.env.BEDROCK_AWS_REGION,
* model: "anthropic.claude-3-5-sonnet-20240620-v1:0",
* credentials: {
* secretAccessKey: process.env.BEDROCK_AWS_SECRET_ACCESS_KEY!,
* accessKeyId: process.env.BEDROCK_AWS_ACCESS_KEY_ID!,
* },
* });
* ```
* </details>
*
Expand Down
65 changes: 47 additions & 18 deletions libs/langchain-community/src/chat_models/bedrock/web.ts
Original file line number Diff line number Diff line change
Expand Up @@ -183,9 +183,9 @@ export interface BedrockChatFields
*
* ```bash
* npm install @langchain/openai
* export BEDROCK_AWS_REGION="your-aws-region"
* export BEDROCK_AWS_SECRET_ACCESS_KEY="your-aws-secret-access-key"
* export BEDROCK_AWS_ACCESS_KEY_ID="your-aws-access-key-id"
* export AWS_REGION="your-aws-region"
* export AWS_SECRET_ACCESS_KEY="your-aws-secret-access-key"
* export AWS_ACCESS_KEY_ID="your-aws-access-key-id"
* ```
*
* ## [Constructor args](/classes/langchain_community_chat_models_bedrock.BedrockChat.html#constructor)
Expand Down Expand Up @@ -217,20 +217,26 @@ export interface BedrockChatFields
* <summary><strong>Instantiate</strong></summary>
*
* ```typescript
* import { BedrockChat } from '@langchain/community/chat_models/bedrock';
* import { BedrockChat } from '@langchain/community/chat_models/bedrock/web';
*
* const llm = new BedrockChat({
* region: process.env.BEDROCK_AWS_REGION,
* region: process.env.AWS_REGION,
* maxRetries: 0,
* credentials: {
* secretAccessKey: process.env.BEDROCK_AWS_SECRET_ACCESS_KEY!,
* accessKeyId: process.env.BEDROCK_AWS_ACCESS_KEY_ID!,
* },
* model: "anthropic.claude-3-5-sonnet-20240620-v1:0",
* temperature: 0,
* maxTokens: undefined,
* // other params...
* });
*
* // You can also pass credentials in explicitly:
* const llmWithCredentials = new BedrockChat({
* region: process.env.BEDROCK_AWS_REGION,
* model: "anthropic.claude-3-5-sonnet-20240620-v1:0",
* credentials: {
* secretAccessKey: process.env.BEDROCK_AWS_SECRET_ACCESS_KEY!,
* accessKeyId: process.env.BEDROCK_AWS_ACCESS_KEY_ID!,
* },
* });
* ```
* </details>
*
Expand Down Expand Up @@ -542,8 +548,12 @@ export class BedrockChat

get lc_secrets(): { [key: string]: string } | undefined {
return {
"credentials.accessKeyId": "BEDROCK_AWS_ACCESS_KEY_ID",
"credentials.secretAccessKey": "BEDROCK_AWS_SECRET_ACCESS_KEY",
"credentials.accessKeyId": "AWS_ACCESS_KEY_ID",
"credentials.secretAccessKey": "AWS_SECRET_ACCESS_KEY",
"credentials.sessionToken": "AWS_SECRET_ACCESS_KEY",
awsAccessKeyId: "AWS_ACCESS_KEY_ID",
awsSecretAccessKey: "AWS_SECRET_ACCESS_KEY",
awsSessionToken: "AWS_SESSION_TOKEN",
};
}

Expand All @@ -566,7 +576,32 @@ export class BedrockChat
}

constructor(fields?: BedrockChatFields) {
super(fields ?? {});
const awsAccessKeyId =
fields?.awsAccessKeyId ?? getEnvironmentVariable("AWS_ACCESS_KEY_ID");
const awsSecretAccessKey =
fields?.awsSecretAccessKey ??
getEnvironmentVariable("AWS_SECRET_ACCESS_KEY");
const awsSessionToken =
fields?.awsSessionToken ?? getEnvironmentVariable("AWS_SESSION_TOKEN");

let credentials = fields?.credentials;
if (credentials === undefined) {
if (awsAccessKeyId === undefined || awsSecretAccessKey === undefined) {
throw new Error(
"Please set your AWS credentials in the 'credentials' field or set env vars AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY, and optionally AWS_SESSION_TOKEN."
);
}
credentials = {
accessKeyId: awsAccessKeyId,
secretAccessKey: awsSecretAccessKey,
sessionToken: awsSessionToken,
};
}

// eslint-disable-next-line no-param-reassign
fields = { ...fields, awsAccessKeyId, awsSecretAccessKey, awsSessionToken };

super(fields);

this.model = fields?.model ?? this.model;
this.modelProvider = getModelProvider(this.model);
Expand All @@ -585,12 +620,6 @@ export class BedrockChat
}
this.region = region;

const credentials = fields?.credentials;
if (!credentials) {
throw new Error(
"Please set the AWS credentials in the 'credentials' field."
);
}
this.credentials = credentials;

this.temperature = fields?.temperature ?? this.temperature;
Expand Down
31 changes: 31 additions & 0 deletions libs/langchain-community/src/chat_models/tests/chatbedrock.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -26,3 +26,34 @@ test("Test Bedrock identifying params", async () => {
model,
});
});

test("Test Bedrock serialization", async () => {
delete process.env.AWS_ACCESS_KEY_ID;
delete process.env.AWS_SECRET_ACCESS_KEY;
const bedrock = new BedrockChat({
region: "us-west-2",
model: "anthropic.claude-3-sonnet-20240229-v1:0",
credentials: {
accessKeyId: "unused",
secretAccessKey: "unused",
sessionToken: "unused",
},
});

expect(JSON.stringify(bedrock)).toEqual(
`{"lc":1,"type":"constructor","id":["langchain","chat_models","bedrock","BedrockChat"],"kwargs":{"region_name":"us-west-2","model_id":"anthropic.claude-3-sonnet-20240229-v1:0","credentials":{"accessKeyId":{"lc":1,"type":"secret","id":["AWS_ACCESS_KEY_ID"]},"secretAccessKey":{"lc":1,"type":"secret","id":["AWS_SECRET_ACCESS_KEY"]},"sessionToken":{"lc":1,"type":"secret","id":["AWS_SECRET_ACCESS_KEY"]}}}}`
);
});

test("Test Bedrock serialization from environment variables", async () => {
process.env.AWS_ACCESS_KEY_ID = "foo";
process.env.AWS_SECRET_ACCESS_KEY = "bar";
const bedrock = new BedrockChat({
region: "us-west-2",
model: "anthropic.claude-3-sonnet-20240229-v1:0",
});

expect(JSON.stringify(bedrock)).toEqual(
`{"lc":1,"type":"constructor","id":["langchain","chat_models","bedrock","BedrockChat"],"kwargs":{"region_name":"us-west-2","model_id":"anthropic.claude-3-sonnet-20240229-v1:0","aws_access_key_id":{"lc":1,"type":"secret","id":["AWS_ACCESS_KEY_ID"]},"aws_secret_access_key":{"lc":1,"type":"secret","id":["AWS_SECRET_ACCESS_KEY"]},"credentials":{"accessKeyId":{"lc":1,"type":"secret","id":["AWS_ACCESS_KEY_ID"]},"secretAccessKey":{"lc":1,"type":"secret","id":["AWS_SECRET_ACCESS_KEY"]}}}}`
);
});
6 changes: 6 additions & 0 deletions libs/langchain-community/src/utils/bedrock/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,12 @@ export interface BaseBedrockInput {
tagSuffix: string;
streamProcessingMode: "SYNCHRONOUS" | "ASYNCHRONOUS";
};

awsAccessKeyId?: string;

awsSecretAccessKey?: string;

awsSessionToken?: string;
}

type Dict = { [key: string]: unknown };
Expand Down
Loading