NoteCreateRequest

pydantic model openapi_client.models.note_create_request.NoteCreateRequest

NoteCreateRequest

Fields:
field title: StrictStr [Required] (alias 'Title')

Required display title. Empty or whitespace-only values return IPV-1001.

Constraints:

  • strict = True

field chat_id: Optional[StrictStr] = None (alias 'ChatId')

Optional chat to associate. When not N/A, the chat must exist (IPV-1002 otherwise).

field project_id: Optional[StrictStr] = None (alias 'ProjectId')

Optional project to associate. Defaults to N/A.

field note_type: Optional[StrictStr] = None (alias 'NoteType')

note (default) is a user note. prompt is a reusable prompt snippet. Other values return IPV-1041.

field note_content: Annotated[str, Field(strict=True, max_length=50000)] [Required] (alias 'NoteContent')

Markdown body stored in S3. Required. Longer than 50000 characters returns IPV-1015.

Constraints:

  • strict = True

  • max_length = 50000

field sources: Optional[List[Dict[str, Any]]] = None (alias 'Sources')

Optional source metadata. Defaults to an empty list.

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 NoteCreateRequest 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 NoteCreateRequest from a dict

Return type:

Optional[Self]