Update to master:7f0f5e086247972f9cc57234025cd31e99fcc988.

www/docs/rest-api/create-corpus.api.mdx

@@ -63,7 +63,7 @@ The new filter attributes of the corpus.
 
 The custom dimensions of all document parts inside the corpus.
 
-</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the custom dimension.","type":"string","example":"importance"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Description of the custom dimension.","type":"string","example":"Product importance."}}></SchemaItem><SchemaItem collapsible={false} name={"indexing_default"} required={false} schemaName={"double"} qualifierMessage={undefined} schema={{"description":"Default value of a custom dimension on a document part if the custom\ndimension value is not specified when the document part is indexed.\n\nA value of 0 means that custom dimension is not considered.\n","type":"number","format":"double","example":0,"default":0}}></SchemaItem><SchemaItem collapsible={false} name={"querying_default"} required={false} schemaName={"double"} qualifierMessage={undefined} schema={{"description":"Default value of a custom dimension for a query if the value\nof the custom dimension is not specified when querying the corpus.\n\nA value of 0 means that custom dimension is not considered.\n","type":"number","format":"double","example":0,"default":0}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>limits</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"used_docs"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"The number of documents contained in the corpus.\n","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"used_parts"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"The number of document parts contained in the corpus.\n","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"used_bytes"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"NOTE: This field is currently not populated by the system.\nThe number of bytes contained in the corpus. This includes the document metadata,\ndocument part metadata, and document contents.\n","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"used_characters"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"The number of characters contained in the corpus. This includes the document metadata,\ndocument part metadata, and document contents.\n","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"max_bytes"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"NOTE: This field is currently not populated by the system.\nThe maximum number of bytes the corpus can be.\n","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"max_metadata_bytes"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"The maximum size that metadata can be on documents.","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"index_rate"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"NOTE: This field is currently not populated by the system.\nThe maximum per-second addition of new documents to corpus.\n","type":"integer","format":"int64"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Indicates when the corpus was created.","type":"string","format":"date-time"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"string\",\n  \"key\": \"my-corpus\",\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"enabled\": true,\n  \"chat_history_corpus\": true,\n  \"queries_are_answers\": false,\n  \"documents_are_questions\": false,\n  \"encoder_name\": \"boomerang\",\n  \"filter_attributes\": [\n    {\n      \"name\": \"Title\",\n      \"level\": \"document\",\n      \"description\": \"The title of the document.\",\n      \"indexed\": true,\n      \"type\": \"text\"\n    }\n  ],\n  \"custom_dimensions\": [\n    {\n      \"name\": \"importance\",\n      \"description\": \"Product importance.\",\n      \"indexing_default\": 0,\n      \"querying_default\": 0\n    }\n  ],\n  \"limits\": {\n    \"used_docs\": 0,\n    \"used_parts\": 0,\n    \"used_bytes\": 0,\n    \"used_characters\": 0,\n    \"max_bytes\": 0,\n    \"max_metadata_bytes\": 0,\n    \"index_rate\": 0\n  },\n  \"created_at\": \"2024-12-02T21:15:26.088Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
+</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}>Array [</div></li><SchemaItem collapsible={false} name={"name"} required={true} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The name of the custom dimension.","type":"string","example":"importance"}}></SchemaItem><SchemaItem collapsible={false} name={"description"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"Description of the custom dimension.","type":"string","example":"Product importance."}}></SchemaItem><SchemaItem collapsible={false} name={"indexing_default"} required={false} schemaName={"double"} qualifierMessage={undefined} schema={{"description":"Default value of a custom dimension on a document part if the custom\ndimension value is not specified when the document part is indexed.\n\nA value of 0 means that custom dimension is not considered.\n","type":"number","format":"double","example":0,"default":0}}></SchemaItem><SchemaItem collapsible={false} name={"querying_default"} required={false} schemaName={"double"} qualifierMessage={undefined} schema={{"description":"Default value of a custom dimension for a query if the value\nof the custom dimension is not specified when querying the corpus.\n\nA value of 0 means that custom dimension is not considered.\n","type":"number","format":"double","example":0,"default":0}}></SchemaItem><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem><SchemaItem collapsible={true} className={"schemaItem"}><details style={{}} className={"openapi-markdown__details"}><summary style={{}}><span className={"openapi-schema__container"}><strong className={"openapi-schema__property"}>limits</strong><span className={"openapi-schema__name"}> object</span></span></summary><div style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"used_docs"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"The number of documents contained in the corpus.\n","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"used_parts"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"The number of document parts contained in the corpus.\n","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"used_bytes"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"NOTE: This field is currently not populated by the system.\nThe number of bytes contained in the corpus. This includes the document metadata,\ndocument part metadata, and document contents.\n","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"used_characters"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"The number of characters contained in the corpus. This includes the document metadata,\ndocument part metadata, and document contents.\n","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"max_bytes"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"NOTE: This field is currently not populated by the system.\nThe maximum number of bytes the corpus can be.\n","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"max_metadata_bytes"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"The maximum size that metadata can be on documents.","type":"integer","format":"int64"}}></SchemaItem><SchemaItem collapsible={false} name={"index_rate"} required={false} schemaName={"int64"} qualifierMessage={undefined} schema={{"description":"NOTE: This field is currently not populated by the system.\nThe maximum per-second addition of new documents to corpus.\n","type":"integer","format":"int64"}}></SchemaItem></div></details></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Indicates when the corpus was created.","type":"string","format":"date-time"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"string\",\n  \"key\": \"my-corpus\",\n  \"name\": \"string\",\n  \"description\": \"string\",\n  \"enabled\": true,\n  \"chat_history_corpus\": true,\n  \"queries_are_answers\": false,\n  \"documents_are_questions\": false,\n  \"encoder_name\": \"boomerang\",\n  \"filter_attributes\": [\n    {\n      \"name\": \"Title\",\n      \"level\": \"document\",\n      \"description\": \"The title of the document.\",\n      \"indexed\": true,\n      \"type\": \"text\"\n    }\n  ],\n  \"custom_dimensions\": [\n    {\n      \"name\": \"importance\",\n      \"description\": \"Product importance.\",\n      \"indexing_default\": 0,\n      \"querying_default\": 0\n    }\n  ],\n  \"limits\": {\n    \"used_docs\": 0,\n    \"used_parts\": 0,\n    \"used_bytes\": 0,\n    \"used_characters\": 0,\n    \"max_bytes\": 0,\n    \"max_metadata_bytes\": 0,\n    \"index_rate\": 0\n  },\n  \"created_at\": \"2024-12-13T17:52:53.567Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
 
 Invalid request body in the create corpus request.
 

