langchain_community.utilities.requests.JsonRequestsWrapper

class langchain_community.utilities.requests.JsonRequestsWrapper[source]

Bases: GenericRequestsWrapper

Lightweight wrapper around requests library, with async support.

The main purpose of this wrapper is to always return a json output.

Create a new model by parsing and validating input data from keyword arguments.

Raises ValidationError if the input data cannot be parsed to form a valid model.

param aiosession: Optional[ClientSession] = None
param auth: Optional[Any] = None
param headers: Optional[Dict[str, str]] = None
param response_content_type: Literal['text', 'json'] = 'json'
async adelete(url: str, **kwargs: Any) → Union[str, Dict[str, Any]]

DELETE the URL and return the text asynchronously.

Parameters

  • url (str) –

  • kwargs (Any) –

Return type

Union[str, Dict[str, Any]]

async aget(url: str, **kwargs: Any) → Union[str, Dict[str, Any]]

GET the URL and return the text asynchronously.

Parameters

  • url (str) –

  • kwargs (Any) –

Return type

Union[str, Dict[str, Any]]

async apatch(url: str, data: Dict[str, Any], **kwargs: Any) → Union[str, Dict[str, Any]]

PATCH the URL and return the text asynchronously.

Parameters

  • url (str) –

  • data (Dict[str, Any]) –

  • kwargs (Any) –

Return type

Union[str, Dict[str, Any]]

async apost(url: str, data: Dict[str, Any], **kwargs: Any) → Union[str, Dict[str, Any]]

POST to the URL and return the text asynchronously.

Parameters

  • url (str) –

  • data (Dict[str, Any]) –

  • kwargs (Any) –

Return type

Union[str, Dict[str, Any]]

async aput(url: str, data: Dict[str, Any], **kwargs: Any) → Union[str, Dict[str, Any]]

PUT the URL and return the text asynchronously.

Parameters

  • url (str) –

  • data (Dict[str, Any]) –

  • kwargs (Any) –

Return type

Union[str, Dict[str, Any]]

classmethod construct(_fields_set: Optional[SetStr] = None, **values: Any) → Model

Creates a new model setting __dict__ and __fields_set__ from trusted or pre-validated data. Default values are respected, but no other validation is performed. Behaves as if Config.extra = ‘allow’ was set since it adds all passed values

Parameters

  • _fields_set (Optional[SetStr]) –

  • values (Any) –

Return type

Model

copy(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, update: Optional[DictStrAny] = None, deep: bool = False) → Model

Duplicate a model, optionally choose which fields to include, exclude and change.

Parameters

  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to include in new model

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) – fields to exclude from new model, as with values this takes precedence over include

  • update (Optional[DictStrAny]) – values to change/add in the new model. Note: the data is not validated before creating the new model: you should trust this data

  • deep (bool) – set to True to make a deep copy of the model

  • self (Model) –

Returns

new model instance

Return type

Model

delete(url: str, **kwargs: Any) → Union[str, Dict[str, Any]]

DELETE the URL and return the text.

Parameters

  • url (str) –

  • kwargs (Any) –

Return type

Union[str, Dict[str, Any]]

dict(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False) → DictStrAny

Generate a dictionary representation of the model, optionally specifying which fields to include or exclude.

Parameters

  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • by_alias (bool) –

  • skip_defaults (Optional[bool]) –

  • exclude_unset (bool) –

  • exclude_defaults (bool) –

  • exclude_none (bool) –

Return type

DictStrAny

classmethod from_orm(obj: Any) → Model
Parameters

obj (Any) –

Return type

Model

get(url: str, **kwargs: Any) → Union[str, Dict[str, Any]]

GET the URL and return the text.

Parameters

  • url (str) –

  • kwargs (Any) –

Return type

Union[str, Dict[str, Any]]

json(*, include: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, exclude: Optional[Union[AbstractSetIntStr, MappingIntStrAny]] = None, by_alias: bool = False, skip_defaults: Optional[bool] = None, exclude_unset: bool = False, exclude_defaults: bool = False, exclude_none: bool = False, encoder: Optional[Callable[[Any], Any]] = None, models_as_dict: bool = True, **dumps_kwargs: Any) → unicode

Generate a JSON representation of the model, include and exclude arguments as per dict().

encoder is an optional function to supply as default to json.dumps(), other arguments as per json.dumps().

Parameters

  • include (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • exclude (Optional[Union[AbstractSetIntStr, MappingIntStrAny]]) –

  • by_alias (bool) –

  • skip_defaults (Optional[bool]) –

  • exclude_unset (bool) –

  • exclude_defaults (bool) –

  • exclude_none (bool) –

  • encoder (Optional[Callable[[Any], Any]]) –

  • models_as_dict (bool) –

  • dumps_kwargs (Any) –

Return type

unicode

classmethod parse_file(path: Union[str, Path], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model
Parameters

  • path (Union[str, Path]) –

  • content_type (unicode) –

  • encoding (unicode) –

  • proto (Protocol) –

  • allow_pickle (bool) –

Return type

Model

classmethod parse_obj(obj: Any) → Model
Parameters

obj (Any) –

Return type

Model

classmethod parse_raw(b: Union[str, bytes], *, content_type: unicode = None, encoding: unicode = 'utf8', proto: Protocol = None, allow_pickle: bool = False) → Model
Parameters

  • b (Union[str, bytes]) –

  • content_type (unicode) –

  • encoding (unicode) –

  • proto (Protocol) –

  • allow_pickle (bool) –

Return type

Model

patch(url: str, data: Dict[str, Any], **kwargs: Any) → Union[str, Dict[str, Any]]

PATCH the URL and return the text.

Parameters

  • url (str) –

  • data (Dict[str, Any]) –

  • kwargs (Any) –

Return type

Union[str, Dict[str, Any]]

post(url: str, data: Dict[str, Any], **kwargs: Any) → Union[str, Dict[str, Any]]

POST to the URL and return the text.

Parameters

  • url (str) –

  • data (Dict[str, Any]) –

  • kwargs (Any) –

Return type

Union[str, Dict[str, Any]]

put(url: str, data: Dict[str, Any], **kwargs: Any) → Union[str, Dict[str, Any]]

PUT the URL and return the text.

Parameters

  • url (str) –

  • data (Dict[str, Any]) –

  • kwargs (Any) –

Return type

Union[str, Dict[str, Any]]

classmethod schema(by_alias: bool = True, ref_template: unicode = '#/definitions/{model}') → DictStrAny
Parameters

  • by_alias (bool) –

  • ref_template (unicode) –

Return type

DictStrAny

classmethod schema_json(*, by_alias: bool = True, ref_template: unicode = '#/definitions/{model}', **dumps_kwargs: Any) → unicode
Parameters

  • by_alias (bool) –

  • ref_template (unicode) –

  • dumps_kwargs (Any) –

Return type

unicode

classmethod update_forward_refs(**localns: Any) → None

Try to update ForwardRefs on fields based on this Model, globalns and localns.

Parameters

localns (Any) –

Return type

None

classmethod validate(value: Any) → Model
Parameters

value (Any) –

Return type

Model

property requests: Requests