Pipelines models reference
This reference documentation for EDB Postgres AI - AI Accelerator Pipelines models includes information on the functions and views available in the aidb extension for working with models.
Tables
aidb.model_providers
The aidb.model_providers table stores information about the model providers that were created in the database.
| Column | Type | Description |
|---|---|---|
| server_name | name | Name for the model server |
| server_description | text | Description of the model server |
| server_options | text[] | Options for the model server |
Functions
aidb.create_model
Creates a new model in the system by saving its name, provider, and optional configuration.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
name | text | User-defined name for the model. | |
provider | text | Name of the model provider (as found in aidb.model_providers). | |
config | jsonb | '{}'::jsonb | Optional configuration for the model provider. |
credentials | jsonb | '{}'::jsonb | Optional credentials for the model provider. |
replace_credentials | boolean | false | If true, replaces the credentials for the model provider. If false, the credentials aren't overwritten. |
Example
SELECT aidb.create_model( name => 'my_t5'::text, provider => 't5_local'::character varying, config => '{"param1": "value1", "param2": "value2"}'::jsonb, credentials => '{"token": "abcd"}'::jsonb );
or equivalently, using default values:
SELECT aidb.create_model('my_t5', 't5_local');
or if updating the credentials of a model's provider, which has already been created.
SELECT aidb.create_model( name => 'my_t5'::text, provider => 't5_local'::character varying, config => '{"param1": "value1", "param2": "value2"}'::jsonb, credentials => '{"token": "abcd"}'::jsonb, replace_credentials => true );
aidb.list_models
Returns a list of all models in the registry and their configured options.
Parameters
None
Returns
| Column | Type | Description |
|---|---|---|
name | text | User-defined name for the model |
provider | text | Name of the model provider |
options | jsonb | Optional configuration for the model provider |
Example
SELECT * FROM aidb.list_models();
name | provider | options
-------+------------+---------------
bert | bert_local | {"config={}"}
clip | clip_local | {"config={}"}
t5 | t5_local | {"config={}"}aidb.get_model
Returns the configuration for a model in the registry.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name | text | Name of the model |
Returns
| Column | Type | Description |
|---|---|---|
name | text | User-defined name for the model |
provider | text | Name of the model provider |
options | jsonb | Optional configuration for the model provider |
Example
SELECT * FROM aidb.get_model('t5');
name | provider | options
------+----------+---------------
t5 | t5_local | {"config={}"}
(1 row)aidb.delete_model
Deletes a model from the registry.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name | text | Name of the model |
Example
SELECT aidb.delete_model('t5');
delete_model
---------------------------------
(t5,t5_local,"{""config={}""}")
(1 row)Returns
| Column | Type | Description |
|---|---|---|
delete_model | jsonb | The name, provider, and options of the deleted model |
aidb.encode_text
Encodes text using a model, generating a vector representation of a given text input.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name | text | Name of the model to encode with | |
text | text | Text to encode |
aidb.encode_text_batch
Encodes a batch of text using a model, generating a vector representation of a given text input.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name | text | Name of the model to encode with | |
text | text[] | Array of text to encode |
aidb.decode_text
Decodes text using a model, generating a vector representation of a given text input.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name | text | Name of the model to decode with | |
text | text | Text to decode |
Returns
| Column | Type | Description |
|---|---|---|
decode_text | text | The decoded text |
aidb.decode_text_batch
Decodes a batch of text using a model, generating a representation of a given text input.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name | text | Name of the model to decode with | |
text | text[] | Array of text to decode |
Returns
| Column | Type | Description |
|---|---|---|
decode_text | text | The decoded text |
aidb.encode_image
Encodes an image using a model, generating a vector representation of a given image input.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name | text | Name of the model to encode with | |
image | bytea | Image to encode |
Returns
| Column | Type | Description |
|---|---|---|
encode_image | bytea | The encoded image |
aidb.rerank_text
Reranks text using a model, generating a vector representation of a given text input.
Parameters
| Parameter | Type | Default | Description |
|---|---|---|---|
model_name | text | Name of the model to rerank with | |
text | text | Text to rerank | |
inputs | strings[] | [] | Inputs for the model provider |
Returns
| Column | Type | Description |
|---|---|---|
rerank_text | double precision[] | Array of reranking logits |
Could this page be better? Report a problem or suggest an addition!