EmbeddingService gRPC API
EmbeddingService provides text-to-vector embedding operations for plugins
Proto file: plugin/grpc/protocol/embedding.proto
Service Methods
| Method | Request | Response | Streaming |
|---|
| Embed | EmbedRequest | EmbedResponse | No |
| BatchEmbed | BatchEmbedRequest | BatchEmbedResponse | No |
| Cluster | ClusterRequest | ClusterResponse | No |
| ModelInfo | ModelInfoRequest | ModelInfoResponse | No |
| GetLabelEligibleClusters | GetLabelEligibleClustersRequest | GetLabelEligibleClustersResponse | No |
| SampleClusterTexts | SampleClusterTextsRequest | SampleClusterTextsResponse | No |
| SetClusterLabel | SetClusterLabelRequest | SetClusterLabelResponse | No |
Embed
Embed generates a vector embedding for a single text
- Request:
EmbedRequest
- Response:
EmbedResponse
BatchEmbed
BatchEmbed generates vector embeddings for multiple texts
- Request:
BatchEmbedRequest
- Response:
BatchEmbedResponse
Cluster
Cluster runs HDBSCAN clustering on a flat array of embeddings
- Request:
ClusterRequest
- Response:
ClusterResponse
ModelInfo
ModelInfo returns metadata about the loaded embedding model
- Request:
ModelInfoRequest
- Response:
ModelInfoResponse
GetLabelEligibleClusters
GetLabelEligibleClusters returns clusters eligible for labeling
- Request:
GetLabelEligibleClustersRequest
- Response:
GetLabelEligibleClustersResponse
SampleClusterTexts
SampleClusterTexts returns random sample texts from a cluster
- Request:
SampleClusterTextsRequest
- Response:
SampleClusterTextsResponse
SetClusterLabel
SetClusterLabel sets or updates the label on a cluster
- Request:
SetClusterLabelRequest
- Response:
SetClusterLabelResponse
Message Types
EmbedRequest
| Field | Type | Description |
|---|
| auth_token | string | - |
| text | string | - |
EmbedResponse
| Field | Type | Description |
|---|
| vector | float | - |
| dimensions | int32 | - |
| model | string | - |
| tokens | int32 | - |
BatchEmbedRequest
| Field | Type | Description |
|---|
| auth_token | string | - |
| texts | string | - |
BatchEmbedResponse
| Field | Type | Description |
|---|
| results | EmbeddingVector | - |
| dimensions | int32 | - |
| model | string | - |
| total_tokens | int32 | - |
EmbeddingVector
| Field | Type | Description |
|---|
| vector | float | - |
| tokens | int32 | - |
GetLabelEligibleClustersRequest
| Field | Type | Description |
|---|
| auth_token | string | - |
| min_size | int32 | - |
| cooldown_days | int32 | - |
| limit | int32 | - |
GetLabelEligibleClustersResponse
| Field | Type | Description |
|---|
| clusters | EligibleCluster | - |
EligibleCluster
| Field | Type | Description |
|---|
| id | int32 | - |
| members | int32 | - |
SampleClusterTextsRequest
| Field | Type | Description |
|---|
| auth_token | string | - |
| cluster_id | int32 | - |
| sample_size | int32 | - |
SampleClusterTextsResponse
| Field | Type | Description |
|---|
| texts | string | - |
SetClusterLabelRequest
| Field | Type | Description |
|---|
| auth_token | string | - |
| cluster_id | int32 | - |
| label | string | - |
SetClusterLabelResponse
ClusterRequest
| Field | Type | Description |
|---|
| auth_token | string | - |
| data | float | - |
| n_points | int32 | - |
| dimensions | int32 | - |
| min_cluster_size | int32 | - |
ClusterResponse
| Field | Type | Description |
|---|
| labels | int32 | - |
| probabilities | float | - |
| n_clusters | int32 | - |
| centroids | Centroid | - |
Centroid
| Field | Type | Description |
|---|
| vector | float | - |
ModelInfoRequest
| Field | Type | Description |
|---|
| auth_token | string | - |
ModelInfoResponse
| Field | Type | Description |
|---|
| name | string | - |
| dimensions | int32 | - |
| max_sequence_length | int32 | - |
← Back to API Index