> ## Documentation Index
> Fetch the complete documentation index at: https://langchain.idochub.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Prediction Guard

This page covers how to use the Prediction Guard ecosystem within LangChain.
It is broken into two parts: installation and setup, and then references to specific Prediction Guard wrappers.

This integration is maintained in the [langchain-predictionguard](https://github.com/predictionguard/langchain-predictionguard)
package.

## Installation and Setup

* Install the PredictionGuard LangChain partner package:

<CodeGroup>
  ```bash pip theme={null}
  pip install langchain-predictionguard
  ```

  ```bash uv theme={null}
  uv add langchain-predictionguard
  ```
</CodeGroup>

* Get a Prediction Guard API key (as described [here](https://docs.predictionguard.com/)) and set it as an environment variable (`PREDICTIONGUARD_API_KEY`)

## Prediction Guard LangChain Integrations

| API            | Description             | Endpoint Docs                                                                           | Import                                                            | Example Usage                                                                              |
| -------------- | ----------------------- | --------------------------------------------------------------------------------------- | ----------------------------------------------------------------- | ------------------------------------------------------------------------------------------ |
| Chat           | Build Chat Bots         | [Chat](https://docs.predictionguard.com/api-reference/api-reference/chat-completions)   | `from langchain_predictionguard import ChatPredictionGuard`       | [ChatPredictionGuard.ipynb](/oss/python/integrations/chat/predictionguard)                 |
| Completions    | Generate Text           | [Completions](https://docs.predictionguard.com/api-reference/api-reference/completions) | `from langchain_predictionguard import PredictionGuard`           | [PredictionGuard.ipynb](/oss/python/integrations/llms/predictionguard)                     |
| Text Embedding | Embed String to Vectors | [Embeddings](https://docs.predictionguard.com/api-reference/api-reference/embeddings)   | `from langchain_predictionguard import PredictionGuardEmbeddings` | [PredictionGuardEmbeddings.ipynb](/oss/python/integrations/text_embedding/predictionguard) |

## Getting Started

## Chat Models

### Prediction Guard Chat

See a [usage example](/oss/python/integrations/chat/predictionguard)

```python theme={null}
from langchain_predictionguard import ChatPredictionGuard
```

#### Usage

```python theme={null}
# If predictionguard_api_key is not passed, default behavior is to use the `PREDICTIONGUARD_API_KEY` environment variable.
chat = ChatPredictionGuard(model="Hermes-3-Llama-3.1-8B")

chat.invoke("Tell me a joke")
```

## Embedding Models

### Prediction Guard Embeddings

See a [usage example](/oss/python/integrations/text_embedding/predictionguard)

```python theme={null}
from langchain_predictionguard import PredictionGuardEmbeddings
```

#### Usage

```python theme={null}
# If predictionguard_api_key is not passed, default behavior is to use the `PREDICTIONGUARD_API_KEY` environment variable.
embeddings = PredictionGuardEmbeddings(model="bridgetower-large-itm-mlm-itc")

text = "This is an embedding example."
output = embeddings.embed_query(text)
```

## LLMs

### Prediction Guard LLM

See a [usage example](/oss/python/integrations/llms/predictionguard)

```python theme={null}
from langchain_predictionguard import PredictionGuard
```

#### Usage

```python theme={null}
# If predictionguard_api_key is not passed, default behavior is to use the `PREDICTIONGUARD_API_KEY` environment variable.
llm = PredictionGuard(model="Hermes-2-Pro-Llama-3-8B")

llm.invoke("Tell me a joke about bears")
```