GetProjectDetailsResponse

pydantic model openapi_client.models.get_project_details_response.GetProjectDetailsResponse

Full details of an AI project, including assistant settings, your access level, linked knowledge bases and agents, uploaded files, and when project context was last refreshed.

Fields:

• access_type (str | None)

• agents (List[openapi_client.models.ai_project_agent_ref.AiProjectAgentRef] | None)

• avatar_url (str | None)

• category (str | None)

• chat_suggestions (List[str] | None)

• chatbot_name (str | None)

• created_by (str | None)

• creation_time (str | None)

• description (str | None)

• enforce_resource_acls (bool | None)

• files (List[openapi_client.models.ai_project_file.AiProjectFile] | None)

• greeting (str | None)

• guard_rail (openapi_client.models.ai_project_guard_rail.AiProjectGuardRail | None)

• instructions (str | None)

• keywords (List[str] | None)

• knowledgebases (List[openapi_client.models.ai_project_knowledgebase_ref.AiProjectKnowledgebaseRef] | None)

• last_context_refreshed_time (str | None)

• last_modified_by (str | None)

• last_modified_time (str | None)

• message (str | None)

• model (openapi_client.models.ai_project_model.AiProjectModel | None)

• project_id (str | None)

• project_name (str | None)

• project_status (str | None)

• project_stewards (List[str] | None)

• smart_chunking (bool | None)

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

Project ID (UUID).

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

Display name.

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

Current state of the project. See ProjectListItem.ProjectStatus for the full set of values.

field message: Optional[StrictStr] = None (alias 'Message')

Extra status from the last create, update, or delete. Includes the error text when linking or deletion failed.

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

Free-text description.

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

Search keywords.

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

Normalized category name, or “Default” when none was set.

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

When true, the Knowledgebases and Agents lists below are limited to what the calling user can access.

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

Whether context enrichment is added to chunks during indexing.

field chatbot_name: Optional[StrictStr] = None (alias 'ChatbotName')

Display name of the project assistant.

field instructions: Optional[StrictStr] = None (alias 'Instructions')

Instructions for the project assistant.

field greeting: Optional[StrictStr] = None (alias 'Greeting')

Welcome message shown in chat.

field chat_suggestions: Optional[List[StrictStr]] = None (alias 'ChatSuggestions')

Suggested prompts shown in the chat UI.

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 change, “YYYY-MM-DD HH:MM:SS”.

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

User ID of who last changed it.

field model: Optional[AiProjectModel] = None (alias 'Model')

field guard_rail: Optional[AiProjectGuardRail] = None (alias 'GuardRail')

field avatar_url: Optional[StrictStr] = None (alias 'AvatarURL')

Short-lived download URL for the assistant avatar. Omitted when no avatar has been uploaded.

field last_context_refreshed_time: Optional[StrictStr] = None (alias 'LastContextRefreshedTime')

When project context was last refreshed, as YYYY-MM-DD HH:MM:SS UTC. Taken from the latest knowledge-base sync, file index, or agent change. Null if none of those have a timestamp.

field knowledgebases: Optional[List[AiProjectKnowledgebaseRef]] = None (alias 'Knowledgebases')

Knowledge bases linked to the project. Missing knowledge bases are omitted, and so are ones you cannot access when EnforceResourceACLs is true — so this list can be shorter than what was saved.

field agents: Optional[List[AiProjectAgentRef]] = None (alias 'Agents')

Agents linked to the project, filtered on the same terms as Knowledgebases. The platform system agents (SummarizerAgent, DatalabellerAgent, ErrorDiagnosisAgent) are always visible. The built-in web-search capability is not represented here.

field files: Optional[List[AiProjectFile]] = None (alias 'Files')

Files uploaded to the project, with indexing status.

field project_stewards: Optional[List[StrictStr]] = None (alias 'ProjectStewards')

Users notified when a guard rail blocks a project conversation. Omitted when none are set. Manage these through the project stewards API.

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

Your highest access level on this project.

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

Return type:

Optional[Self]