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