GoodMem
ReferenceCLI

Embedder Create

Embedder Create CLI command reference

goodmem embedder create

Create a new embedder

Synopsis

Create a new embedder in the GoodMem service with the specified configuration.

goodmem embedder create [flags]

Examples

  # Create an OpenAI embedder with a client-provided ID (defaults to DENSE)
  goodmem embedder create --id "123e4567-e89b-12d3-a456-426614174000" --display-name "OpenAI Ada" --provider-type OPENAI --endpoint-url "https://api.openai.com/v1" --model-identifier "text-embedding-3-small" --dimensionality 1536 --cred-api-key "sk-..."

  # Create an OpenAI embedder (server-generated ID)
  goodmem embedder create --display-name "OpenAI Ada" --provider-type OPENAI --endpoint-url "https://api.openai.com/v1" --model-identifier "text-embedding-3-small" --dimensionality 1536 --cred-api-key "sk-..."

  # Create a Cohere embedder with inline credentials
  goodmem embedder create --display-name "Cohere Embedder" --provider-type COHERE --endpoint-url "https://api.cohere.com" --model-identifier "embed-english-v3.0" --dimensionality 1024 --cred-api-key "YOUR_COHERE_API_KEY"

  # Create a Voyage AI embedder with inline credentials
  goodmem embedder create --display-name "Voyage AI" --provider-type VOYAGE --endpoint-url "https://api.voyageai.com/v1/embeddings" --model-identifier "voyage-3-large" --dimensionality 1024 --cred-api-key "pa-..."

  # Create a Vertex AI embedder with ADC credentials and a quota project
  goodmem embedder create --display-name "Vertex Embeddings" --provider-type OPENAI --endpoint-url "https://us-central1-aiplatform.googleapis.com" --model-identifier "textembedding-gecko" --dimensionality 768 --cred-gcp --cred-gcp-scope https://www.googleapis.com/auth/cloud-platform --cred-gcp-quota my-billing-project

  # Create a vLLM embedder without credentials for local deployment
  goodmem embedder create --display-name "Local vLLM" --provider-type VLLM --endpoint-url "http://localhost:8000/v1" --model-identifier "all-MiniLM-L6-v2" --dimensionality 384 --label environment=dev --label team=ml

  # Create a TEI embedder (defaults api-path to /embed) pointing at a local Qwen3 deployment
  goodmem embedder create --display-name "Local Qwen3-0.6B" --provider-type TEI --endpoint-url "http://qwen3.embed.goodmem.ai:8010" --model-identifier "Qwen3-Embedding-0.6B" --dimensionality 1024 --label environment=dev --label team=search

  # Create an embedder for another user (requires admin permissions)
  goodmem embedder create --display-name "Team Embedder" --provider-type OPENAI --endpoint-url "https://api.openai.com/v1" --model-identifier "text-embedding-3-small" --dimensionality 1536 --cred-api-key "YOUR_API_KEY" --owner 123e4567-e89b-12d3-a456-426614174000

Options

      --api-path string              API path (defaults: Cohere /v2/embed, TEI /embed, others /embeddings)
      --cred-api-key string          Inline API key stored by GoodMem (sends Authorization: Bearer <key>)
      --cred-gcp                     Use Google Application Default Credentials
      --cred-gcp-quota string        Quota project for Google ADC requests
      --cred-gcp-scope strings       Additional Google ADC OAuth scope (can be specified multiple times)
      --description string           Description of the embedder
      --dimensionality int32         Output vector dimensions
      --display-name string          Display name of the embedder
      --distribution-type string     Embedding distribution type (DENSE, SPARSE) - defaults to DENSE
      --endpoint-url string          API endpoint URL
  -h, --help                         help for create
      --id string                    Optional: Client-provided UUID for the embedder (16 bytes). Server generates if omitted.
  -l, --label strings                Labels in key=value format (can be specified multiple times)
      --max-sequence-length int32    Maximum input sequence length
      --modality strings             Supported modalities (TEXT, IMAGE, AUDIO, VIDEO)
      --model-identifier string      Model identifier (e.g., text-embedding-3-small)
      --monitoring-endpoint string   Optional monitoring endpoint
      --owner string                 Owner ID for the embedder (requires admin permissions)
      --provider-type string         Provider type (OPENAI, VLLM, TEI, LLAMA_CPP, VOYAGE, COHERE, JINA)
      --version string               Optional version information

Options inherited from parent commands

      --api-key string   API key for authentication (can also be set via GOODMEM_API_KEY environment variable)
      --server string    GoodMem server address (gRPC API) (default "https://localhost:9090")

SEE ALSO