www/docs/rest-api/create-user.api.mdx

@@ -64,7 +64,7 @@ resource is a resource implied by the request.
 
 string
 
-</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"string\",\n  \"email\": \"user@example.com\",\n  \"username\": \"string\",\n  \"enabled\": true,\n  \"description\": \"string\",\n  \"created_at\": \"2024-12-02T21:15:26.120Z\",\n  \"updated_at\": \"2024-12-02T21:15:26.120Z\",\n  \"api_roles\": [\n    \"owner\"\n  ],\n  \"api_policy\": {\n    \"name\": \"string\",\n    \"allowed_operations\": {}\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
+</div><li><div style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}>]</div></li></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></div></details></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"string\",\n  \"email\": \"user@example.com\",\n  \"username\": \"string\",\n  \"enabled\": true,\n  \"description\": \"string\",\n  \"created_at\": \"2024-12-13T17:52:53.644Z\",\n  \"updated_at\": \"2024-12-13T17:52:53.644Z\",\n  \"api_roles\": [\n    \"owner\"\n  ],\n  \"api_policy\": {\n    \"name\": \"string\",\n    \"allowed_operations\": {}\n  }\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"400"} value={"400"}><div>
 
 User creation request was malformed.
 

www/docs/rest-api/get-chat-turn.api.mdx

