From 6970ace7bb954c6f8dd12f334093cec287578e7e Mon Sep 17 00:00:00 2001 From: Nick K Date: Mon, 23 Dec 2024 08:26:40 -0800 Subject: [PATCH] docs: improve semantic content docstring --- clients/ts-sdk/openapi.json | 2 +- clients/ts-sdk/src/types.gen.ts | 2 +- server/src/handlers/chunk_handler.rs | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/clients/ts-sdk/openapi.json b/clients/ts-sdk/openapi.json index 7d997b41bc..a644aecce3 100644 --- a/clients/ts-sdk/openapi.json +++ b/clients/ts-sdk/openapi.json @@ -8045,7 +8045,7 @@ }, "semantic_content": { "type": "string", - "description": "If semantic_content is present, it will be used for creating semantic embeddings instead of the innerText `chunk_html`. `chunk_html` will still be the only thing stored and always used for fulltext functionality.", + "description": "If semantic_content is present, it will be used for creating semantic embeddings instead of the innerText `chunk_html`. `chunk_html` will still be the only thing stored and always used for fulltext functionality. `chunk_html` must still be present for the chunk to be created properly.", "nullable": true }, "split_avg": { diff --git a/clients/ts-sdk/src/types.gen.ts b/clients/ts-sdk/src/types.gen.ts index 63249b8d5a..1680201903 100644 --- a/clients/ts-sdk/src/types.gen.ts +++ b/clients/ts-sdk/src/types.gen.ts @@ -406,7 +406,7 @@ export type ChunkReqPayload = { num_value?: (number) | null; semantic_boost?: ((SemanticBoost) | null); /** - * If semantic_content is present, it will be used for creating semantic embeddings instead of the innerText `chunk_html`. `chunk_html` will still be the only thing stored and always used for fulltext functionality. + * If semantic_content is present, it will be used for creating semantic embeddings instead of the innerText `chunk_html`. `chunk_html` will still be the only thing stored and always used for fulltext functionality. `chunk_html` must still be present for the chunk to be created properly. */ semantic_content?: (string) | null; /** diff --git a/server/src/handlers/chunk_handler.rs b/server/src/handlers/chunk_handler.rs index 4de62429a1..c6763d6d06 100644 --- a/server/src/handlers/chunk_handler.rs +++ b/server/src/handlers/chunk_handler.rs @@ -102,7 +102,7 @@ pub struct ScoringOptions { pub struct ChunkReqPayload { /// HTML content of the chunk. This can also be plaintext. The innerText of the HTML will be used to create the embedding vector. The point of using HTML is for convienience, as some users have applications where users submit HTML content. pub chunk_html: Option, - /// If semantic_content is present, it will be used for creating semantic embeddings instead of the innerText `chunk_html`. `chunk_html` will still be the only thing stored and always used for fulltext functionality. + /// If semantic_content is present, it will be used for creating semantic embeddings instead of the innerText `chunk_html`. `chunk_html` will still be the only thing stored and always used for fulltext functionality. `chunk_html` must still be present for the chunk to be created properly. pub semantic_content: Option, /// Link to the chunk. This can also be any string. Frequently, this is a link to the source of the chunk. The link value will not affect the embedding creation. pub link: Option,