Read Embedding Model

Get embedding model by id.

Args:

db (AsyncSession): The database session. short_name (str): The short name of the embedding model. user (schemas.User): The current user.

Returns:

schemas.EmbeddingModel: The embedding model object.

Path parameters

short_namestringRequired

Response

Successful Response

namestring

short_namestring

providerstring

idstringformat: "uuid"

created_atdatetime

modified_atdatetime

descriptionstringOptional

model_namestringOptional

model_versionstringOptional

auth_typeenumOptional

Enumeration of supported authentication types.

Attributes:

oauth2: OAuth2 authentication. oauth2_with_refresh: OAuth2 authentication with refresh token. oauth2_with_refresh_rotating: OAuth2 authentication with rotating refresh token. trello_auth: Trello authentication. api_key: API key authentication. native_functionality: Native functionality. url_and_api_key: URL and API key authentication. none: No authentication.

auth_config_classstringOptional

config_fieldsobjectOptional

Fields model.

1	from airweave import AirweaveSDK
2
3	client = AirweaveSDK(
4	api_key="YOUR_API_KEY",
5	)
6	client.embedding_models.read_embedding_model(
7	short_name="short_name",
8	)

1	{
2	"name": "name",
3	"short_name": "short_name",
4	"provider": "provider",
5	"id": "id",
6	"created_at": "2024-01-15T09:30:00Z",
7	"modified_at": "2024-01-15T09:30:00Z",
8	"description": "description",
9	"model_name": "model_name",
10	"model_version": "model_version",
11	"auth_type": "oauth2",
12	"auth_config_class": "auth_config_class",
13	"config_fields": {
14	"fields": [
15	{
16	"name": "name",
17	"title": "title",
18	"type": "type"
19	}
20	]
21	}
22	}