> ## Documentation Index
> Fetch the complete documentation index at: https://docs.coreweave.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Instructor
> Weave の Instructor インテグレーションを使用して LLM からの構造化データ抽出をトレースし、Pydantic の検証と再試行ロジックを取得します。
[Instructor](https://python.useinstructor.com/) は、LLM から JSON などの構造化データを取得するための軽量ライブラリです。このガイドでは、Weave で Instructor の Call をトレースする方法を説明します。これにより、構造化抽出のデバッグ、Pydantic の検証の取得、再試行ロジックの確認が行えます。
トレース
言語モデルアプリケーションのトレースは、開発時にも本番環境でも、一か所に集約して保存することが重要です。トレースはデバッグに役立つだけでなく、アプリケーションの改善に活用できるデータセットにもなります。
Weave は [Instructor](https://python.useinstructor.com/) のトレースを自動的に取得します。トラッキングを開始するには、`weave.init(project_name="[YOUR-WANDB-PROJECT-NAME]")` を呼び出してから、通常どおりライブラリを使用してください。
```python lines theme={"system"}
import instructor
import weave
from pydantic import BaseModel
from openai import OpenAI
# 目的の出力構造を定義します
class UserInfo(BaseModel):
user_name: str
age: int
# Weave を初期化します
weave.init(project_name="instructor-test")
# OpenAI クライアントにパッチを適用します
client = instructor.from_openai(OpenAI())
# 自然言語のテキストから構造化データを抽出します
user_info = client.chat.completions.create(
model="gpt-3.5-turbo",
response_model=UserInfo,
messages=[{"role": "user", "content": "John Doe is 30 years old."}],
)
```
| 
|
| - |
| Weave は、Instructor を使用して行われたすべての LLM Call をトラッキングしてログします。トレースは Weave の Web インターフェースで確認できます。 |
独自の Op をトラッキングする
関数を `@weave.op` でラップすると、入力、出力、アプリのロジックの取得が始まり、アプリ内のデータの流れをデバッグできるようになります。Op は深くネストでき、トラッキングしたい関数のツリーを構築できます。さらに、実験を進めながらコードのバージョン管理も自動的に行われ、Git にまだコミットしていないその場限りの変更内容も取得されます。
[`@weave.op`](/ja/products/wandb/weave/guides/tracking/ops) でデコレートした関数を作成します。
次の例では、`extract_person` 関数が `@weave.op` でラップされたメトリクス関数です。これにより、OpenAI のチャット補完 Call などの中間ステップを確認できます。
```python lines theme={"system"}
import instructor
import weave
from openai import OpenAI
from pydantic import BaseModel
# 目的の出力構造を定義します
class Person(BaseModel):
person_name: str
age: int
# Weave を初期化します
weave.init(project_name="instructor-test")
# OpenAI クライアントにパッチを適用します
lm_client = instructor.from_openai(OpenAI())
# 自然言語から構造化データを抽出します
@weave.op()
def extract_person(text: str) -> Person:
return lm_client.chat.completions.create(
model="gpt-3.5-turbo",
messages=[
{"role": "user", "content": text},
],
response_model=Person,
)
person = extract_person("My name is John and I am 20 years old")
```
| 
|
| - |
| `extract_person` 関数を `@weave.op` でデコレートすると、関数の入力と出力に加え、関数内で実行されるすべての LM Call がトレースされます。さらに Weave は、Instructor が生成した構造化オブジェクトを自動的にトラッキングし、バージョン管理します。 |
`Model` を作成して実験を効率化する
構成要素が多いと、実験の整理は難しくなります。[`Model`](/ja/products/wandb/weave/guides/core-types/models) クラスを使用すると、システムプロンプトや使用しているモデルなど、アプリの実験に関する詳細を取得して整理できます。これにより、アプリのさまざまな反復処理を整理して比較しやすくなります。
[`Model`](/ja/products/wandb/weave/guides/core-types/models) は、コードのバージョン管理や入力と出力の取得に加えて、アプリケーションの動作を制御する構造化されたパラメーターも取得します。そのため、どのパラメーターが最も効果的だったかを検索できます。また、Weave モデルは [`serve`](#serve-a-weave-model) や [`Evaluation`](/ja/products/wandb/weave/guides/core-types/evaluations) と組み合わせて使用することもできます。
次の例では、`PersonExtractor` を使って実験できます。これらのいずれかを変更するたびに、`PersonExtractor` の新しい*バージョン*が作成されます。
```python lines theme={"system"}
import asyncio
from typing import List, Iterable
import instructor
import weave
from openai import AsyncOpenAI
from pydantic import BaseModel
# 目的の出力構造を定義する
class Person(BaseModel):
person_name: str
age: int
# Weave を初期化する
weave.init(project_name="instructor-test")
# OpenAI クライアントにパッチを適用する
lm_client = instructor.from_openai(AsyncOpenAI())
class PersonExtractor(weave.Model):
openai_model: str
max_retries: int
@weave.op()
async def predict(self, text: str) -> List[Person]:
model = await lm_client.chat.completions.create(
model=self.openai_model,
response_model=Iterable[Person],
max_retries=self.max_retries,
stream=True,
messages=[
{
"role": "system",
"content": "You are a perfect entity extraction system",
},
{
"role": "user",
"content": f"Extract `{text}`",
},
],
)
return [m async for m in model]
model = PersonExtractor(openai_model="gpt-4", max_retries=2)
asyncio.run(model.predict("John is 30 years old"))
```
| 
|
| - |
| [`Model`](/ja/products/wandb/weave/guides/core-types/models) を使用した Call のトレースとバージョン管理 |
Weave モデルをサービングする
`weave.Model` を保存したら、FastAPI エンドポイントとしてサービングし、ノートブックの外部からテストしたり、他のアプリケーションと統合したりできます。`weave.Model` オブジェクトの Weave リファレンスがあれば、FastAPI サーバーを起動してモデルを [`serve`](/ja/products/wandb/weave/guides/tools/serve) できます。
| [
](https://forge.coreweave.com/wandb/geekyrakshit/instructor-test/weave/objects/PersonExtractor/versions/xXpMsJvaiTOjKafz1TnHC8wMgH5ZAAwYOaBMvHuLArI) |
| - |
| 任意の `weave.Model` の Weave リファレンスは、そのモデルのページに移動し、UI からコピーして取得できます。 |
モデルをサービングするには、ターミナルで次のコマンドを実行します。
```bash theme={"system"}
weave serve weave://your_entity/project-name/YourModel:[HASH]
```