ProjectListItem

pydantic model openapi_client.models.project_list_item.ProjectListItem

Project fields returned in the listing. Assistant settings, linked resources, and files are only included when you fetch a single project. projectionExpression can omit any of these fields.

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

Project ID (UUID), assigned by the server.

field project_name: Optional[StrictStr] = None (alias 'ProjectName')

Display name. Not unique — two projects may share a name.

field project_status: Optional[StrictStr] = None (alias 'ProjectStatus')

Current state of the project. created means it was created without knowledge bases or agents. initializing or updating means those resources are still being linked. configured means that work finished (including with partial failures). update_failed means linking failed. deleting means deletion is in progress. delete-failed means deletion did not complete.

field description: Optional[StrictStr] = None (alias 'Description')

Free-text description. Defaults to an empty string.

field keywords: Optional[List[StrictStr]] = None (alias 'Keywords')

Search keywords. Defaults to an empty list.

field category: Optional[StrictStr] = None (alias 'Category')

Normalized category name. Shown as “Default” for projects stored with no category.

field enforce_resource_acls: Optional[StrictBool] = None (alias 'EnforceResourceACLs')

When true, linked knowledge bases and agents are filtered per user in project details and chat. Defaults to false.

field smart_chunking: Optional[StrictBool] = None (alias 'SmartChunking')

When true, adds context enrichment to chunks during indexing. Defaults to false.

field access_type: Optional[StrictStr] = None (alias 'AccessType')

Your highest access level on this project. Falls back to “read-only” when no ACL entry resolved.

field creation_time: Optional[StrictStr] = None (alias 'CreationTime')

UTC creation timestamp, “YYYY-MM-DD HH:MM:SS”.

field created_by: Optional[StrictStr] = None (alias 'CreatedBy')

User ID of who created it.

field last_modified_time: Optional[StrictStr] = None (alias 'LastModifiedTime')

UTC timestamp of the last metadata change, “YYYY-MM-DD HH:MM:SS”. The default sortby field.

field last_modified_by: Optional[StrictStr] = None (alias 'LastModifiedBy')

User ID of who last changed it.

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

Return type:

Optional[Self]