GoodMemGoodMem
ReferenceCLIEmbedder

Embedder Update

Embedder Update CLI command reference

goodmem embedder update

Update an embedder

Synopsis

Update an embedder in the GoodMem service.

goodmem embedder update [embedder-id] [flags]

Examples

  # Update an embedder's display name
  goodmem embedder update 123e4567-e89b-12d3-a456-426614174000 --display-name "New Name"

  # Update an embedder's endpoint URL
  goodmem embedder update 123e4567-e89b-12d3-a456-426614174000 --endpoint-url "https://new-api.example.com"

  # Update an embedder's distribution type
  goodmem embedder update 123e4567-e89b-12d3-a456-426614174000 --distribution-type SPARSE

  # Rotate inline API key credentials
  goodmem embedder update 123e4567-e89b-12d3-a456-426614174000 --cred-api-key "NEW_API_KEY"

  # Atomically replace Gemini routing with Google Cloud configuration and ADC
  goodmem embedder update 123e4567-e89b-12d3-a456-426614174000 \
    --endpoint-url "https://aiplatform.us.rep.googleapis.com" \
    --api-path "/v1" \
    --gemini-api-backend google-cloud \
    --gemini-project-id "my-resource-project" \
    --gemini-location "us" \
    --cred-gcp \
    --cred-gcp-scope "https://www.googleapis.com/auth/cloud-platform"

  # Replace all labels with new ones
  goodmem embedder update 123e4567-e89b-12d3-a456-426614174000 --label key1=value1 --label key2=value2 --label-strategy replace

  # Merge new labels with existing ones
  goodmem embedder update 123e4567-e89b-12d3-a456-426614174000 --label key1=newvalue --label-strategy merge

Options

      --api-path string                New API path
      --cred-api-key string            API key for provider endpoint (use "-" to read from piped stdin)
      --cred-api-key-file string       Read API key from file (file should be mode 0600)
      --cred-api-key-prompt            Prompt for API key interactively (requires TTY, input hidden)
      --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)
      --dashscope-api-dialect string   New DashScope API dialect for DashScope resources only (EMBEDDING_NATIVE_TEXT, EMBEDDING_NATIVE_CONTENTS, or OPENAI_COMPATIBLE)
      --description string             New description for the embedder
      --dimensionality int32           New output vector dimensions
      --display-name string            New display name for the embedder
      --distribution-type string       New embedding distribution type (DENSE, SPARSE)
      --endpoint-url string            New API endpoint URL
      --gemini-api-backend string      Atomically replace Gemini endpoint routing (developer or google-cloud); requires the target to be a Gemini embedder
      --gemini-location string         Google Cloud location; requires --gemini-api-backend google-cloud; omitted defaults to global
      --gemini-project-id string       Google Cloud resource project; requires --gemini-api-backend google-cloud
  -h, --help                           help for update
  -l, --label strings                  New labels in key=value format (can be specified multiple times)
      --label-strategy string          Label update strategy: 'replace' to overwrite all existing labels, 'merge' to add to existing labels (default "replace")
      --max-sequence-length int32      New maximum input sequence length
      --model-identifier string        New model identifier
      --monitoring-endpoint string     New monitoring endpoint
      --version string                 New 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)

SEE ALSO