Connect to your own Models

You can use Data Designer with your own models as long as they are accessible via an Open AI Compatible endpoint. This gives you flexibility beyond the pre-defined Model Suites offered by Gretel.

When using your own models, you are responsible for ensuring model availability and sufficient scaling capacity.

Create an API connection

To ensure secure access to your models, use Gretel's Connection API to establish a connection with your LLM provider.

connection_id = gretel.data_designer.create_api_key_connection(
  name="my-model-connection",
  api_base="https://<LLM_ENDPOINT>",
  api_key="<MY_API_KEY>"
)

Customize your Model Suite

Once you've established your connection, you can initialize the Data Designer object with your custom defined model suite.

data_designer = gretel.data_designer.new(
        model_suite="bring-your-own", # Establish your own Model Suite
        model_configs=[
            ModelConfig(
                alias="my-awesome-llm",
                model_name="<MODEL_NAME>",
                connection_id=connection_id
            )
        ]
    )