Skip to content

Commit 3060449

Browse files
committed
Update package name
1 parent 051ff70 commit 3060449

10 files changed

+18
-18
lines changed

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ npm run build
2525
The easiest way to use Guardrails TypeScript is as a drop-in replacement for the OpenAI client:
2626

2727
```typescript
28-
import { GuardrailsOpenAI } from '@guardrails/guardrails-ts';
28+
import { GuardrailsOpenAI } from '@openai/guardrails';
2929

3030
async function main() {
3131
// Use GuardrailsOpenAI instead of OpenAI
@@ -60,7 +60,7 @@ main();
6060

6161
### Agents SDK Integration
6262
```typescript
63-
import { GuardrailAgent } from '@guardrails/guardrails-ts';
63+
import { GuardrailAgent } from '@openai/guardrails';
6464
import { Runner } from '@openai/agents';
6565

6666
// Create agent with guardrails automatically configured
@@ -113,7 +113,7 @@ Datasets must be in JSONL format, with each line containing a JSON object:
113113
### Programmatic Usage
114114

115115
```typescript
116-
import { GuardrailEval } from '@guardrails/guardrails-ts';
116+
import { GuardrailEval } from '@openai/guardrails';
117117

118118
const eval = new GuardrailEval(
119119
'configs/my_guardrails.json',

docs/agents_sdk_integration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ Our Guardrails can easily be integrated with OpenAI's Agents SDK using the **Gua
1919
The easiest way to integrate guardrails is using `GuardrailAgent` as a drop-in replacement:
2020

2121
```typescript
22-
import { GuardrailAgent } from '@guardrails/guardrails-ts';
22+
import { GuardrailAgent } from '@openai/guardrails';
2323
import { Runner } from '@openai/agents';
2424

2525
// Create agent with guardrails automatically configured

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@
2727
## Quickstart
2828

2929
```typescript
30-
import { GuardrailsOpenAI } from '@guardrails/guardrails-ts';
30+
import { GuardrailsOpenAI } from '@openai/guardrails';
3131

3232
async function main() {
3333
const client = await GuardrailsOpenAI.create({

docs/quickstart.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ Get started with Guardrails TypeScript in minutes. Guardrails provides drop-in r
55
## Install
66

77
```bash
8-
npm install @guardrails/guardrails-ts
8+
npm install @openai/guardrails
99
```
1010

1111
## Set API Key
@@ -56,7 +56,7 @@ Replace your OpenAI client with the Guardrails version (`GuardrailsOpenAI`):
5656
We support `chat.completions.create` and `responses.create`.
5757

5858
```typescript
59-
import { GuardrailsOpenAI } from '@guardrails/guardrails-ts';
59+
import { GuardrailsOpenAI } from '@openai/guardrails';
6060

6161
async function main() {
6262
// Use GuardrailsOpenAI instead of OpenAI
@@ -116,7 +116,7 @@ const client = await GuardrailsOpenAI.create(
116116
For OpenAI Agents SDK users, we provide `GuardrailAgent` as a drop-in replacement:
117117

118118
```typescript
119-
import { GuardrailAgent } from '@guardrails/guardrails-ts';
119+
import { GuardrailAgent } from '@openai/guardrails';
120120
import { Runner } from '@openai/agents';
121121

122122
// Create agent with guardrails automatically configured
@@ -137,7 +137,7 @@ const result = await Runner.run(agent, "Hello, can you help me?");
137137
Use the Azure-specific client:
138138

139139
```typescript
140-
import { GuardrailsAzureOpenAI } from '@guardrails/guardrails-ts';
140+
import { GuardrailsAzureOpenAI } from '@openai/guardrails';
141141

142142
const client = await GuardrailsAzureOpenAI.create(
143143
'./guardrails_config.json',
@@ -154,7 +154,7 @@ const client = await GuardrailsAzureOpenAI.create(
154154
Works with any OpenAI-compatible API:
155155

156156
```typescript
157-
import { GuardrailsOpenAI } from '@guardrails/guardrails-ts';
157+
import { GuardrailsOpenAI } from '@openai/guardrails';
158158

159159
// Local Ollama model
160160
const client = await GuardrailsOpenAI.create(

docs/ref/checks/hallucination_detection.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -59,7 +59,7 @@ const config = {
5959
### Use with Guardrails Client
6060

6161
```typescript
62-
import { GuardrailsOpenAI } from '@guardrails/guardrails-ts';
62+
import { GuardrailsOpenAI } from '@openai/guardrails';
6363

6464
const client = await GuardrailsOpenAI.create(config);
6565
const response = await client.responses.create({

docs/ref/exceptions-typescript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Exceptions: TypeScript
22

3-
Exception classes raised by `@guardrails/guardrails-ts`.
3+
Exception classes raised by `@openai/guardrails`.
44

55
```typescript
66
export class GuardrailError extends Error {}

docs/ref/types-typescript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Types: TypeScript
22

3-
Below are the core types used by the `@guardrails/guardrails-ts` library.
3+
Below are the core types used by the `@openai/guardrails` library.
44

55
## GuardrailLLMContext
66

docs/tripwires.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ Tripwires raise exceptions by default:
1515

1616
TypeScript
1717
```typescript
18-
import { GuardrailsOpenAI, GuardrailTripwireTriggered } from '@guardrails/guardrails-ts';
18+
import { GuardrailsOpenAI, GuardrailTripwireTriggered } from '@openai/guardrails';
1919

2020
const client = await GuardrailsOpenAI.create({
2121
version: 1,

package-lock.json

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
{
2-
"name": "@guardrails/guardrails-ts",
2+
"name": "@openai/guardrails",
33
"version": "0.1.0",
44
"description": "OpenAI Guardrails: A TypeScript framework for building safe and reliable AI systems",
55
"main": "dist/index.js",
@@ -23,7 +23,7 @@
2323
"prepublishOnly": "npm run clean && npm run build",
2424
"cli": "node dist/cli.js",
2525
"eval": "node dist/cli.js eval",
26-
"eval:example": "node dist/examples/run-eval.js",
26+
"eval:example": "node dist/examples/run-eval.js"
2727
},
2828
"keywords": [
2929
"guardrails",

0 commit comments

Comments
 (0)