Skip to content

Commit

Permalink
feat: enhance JSDoc comments in QwenEmbeddingSettings interface
Browse files Browse the repository at this point in the history
  • Loading branch information
Younis-Ahmed committed Feb 18, 2025
1 parent 32fc62e commit a1607e3
Showing 1 changed file with 19 additions and 19 deletions.
38 changes: 19 additions & 19 deletions src/qwen-embedding-settings.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,25 +7,25 @@ export type QwenEmbeddingModelId = "text-embedding-v3" | (string & {})
* Settings configuration for Qwen text embeddings.
*/
export interface QwenEmbeddingSettings {
/**
* A unique identifier for the end-user used for monitoring and abuse detection.
*/
user?: string
/**
* The type of text. Valid values are 'query' and 'document'.
* Default is 'document'. Use 'query' when performing text queries.
*/
text_type?: string
/**
* A unique identifier for the end-user used for monitoring and abuse detection.
*/
user?: string
/**
* The type of text. Valid values are 'query' and 'document'.
* Default is 'document'. Use 'query' when performing text queries.
*/
text_type?: string

/**
* The dimensionality of the output vector.
* Valid values include 1024, 768, and 512. Default is 1024.
*/
dimensions?: number
/**
* The dimensionality of the output vector.
* Valid values include 1024, 768, and 512. Default is 1024.
*/
dimensions?: number

/**
* Specifies the type of output vectors.
* Valid values: "dense", "sparse", or "dense&sparse". Default is "dense".
*/
output_type?: "dense" | "sparse" | "dense&sparse"
/**
* Specifies the type of output vectors.
* Valid values: "dense", "sparse", or "dense&sparse". Default is "dense".
*/
output_type?: "dense" | "sparse" | "dense&sparse"
}

0 comments on commit a1607e3

Please sign in to comment.