Skip to main content

aiSettingsSetVectorization

AiVectorizationSettingsWrapper aiSettingsSetVectorization(AiSettingsSetVectorizationRequest)

PUT /api/2.0/ai/config/vectorization

Update vectorization settings

Replaces the portal's vectorization settings and returns the stored result. The body is proxied unchanged to the DocSpace AI service, which validates it, so a rejected value is reported with that service's own verdict rather than being checked here. Changing the embedding provider does not re-index anything already indexed - start that separately with POST api/2.0/ai/vectorization/tasks. This is a portal-wide setting and requires the permissions the AI service demands for it.

Parameters​

NameInTypeDescriptionNotes
AiSettingsSetVectorizationRequestbodyMapThe portal's vectorization settings, proxied unchanged to the DocSpace AI service, which owns and validates the shape. Read the current one with GET api/2.0/ai/config/vectorization and send it back changed.[required]

Responses​

Status codeDescriptionTypeResponse headers
200The stored vectorization settings.AiVectorizationSettingsWrapper-
401Missing asc_auth_key cookie or Authorization header.AiErrorResponse-
403AI is disabled for this portal, the caller is a guest, or the room named by entityId is one the caller cannot open. Relayed from the DocSpace AI service or the Files API.AiErrorResponse-
413The request body is larger than 100 KB, the JSON parser's limit on this route.AiErrorResponse-
500Unhandled failure. The reason is logged server-side and never echoed back.AiErrorResponse-

Return type​

AiVectorizationSettingsWrapper

Authorization​

cookieAuth, bearerAuth

HTTP request headers​

  • Content-Type: application/json
  • Accept: application/json