@@ -36,7 +36,7 @@ Get a specific turn from a chat, which is a message and response pair from the c
 
 The turn.
 
-</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `trn_.+$`"} schema={{"description":"The ID of the turn.","type":"string","pattern":"trn_.+$"}}></SchemaItem><SchemaItem collapsible={false} name={"chat_id"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `cht_.+$`"} schema={{"description":"The ID of the chat the turn resides in.","type":"string","pattern":"cht_.+$"}}></SchemaItem><SchemaItem collapsible={false} name={"query"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The query made to produce this turn.","type":"string","example":"How do you turn this widget?"}}></SchemaItem><SchemaItem collapsible={false} name={"answer"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The response to the query.","type":"string","example":"The widget turns counter clockwise."}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates whether the turn is enabled and shown in future turns of the chat.","type":"boolean","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Specifies when the turn was created.","type":"string","format":"date-time"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"string\",\n  \"chat_id\": \"string\",\n  \"query\": \"How do you turn this widget?\",\n  \"answer\": \"The widget turns counter clockwise.\",\n  \"enabled\": true,\n  \"created_at\": \"2024-12-02T21:15:26.116Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
+</div><div><MimeTabs className={"openapi-tabs__mime"} schemaType={"response"}><TabItem label={"application/json"} value={"application/json"}><SchemaTabs className={"openapi-tabs__schema"}><TabItem label={"Schema"} value={"Schema"}><details style={{}} className={"openapi-markdown__details response"} data-collapsed={false} open={true}><summary style={{}} className={"openapi-markdown__details-summary-response"}><strong>Schema</strong></summary><div style={{"textAlign":"left","marginLeft":"1rem"}}></div><ul style={{"marginLeft":"1rem"}}><SchemaItem collapsible={false} name={"id"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `trn_.+$`"} schema={{"description":"The ID of the turn.","type":"string","pattern":"trn_.+$"}}></SchemaItem><SchemaItem collapsible={false} name={"chat_id"} required={false} schemaName={"string"} qualifierMessage={"**Possible values:** Value must match regular expression `cht_.+$`"} schema={{"description":"The ID of the chat the turn resides in.","type":"string","pattern":"cht_.+$"}}></SchemaItem><SchemaItem collapsible={false} name={"query"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The query made to produce this turn.","type":"string","example":"How do you turn this widget?"}}></SchemaItem><SchemaItem collapsible={false} name={"answer"} required={false} schemaName={"string"} qualifierMessage={undefined} schema={{"description":"The response to the query.","type":"string","example":"The widget turns counter clockwise."}}></SchemaItem><SchemaItem collapsible={false} name={"enabled"} required={false} schemaName={"boolean"} qualifierMessage={undefined} schema={{"description":"Indicates whether the turn is enabled and shown in future turns of the chat.","type":"boolean","example":true}}></SchemaItem><SchemaItem collapsible={false} name={"created_at"} required={false} schemaName={"date-time"} qualifierMessage={undefined} schema={{"description":"Specifies when the turn was created.","type":"string","format":"date-time"}}></SchemaItem></ul></details></TabItem><TabItem label={"Example (from schema)"} value={"Example (from schema)"}><ResponseSamples responseExample={"{\n  \"id\": \"string\",\n  \"chat_id\": \"string\",\n  \"query\": \"How do you turn this widget?\",\n  \"answer\": \"The widget turns counter clockwise.\",\n  \"enabled\": true,\n  \"created_at\": \"2024-12-13T17:52:53.636Z\"\n}"} language={"json"}></ResponseSamples></TabItem></SchemaTabs></TabItem></MimeTabs></div></TabItem><TabItem label={"403"} value={"403"}><div>
 
 Permissions do not allow getting the turn.