Embedding data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
model_idstringNo
contentGenaiEmbeddingContent[]No
content[].textstringYes
enconding_formatenumNoValues: FLOAT, UINT8, INT8, BINARY, UBINARY, BASE64
typestringNo'SEARCH_DOC' | 'SEARCH_QUERY' | 'CLUSTERING' | 'CLASSIFICATION';
dimensionnumberNo256, 512, 1024, and 1536
max_tokensnumberNo
embeddingsstringNoJSON string based off of the format (read-only)
tokens_usednumberNo (read-only)
idstringNo

TypeScript

TypeScript
export type GenaiEmbedding = {
	model_id?: string;
	content?: [];
	enconding_format?: 'FLOAT' | 'UINT8' | 'INT8' | 'BINARY' | 'UBINARY' | 'BASE64';
	type?: string; // 'SEARCH_DOC' | 'SEARCH_QUERY' | 'CLUSTERING' | 'CLASSIFICATION';
	dimension?: number; // 256, 512, 1024, and 1536
	max_tokens?: number;
	embeddings?: string; // JSON string based off of the format
	tokens_used?: number;
	raw?: any;
	id?: string;
} 

Zod

Zod
import { z } from 'zod';

export const ZodGenaiEmbedding = z.object({
	model_id: z.string().optional(),
	content: z.array().optional(),
	enconding_format: z.enum("FLOAT", "UINT8", "INT8", "BINARY", "UBINARY", "BASE64").optional(),
	type: z.string().optional().describe("'SEARCH_DOC' | 'SEARCH_QUERY' | 'CLUSTERING' | 'CLASSIFICATION';"),
	dimension: z.number().optional().describe("256, 512, 1024, and 1536"),
	max_tokens: z.number().optional(),
	embeddings: z.string().optional().describe("JSON string based off of the format"),
	tokens_used: z.number().optional(),
,
	id: z.string().optional()
});

Python

Python
import dataclasses

@dataclasses.dataclass
class GenaiEmbeddingEnconding_format(str, Enum):
	FLOAT = 'FLOAT'
	UINT8 = 'UINT8'
	INT8 = 'INT8'
	BINARY = 'BINARY'
	UBINARY = 'UBINARY'
	BASE64 = 'BASE64'

@dataclasses.dataclass
class GenaiEmbedding:
	model_id: Optional[str]
	content: Optional[PropertyGenaiEmbeddingContent]
	enconding_format: Optional[GenaiEmbeddingEnconding_format]
	"""'SEARCH_DOC' | 'SEARCH_QUERY' | 'CLUSTERING' | 'CLASSIFICATION';"""
	type: Optional[str]
	"""256, 512, 1024, and 1536"""
	dimension: Optional[int]
	max_tokens: Optional[int]
	"""JSON string based off of the format"""
	embeddings: Optional[str]
	tokens_used: Optional[int]

	id: Optional[str]
Are we missing anything? Let us know
Was this page helpful?