ChunksRetrieved¶
- pydantic model openapi_client.models.chunks_retrieved.ChunksRetrieved¶
Retrieved chunks grouped by file. Text snippets are truncated to 100 characters on this REST path.
- Fields:
- field file_name: Optional[StrictStr] = None (alias 'FileName')¶
File path of the source document.
- field dataset_name: Optional[StrictStr] = None (alias 'DatasetName')¶
Dataset name parsed from the file path, when available.
- field domain_name: Optional[StrictStr] = None (alias 'DomainName')¶
Domain name parsed from the file path, when available.
- field text: Optional[List[StrictStr]] = None (alias 'Text')¶
Text snippets from the file (each snippet truncated at 100 characters).
- to_str()¶
Returns the string representation of the model using alias
- Return type:
str
- to_json()¶
Returns the JSON representation of the model using alias
- Return type:
str
- classmethod from_json(json_str)¶
Create an instance of ChunksRetrieved from a JSON string
- Return type:
Optional[Self]
- to_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.
- Return type:
Dict[str,Any]
- classmethod from_dict(obj)¶
Create an instance of ChunksRetrieved from a dict
- Return type:
Optional[Self]