SAM Types
A TypeScript type of every SAM manifest kind, generated from the platform’s JSON Schemas. manifest.toSam(kind) returns one. See Models.
- SAM_KINDS
Every kind that the SDK has a type of.
- Type:
unknown
- SAM_SCHEMAS
The JSON Schema of each kind, by its manifest
kind.- Type:
Readonly<Record<string, object>>
- class SAMAccount()
Smarter API Manifest - Account
- SAMAccount.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMAccount.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMAccount.metadata
- Type:
SAMAccountMetadata
- SAMAccount.spec
- Type:
SAMAccountSpec
- SAMAccount.status
Account.status[obj]: Optional, Read-only. Stateful status information about the Account.
- Type:
SAMAccountStatus | null
- class SAMApiConnection()
Smarter API Connection Manifest - ApiConnection Model
- SAMApiConnection.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMApiConnection.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMApiConnection.metadata
- Type:
SAMConnectionCommonMetadata
- SAMApiConnection.spec
- Type:
SAMApiConnectionSpec
- SAMApiConnection.status
Connection.status[obj]: Optional, Read-only. Stateful status information about the Connection.
- Type:
SAMConnectionCommonStatus | null
- class SAMApiPlugin()
Smarter API Manifest - ApiPlugin Model
- SAMApiPlugin.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMApiPlugin.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMApiPlugin.metadata
- Type:
SAMPluginCommonMetadata
- SAMApiPlugin.spec
- Type:
SAMApiPluginSpec
- SAMApiPlugin.status
Plugin.status[obj]: Optional, Read-only. Stateful status information about the Plugin.
- Type:
SAMPluginCommonStatus | null
- class SAMBudget()
Smarter API Manifest - Budget.
- SAMBudget.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMBudget.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMBudget.metadata
- Type:
SAMBudgetMetadata
- SAMBudget.spec
- Type:
SAMBudgetSpec
- SAMBudget.status
Budget.status[obj]: Optional, Read-only. Stateful status information about the Budget.
- Type:
SAMBudgetStatus | null
- class SAMCustomDomain()
Smarter API Manifest - CustomDomain.
- SAMCustomDomain.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMCustomDomain.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMCustomDomain.metadata
- Type:
SAMCustomDomainMetadata
- SAMCustomDomain.spec
- Type:
SAMCustomDomainSpec
- SAMCustomDomain.status
CustomDomain.status[obj]: Optional, Read-only. Stateful status information about the CustomDomain.
- Type:
SAMCustomDomainStatus | null
- class SAMGuardrail()
Smarter API Manifest - Guardrail.
- SAMGuardrail.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMGuardrail.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMGuardrail.metadata
- Type:
SAMGuardrailMetadata
- SAMGuardrail.spec
- Type:
SAMGuardrailSpec
- SAMGuardrail.status
Guardrail.status[obj]: Optional, Read-only. Stateful status information about the Guardrail.
- Type:
SAMGuardrailStatus | null
- class SAMImageSearchPlugin()
Smarter API Manifest - ImageSearchPlugin Model.
- SAMImageSearchPlugin.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMImageSearchPlugin.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMImageSearchPlugin.metadata
- Type:
SAMPluginCommonMetadata
- SAMImageSearchPlugin.spec
- Type:
SAMImageSearchPluginSpec
- SAMImageSearchPlugin.status
Plugin.status[obj]: Optional, Read-only. Stateful status information about the Plugin.
- Type:
SAMPluginCommonStatus | null
- class SAMKinds()
The type of each kind, by its manifest
kind.- SAMKinds.Account
- Type:
SAMAccount
- SAMKinds.ApiConnection
- Type:
SAMApiConnection
- SAMKinds.ApiPlugin
- Type:
SAMApiPlugin
- SAMKinds.Budget
- Type:
SAMBudget
- SAMKinds.CustomDomain
- Type:
SAMCustomDomain
- SAMKinds.Guardrail
- Type:
SAMGuardrail
- SAMKinds.ImageSearchPlugin
- Type:
SAMImageSearchPlugin
- SAMKinds.LLMClient
- Type:
SAMLLMClient
- SAMKinds.LLMHost
- Type:
SAMLLMHost
- SAMKinds.LLMHostCompute
- Type:
SAMLLMHostCompute
- SAMKinds.MCPClient
- Type:
SAMMCPClient
- SAMKinds.Orchestrator
- Type:
SAMOrchestrator
- SAMKinds.Plugin
- Type:
SAMPlugin
- SAMKinds.Prompt
- Type:
SAMPrompt
- SAMKinds.Provider
- Type:
SAMProvider
- SAMKinds.Proxy
- Type:
SAMProxy
- SAMKinds.Secret
- Type:
SAMSecret
- SAMKinds.SkillPlugin
- Type:
SAMSkillPlugin
- SAMKinds.SmarterAuthToken
- Type:
SAMSmarterAuthToken
- SAMKinds.SqlConnection
- Type:
SAMSqlConnection
- SAMKinds.SqlPlugin
- Type:
SAMSqlPlugin
- SAMKinds.User
- Type:
SAMUser
- SAMKinds.Vectorsearch
- Type:
SAMVectorsearch
- SAMKinds.Vectorstore
- Type:
SAMVectorstore
- SAMKinds.WebsearchPlugin
- Type:
SAMWebsearchPlugin
- class SAMLLMClient()
Smarter API Manifest - LLMClient.
- SAMLLMClient.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMLLMClient.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMLLMClient.metadata
- Type:
SAMLLMClientMetadata
- SAMLLMClient.spec
- Type:
SAMLLMClientSpec
- SAMLLMClient.status
LLMClient.status[obj]: Optional, Read-only. Stateful status information about the LLMClient.
- Type:
SAMLLMClientStatus | null
- class SAMLLMHost()
Smarter API Manifest - LLMHost.
- SAMLLMHost.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMLLMHost.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMLLMHost.metadata
- Type:
SAMLLMHostMetadata
- SAMLLMHost.spec
- Type:
SAMLLMHostSpec
- SAMLLMHost.status
LLMHost.status[obj]: Optional, Read-only. Stateful status information about the LLMHost.
- Type:
SAMLLMHostStatus | null
- class SAMLLMHostCompute()
Smarter API Manifest - LLMHostCompute.
- SAMLLMHostCompute.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMLLMHostCompute.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMLLMHostCompute.metadata
- Type:
SAMLLMHostComputeMetadata
- SAMLLMHostCompute.spec
- Type:
SAMLLMHostComputeSpec
- SAMLLMHostCompute.status
LLMHostCompute.status[obj]: Optional, Read-only. Stateful status information about the LLMHostCompute.
- Type:
SAMLLMHostComputeStatus | null
- class SAMMCPClient()
Smarter API Manifest - MCPClient.
- SAMMCPClient.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMMCPClient.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMMCPClient.metadata
- Type:
SAMMCPClientMetadata
- SAMMCPClient.spec
- Type:
SAMMCPClientSpec
- SAMMCPClient.status
MCPClient.status[obj]: Optional, Read-only. Stateful status information about the MCPClient.
- Type:
SAMMCPClientStatus | null
- class SAMOrchestrator()
Smarter API Manifest - Orchestrator.
- SAMOrchestrator.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMOrchestrator.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMOrchestrator.metadata
- Type:
SAMOrchestratorMetadata
- SAMOrchestrator.spec
- Type:
SAMOrchestratorSpec
- SAMOrchestrator.status
Orchestrator.status[obj]: Optional, Read-only. Stateful status information about the Orchestrator.
- Type:
SAMOrchestratorStatus | null
- class SAMPlugin()
Smarter API Manifest - Plugin
- SAMPlugin.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMPlugin.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMPlugin.metadata
- Type:
SAMPluginCommonMetadata
- SAMPlugin.spec
- Type:
SAMPluginStaticSpec
- SAMPlugin.status
Plugin.status[obj]: Optional, Read-only. Stateful status information about the Plugin.
- Type:
SAMPluginCommonStatus | null
- class SAMPrompt()
Smarter API Manifest - Prompt.
- SAMPrompt.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMPrompt.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMPrompt.metadata
- Type:
SAMPromptMetadata
- SAMPrompt.spec
- Type:
SAMPromptSpecConfig
- SAMPrompt.status
Prompt.status[obj]: Optional, Read-only. Stateful status information about the Prompt.
- Type:
SAMPromptStatus | null
- class SAMProvider()
Smarter API Manifest - Account
- SAMProvider.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMProvider.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMProvider.metadata
- Type:
SAMProviderMetadata
- SAMProvider.spec
- Type:
SAMProviderSpec
- SAMProvider.status
Provider.status[obj]: Optional, Read-only. Stateful status information about the Provider.
- Type:
SAMProviderStatus | null
- class SAMProxy()
Smarter API Manifest - Proxy.
- SAMProxy.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMProxy.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMProxy.metadata
- Type:
SAMProxyMetadata
- SAMProxy.spec
- Type:
SAMProxySpec
- SAMProxy.status
Proxy.status[obj]: Optional, Read-only. Stateful status information about the Proxy.
- Type:
SAMProxyStatus | null
- class SAMSecret()
Smarter API Manifest - Secret
- SAMSecret.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMSecret.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMSecret.metadata
- Type:
SAMSecretMetadata
- SAMSecret.spec
- Type:
SAMSecretSpec
- SAMSecret.status
Secret.status[obj]: Optional, Read-only. Stateful status information about the Secret.
- Type:
SAMSecretStatus | null
- class SAMSkillPlugin()
Smarter API Manifest - Skill Connection Model.
- SAMSkillPlugin.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMSkillPlugin.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMSkillPlugin.metadata
- Type:
SAMPluginCommonMetadata
- SAMSkillPlugin.spec
- Type:
SAMSkillPluginSpec
- SAMSkillPlugin.status
Plugin.status[obj]: Optional, Read-only. Stateful status information about the Plugin.
- Type:
SAMPluginCommonStatus | null
- class SAMSmarterAuthToken()
Smarter API Manifest - SmarterAuthToken
- SAMSmarterAuthToken.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMSmarterAuthToken.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMSmarterAuthToken.metadata
- Type:
SAMSmarterAuthTokenMetadata
- SAMSmarterAuthToken.spec
- Type:
SAMSmarterAuthTokenSpec
- SAMSmarterAuthToken.status
SmarterAuthToken.status[obj]: Optional, Read-only. Stateful status information about the SmarterAuthToken.
- Type:
SAMSmarterAuthTokenStatus | null
- class SAMSqlConnection()
Smarter API Manifest - SqlConnection Model
- SAMSqlConnection.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMSqlConnection.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMSqlConnection.metadata
- Type:
SAMConnectionCommonMetadata
- SAMSqlConnection.spec
- Type:
SAMSqlConnectionSpec
- SAMSqlConnection.status
SqlConnection.status[obj]: Optional, Read-only. Stateful status information about the SqlConnection.
- Type:
SAMConnectionCommonStatus | null
- class SAMSqlPlugin()
Smarter API Manifest - Sql Connection Model
- SAMSqlPlugin.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMSqlPlugin.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMSqlPlugin.metadata
- Type:
SAMPluginCommonMetadata
- SAMSqlPlugin.spec
- Type:
SAMSqlPluginSpec
- SAMSqlPlugin.status
Plugin.status[obj]: Optional, Read-only. Stateful status information about the Plugin.
- Type:
SAMPluginCommonStatus | null
- class SAMUser()
Smarter API Manifest - User
- SAMUser.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMUser.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMUser.metadata
- Type:
SAMUserMetadata
- SAMUser.spec
- Type:
SAMUserSpec
- SAMUser.status
User.status[obj]: Optional, Read-only. Stateful status information about the User.
- Type:
SAMUserStatus | null
- class SAMVectorsearch()
Smarter API Manifest - Vectorsearch.
- SAMVectorsearch.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMVectorsearch.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMVectorsearch.metadata
- Type:
SAMVectorsearchMetadata
- SAMVectorsearch.spec
- Type:
SAMVectorsearchSpec
- SAMVectorsearch.status
Vectorsearch.status[obj]: Optional, Read-only. Stateful status information about the Vectorsearch.
- Type:
SAMVectorsearchStatus | null
- class SAMVectorstore()
Smarter API Manifest - Vectorstore.
- SAMVectorstore.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMVectorstore.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMVectorstore.metadata
- Type:
SAMVectorstoreMetadata
- SAMVectorstore.spec
- Type:
SAMVectorstoreSpec
- SAMVectorstore.status
Vectorstore.status[obj]: Optional, Read-only. Stateful status information about the Vectorstore.
- Type:
SAMVectorstoreStatus | null
- class SAMWebsearchPlugin()
Smarter API Manifest - WebsearchPlugin Model.
- SAMWebsearchPlugin.apiVersion
apiVersion[String]: Required. The API version of the AbstractSAMBase.
- Type:
string
- SAMWebsearchPlugin.kind
kind[String]: Required. The kind of resource described by the manifest.
- Type:
string
- SAMWebsearchPlugin.metadata
- Type:
SAMPluginCommonMetadata
- SAMWebsearchPlugin.spec
- Type:
SAMWebsearchPluginSpec
- SAMWebsearchPlugin.status
Plugin.status[obj]: Optional, Read-only. Stateful status information about the Plugin.
- Type:
SAMPluginCommonStatus | null
- SAMKind
A manifest kind that the SDK has a type of.
- Type:
unknown