UpdateProjectRequestBody

pydantic model openapi_client.models.update_project_request_body.UpdateProjectRequestBody

Body for updating an AI project. Only the fields you send are changed; omitted fields keep their current values. Ignored when requesting an avatar upload URL. No field is required.

Fields:

• agents (List[str] | None)

• category (str | None)

• chat_suggestions (List[str] | None)

• chatbot_name (str | None)

• description (str | None)

• enforce_resource_acls (bool | None)

• greeting (str | None)

• guard_rail (str | None)

• instructions (str | None)

• keywords (List[str] | None)

• knowledgebases (List[str] | None)

• model (str | None)

• project_name (str | None)

• smart_chunking (bool | None)

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

New display name. Not checked for uniqueness.

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

New description.

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

Replaces the existing keyword list.

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

New category, cleaned up the same way as on create. Do not send Default; send an empty string to clear the category. Counts update only when the category actually changes.

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

Whether each user only sees the linked knowledge bases and agents they have access to.

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

New assistant display name. Sending this field re-validates the whole assistant configuration.

field instructions: Optional[Annotated[str, Field(strict=True, max_length=15000)]] = None (alias 'Instructions')

New instructions for the project assistant. Must be 15000 characters or fewer.

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

New opening message.

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

Replaces the existing list of suggested prompts.

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

ID of the model to use. Must be enabled for chats. If omitted, the stored model is kept, but it is still re-checked if you change any other assistant field.

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

ID of the guard rail to apply. The DRAFT version is used. Changing it switches the project to the new guard rail.

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

Replaces the project’s linked knowledge bases. Send an empty list to unlink all of them. New projects can have up to 5; a project that already has more may keep or reduce them, with a warning in Message, but cannot add more. Linking continues in the background.

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

Replaces the project’s linked agents. Send an empty list to unlink all of them (up to 10). Linking continues in the background.

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

Whether extra context is added to file chunks during indexing. Must be a JSON boolean.

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

Return type:

Optional[Self]