pydanticModel.model_dump_json() to use serializer mode #928

97k · 2024-08-16T15:23:44Z

97k
Aug 16, 2024

I just realised even if we use Field(exclude=True), it doesn't get excluded from the json dump until we specify the mode.

For example

from pydantic import BaseModel, Field

class Model(BaseModel):
    name: str
    allowed_names: str = Field(default=['name1', 'name2'], exclude=True)

print('Model dump - Usual')
pp.pprint(Model.model_json_schema())

print("Model dump serializer mode")
pp.pprint(Model.model_json_schema(mode="serialization"))

The output of this code is

I don't want whatever I mark it as exclude to be send it to LLM.
Is it possible to do so?
@jxnl / Team

jxnl · 2024-08-16T16:21:01Z

jxnl
Aug 16, 2024
Maintainer

In a flight right now but search json skip in our docs on python.useinstructor.com

1 reply

97k Aug 16, 2024
Author

Thanks for this
https://python.useinstructor.com/concepts/fields/?h=skip#omitting-fields-from-schema-sent-to-the-language-model

Btw, A thought, we can also use basemodelclass.model_dump_json(mode='serialization') in instructor's generate_response.py 🤔
as if someone explicitly mentioned, exclude = True, then we should not send it to LLM?

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

pydanticModel.model_dump_json() to use serializer mode #928

Uh oh!

{{title}}

Uh oh!

Replies: 1 comment 1 reply

Uh oh!

{{title}}

Uh oh!

Uh oh!

{{title}}

Uh oh!

Select a reply

Uh oh!

Uh oh!

pydanticModel.model_dump_json() to use serializer mode #928

Uh oh!

97k Aug 16, 2024

Replies: 1 comment · 1 reply

Uh oh!

jxnl Aug 16, 2024 Maintainer

Uh oh!

97k Aug 16, 2024 Author

97k
Aug 16, 2024

Replies: 1 comment 1 reply

jxnl
Aug 16, 2024
Maintainer

97k Aug 16, 2024
Author