vectorize_client.models.start_deep_research_request

Vectorize API (Beta)

API for Vectorize services

The version of the OpenAPI document: 0.0.1 Generated by OpenAPI Generator (https://openapi-generator.tech)

Do not edit the class manually.

View Source

 1# coding: utf-8
 2
 3"""
 4    Vectorize API (Beta)
 5
 6    API for Vectorize services
 7
 8    The version of the OpenAPI document: 0.0.1
 9    Generated by OpenAPI Generator (https://openapi-generator.tech)
10
11    Do not edit the class manually.
12"""  # noqa: E501
13
14
15from __future__ import annotations
16import pprint
17import re  # noqa: F401
18import json
19
20from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
21from typing import Any, ClassVar, Dict, List, Optional
22from vectorize_client.models.n8_n_config import N8NConfig
23from typing import Optional, Set
24from typing_extensions import Self
25
26class StartDeepResearchRequest(BaseModel):
27    """
28    StartDeepResearchRequest
29    """ # noqa: E501
30    query: StrictStr
31    web_search: Optional[StrictBool] = Field(default=False, alias="webSearch")
32    var_schema: Optional[StrictStr] = Field(default=None, alias="schema")
33    n8n: Optional[N8NConfig] = None
34    __properties: ClassVar[List[str]] = ["query", "webSearch", "schema", "n8n"]
35
36    model_config = ConfigDict(
37        populate_by_name=True,
38        validate_assignment=True,
39        protected_namespaces=(),
40    )
41
42
43    def to_str(self) -> str:
44        """Returns the string representation of the model using alias"""
45        return pprint.pformat(self.model_dump(by_alias=True))
46
47    def to_json(self) -> str:
48        """Returns the JSON representation of the model using alias"""
49        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
50        return json.dumps(self.to_dict())
51
52    @classmethod
53    def from_json(cls, json_str: str) -> Optional[Self]:
54        """Create an instance of StartDeepResearchRequest from a JSON string"""
55        return cls.from_dict(json.loads(json_str))
56
57    def to_dict(self) -> Dict[str, Any]:
58        """Return the dictionary representation of the model using alias.
59
60        This has the following differences from calling pydantic's
61        `self.model_dump(by_alias=True)`:
62
63        * `None` is only added to the output dict for nullable fields that
64          were set at model initialization. Other fields with value `None`
65          are ignored.
66        """
67        excluded_fields: Set[str] = set([
68        ])
69
70        _dict = self.model_dump(
71            by_alias=True,
72            exclude=excluded_fields,
73            exclude_none=True,
74        )
75        # override the default output from pydantic by calling `to_dict()` of n8n
76        if self.n8n:
77            _dict['n8n'] = self.n8n.to_dict()
78        return _dict
79
80    @classmethod
81    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
82        """Create an instance of StartDeepResearchRequest from a dict"""
83        if obj is None:
84            return None
85
86        if not isinstance(obj, dict):
87            return cls.model_validate(obj)
88
89        _obj = cls.model_validate({
90            "query": obj.get("query"),
91            "webSearch": obj.get("webSearch") if obj.get("webSearch") is not None else False,
92            "schema": obj.get("schema"),
93            "n8n": N8NConfig.from_dict(obj["n8n"]) if obj.get("n8n") is not None else None
94        })
95        return _obj

class StartDeepResearchRequest(pydantic.main.BaseModel): View Source

27class StartDeepResearchRequest(BaseModel):
28    """
29    StartDeepResearchRequest
30    """ # noqa: E501
31    query: StrictStr
32    web_search: Optional[StrictBool] = Field(default=False, alias="webSearch")
33    var_schema: Optional[StrictStr] = Field(default=None, alias="schema")
34    n8n: Optional[N8NConfig] = None
35    __properties: ClassVar[List[str]] = ["query", "webSearch", "schema", "n8n"]
36
37    model_config = ConfigDict(
38        populate_by_name=True,
39        validate_assignment=True,
40        protected_namespaces=(),
41    )
42
43
44    def to_str(self) -> str:
45        """Returns the string representation of the model using alias"""
46        return pprint.pformat(self.model_dump(by_alias=True))
47
48    def to_json(self) -> str:
49        """Returns the JSON representation of the model using alias"""
50        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
51        return json.dumps(self.to_dict())
52
53    @classmethod
54    def from_json(cls, json_str: str) -> Optional[Self]:
55        """Create an instance of StartDeepResearchRequest from a JSON string"""
56        return cls.from_dict(json.loads(json_str))
57
58    def to_dict(self) -> Dict[str, Any]:
59        """Return the dictionary representation of the model using alias.
60
61        This has the following differences from calling pydantic's
62        `self.model_dump(by_alias=True)`:
63
64        * `None` is only added to the output dict for nullable fields that
65          were set at model initialization. Other fields with value `None`
66          are ignored.
67        """
68        excluded_fields: Set[str] = set([
69        ])
70
71        _dict = self.model_dump(
72            by_alias=True,
73            exclude=excluded_fields,
74            exclude_none=True,
75        )
76        # override the default output from pydantic by calling `to_dict()` of n8n
77        if self.n8n:
78            _dict['n8n'] = self.n8n.to_dict()
79        return _dict
80
81    @classmethod
82    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
83        """Create an instance of StartDeepResearchRequest from a dict"""
84        if obj is None:
85            return None
86
87        if not isinstance(obj, dict):
88            return cls.model_validate(obj)
89
90        _obj = cls.model_validate({
91            "query": obj.get("query"),
92            "webSearch": obj.get("webSearch") if obj.get("webSearch") is not None else False,
93            "schema": obj.get("schema"),
94            "n8n": N8NConfig.from_dict(obj["n8n"]) if obj.get("n8n") is not None else None
95        })
96        return _obj

StartDeepResearchRequest

query: typing.Annotated[str, Strict(strict=True)]

web_search: Optional[Annotated[bool, Strict(strict=True)]]

var_schema: Optional[Annotated[str, Strict(strict=True)]]

n8n: Optional[vectorize_client.models.n8_n_config.N8NConfig]

model_config = {'populate_by_name': True, 'validate_assignment': True, 'protected_namespaces': ()}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

def to_str(self) -> str: View Source

44    def to_str(self) -> str:
45        """Returns the string representation of the model using alias"""
46        return pprint.pformat(self.model_dump(by_alias=True))

Returns the string representation of the model using alias

def to_json(self) -> str: View Source

48    def to_json(self) -> str:
49        """Returns the JSON representation of the model using alias"""
50        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
51        return json.dumps(self.to_dict())

Returns the JSON representation of the model using alias

@classmethod

def from_json(cls, json_str: str) -> Optional[Self]: View Source

53    @classmethod
54    def from_json(cls, json_str: str) -> Optional[Self]:
55        """Create an instance of StartDeepResearchRequest from a JSON string"""
56        return cls.from_dict(json.loads(json_str))

Create an instance of StartDeepResearchRequest from a JSON string

def to_dict(self) -> Dict[str, Any]: View Source

58    def to_dict(self) -> Dict[str, Any]:
59        """Return the dictionary representation of the model using alias.
60
61        This has the following differences from calling pydantic's
62        `self.model_dump(by_alias=True)`:
63
64        * `None` is only added to the output dict for nullable fields that
65          were set at model initialization. Other fields with value `None`
66          are ignored.
67        """
68        excluded_fields: Set[str] = set([
69        ])
70
71        _dict = self.model_dump(
72            by_alias=True,
73            exclude=excluded_fields,
74            exclude_none=True,
75        )
76        # override the default output from pydantic by calling `to_dict()` of n8n
77        if self.n8n:
78            _dict['n8n'] = self.n8n.to_dict()
79        return _dict

Return the dictionary representation of the model using alias.

This has the following differences from calling pydantic's self.model_dump(by_alias=True):

None is only added to the output dict for nullable fields that were set at model initialization. Other fields with value None are ignored.

@classmethod

def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]: View Source

81    @classmethod
82    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
83        """Create an instance of StartDeepResearchRequest from a dict"""
84        if obj is None:
85            return None
86
87        if not isinstance(obj, dict):
88            return cls.model_validate(obj)
89
90        _obj = cls.model_validate({
91            "query": obj.get("query"),
92            "webSearch": obj.get("webSearch") if obj.get("webSearch") is not None else False,
93            "schema": obj.get("schema"),
94            "n8n": N8NConfig.from_dict(obj["n8n"]) if obj.get("n8n") is not None else None
95        })
96        return _obj

Create an instance of StartDeepResearchRequest from a dict