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

Anthropic README updates #17684

Merged
merged 5 commits into from
Feb 23, 2024
Merged
Changes from 2 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
65 changes: 65 additions & 0 deletions libs/partners/anthropic/README.md
Original file line number Diff line number Diff line change
@@ -1 +1,66 @@
# langchain-anthropic

This package contains the LangChain integration for Anthropic's generative models.

## Installation

`pip install -U langchain-anthropic`

## Chat Models

| API Model Name | Model Family |
| ------------------ | -------------- |
| claude-instant-1.2 | Claude Instant |
| claude-2.1 | Claude |
| claude-2.0 | Claude |

To use, you should have an Anthropic API key configured. Initialize the model as:

```
from langchain_anthropic import ChatAnthropicMessages
from langchain.schema import AIMessage, HumanMessage
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

from langchain_core.messages import ...

model = ChatAnthropicMessages(model="claude-2.1", temperature=0, max_tokens=1024)
```

# Define the input message

`input_message = HumanMessage(content="What is the capital of France?")`

# Generate a response using the model

`response = model.invoke(input_message)`
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be a list

response = model.invoke([input_messages])


# Using Messages

You can also use a list of messages to generate a response. This is useful for multi-turn conversations.

```
model = ChatAnthropicMessages(
model="claude-2.1",
temperature=0,
max_tokens=1024
)
```

# Define the input messages

```
messages = [
{"role": "system", "content": "You are a helpful assistant."},
{"role": "user", "content": "What is the capital of France?"},
]

```

### Generate responses using the model

`responses = model.generate(input_messages)`

# Embeddings

Anthropic does not offer its own embedding model. However their documentation offers solutions using Voyage AI.
[Anthropic Embeddings Documentation](https://docs.anthropic.com/claude/docs/embeddings)

## Multimodal inputs

Currently, Anthropic models do not support direct multimodal inputs through this package.
Loading