(Community): Adding Structured Support for ChatPerplexity

[keenborder786]

• Description: Adding Structured Support for ChatPerplexity
• Issue: ChatPerplexity does not implement bind_tools for structured output #29357
• This is implemented as per the Perplexity official docs: https://docs.perplexity.ai/guides/structured-outputs

[vercel]

The latest updates on your projects. Learn more about Vercel for Git ↗︎

1 Skipped Deployment

Name	Status	Preview	Comments	Updated (UTC)
langchain	⬜️ Ignored (Inspect)	Visit Preview		Feb 2, 2025 2:49pm

[keenborder786]

@ccurme

[ccurme]

Is a BaseModel instance getting populated under "parsed" in .additional_kwargs?

[keenborder786]

@ccurme please see now. I have double checked now and tested as well with Preplexity Docs.

[keenborder786]

@ccurme looking all good, please review

[keenborder786]

@ccurme

[keenborder786]

@ccurme

[ccurme]

I enabled standard tests for perplexity to pick up tests for structured output. It's currently failing-- we expect to handle TypedDict, Pydantic, and JSON schema.

More importantly, this doesn't appear to work for any input type. Let me know if I'm doing something wrong.

from langchain_community.chat_models import ChatPerplexity
from pydantic import BaseModel, Field

class Joke(BaseModel):
    """Joke to tell user."""

    setup: str = Field(description="question to set up a joke")
    punchline: str = Field(description="answer to resolve the joke")

llm = ChatPerplexity(model="sonar").with_structured_output(Joke)
result = llm.invoke("Tell me a joke about cats.")

BadRequestError: Error code: 400 - {'error': {'message': '["At body -> response_format -> ResponseFormatText -> type: Input should be 'text'", "At body -> response_format -> ResponseFormatJSONSchema -> type: Input should be 'json_schema'", "At body -> response_format -> ResponseFormatJSONSchema -> json_schema: Field required", "At body -> response_format -> ResponseFormatRegex -> type: Input should be 'regex'", "At body -> response_format -> ResponseFormatRegex -> regex: Field required"]', 'type': 'bad_request', 'code': 400}}

[keenborder786]

okay @ccurme

[keenborder786]

@ccurme I have ensured that we are handling TypedDict, Pydantic, and JSON Schema. To clarify, currently, Perplexity only supports JSON Schema for structured output. Additionally, I have accounted for both Pydantic V1 and Pydantic V2 when converting schemas to JSON.