Components
InsightToolDefinition
Introduction
Configuration & Settings
Insights & Analytics
Models
- Components
- Action
- Agent
- AgentCreate
- AgentLanguage
- AgentProperties
- AgentResponse
- AgentSttProvider
- AgentToolDefaults
- AgentToolFieldDefault
- AgentUpdate
- AgentUpdateVariables
- AgentVoice
- AgentVoiceDisplayName
- AgentVoiceGender
- AgentVoiceModel
- AgentVoiceVarName
- AgentWaitSound
- ArgumentLocation
- Attributes
- AvailableTarget
- AvailableTargetProperties
- BodyDirectoryMemberBulkLoad
- Channel
- ChannelProperties
- ChannelServices
- ChannelTarget
- ChannelTargetCreateRequest
- ChannelTargetProperties
- ChannelTargetResponse
- ChannelTargetUpdateRequest
- Conditions
- ContactTags
- Conversation
- ConversationProperties
- CustomMessage
- CustomMessageCreateRequest
- CustomMessageProperties
- CustomMessageResponse
- CustomMessageRule
- CustomMessageUpdateRequest
- DaoChannelTargetAgent
- DaoCustomMessageRule
- Dashboard
- DashboardProperties
- DashboardResponse
- DashboardTokenResponse
- DataSourceCreateRequest
- DataSourceDetailResponse
- DataSourceMetadataResponse
- DataSourceProperties
- DataSourceUpdateRequest
- DayOfWeek
- Defaults
- Definition
- DirectoryExtension
- DirectoryMember
- DirectoryMemberCreate
- DirectoryMemberCreateContactTags
- DirectoryMemberProperties
- Event
- EventProperties
- FileT
- FunctionT
- HttpEndpoint
- InsightToolDefinition
- InsightToolInput
- InsightToolInputToolArguments
- InsightToolOutput
- InsightToolProperties
- InsightWorkflowInput
- InsightWorkflowInputConditions
- InsightWorkflowOutput
- InsightWorkflowProperties
- InternalTool
- LanguageCode
- LanguageConfig
- LanguageGroupAgentInfo
- LanguageGroupCreateRequest
- LanguageGroupProperties
- LanguageGroupResponse
- LanguageGroupUpdateRequest
- ListResponseAgentResponse
- ListResponseAvailableTarget
- ListResponseChannel
- ListResponseChannelTarget
- ListResponseChannelTargetResponse
- ListResponseConversation
- ListResponseCustomMessageResponse
- ListResponseDashboardResponse
- ListResponseDataSourceMetadataResponse
- ListResponseDirectoryMember
- ListResponseEvent
- ListResponseInsightToolOutput
- ListResponseInsightWorkflowOutput
- ListResponseLanguageGroupResponse
- ListResponsePrompt
- ListResponsePromptResponse
- ListResponseService
- ListResponseServiceResponse
- ListResponseSession
- ListResponseSessionLabel
- ListResponseTool
- ListResponseToolResponse
- LlmConfig
- Loc
- Method
- Numbers
- One
- OrderByDirection
- ParametersT
- Prompt
- PromptCreate
- PromptCreateRequest
- PromptHistory
- PromptLlmConfig
- PromptLlmProvider
- PromptProperties
- PromptResponse
- PromptUpdate
- PromptUpdateRequest
- Provider
- Response
- Result
- SDKInternalTool
- SDKToolDefinition
- Security
- Service
- ServiceCreate
- ServiceCreateRequest
- ServiceProperties
- ServiceResponse
- ServiceUpdate
- ServiceUpdateRequest
- Session
- SessionAction
- SessionLabel
- SessionLabelCreate
- SessionLabelProperties
- SessionProperties
- SessionRecordingResponse
- SessionSummaryResponse
- SessionText
- SessionTranscriptionResponse
- StaticToolParameter
- StaticToolParameterType
- SttProvider
- Target
- TargetModes
- TestMessage
- TestMessageResponse
- Tool
- ToolAgentInfo
- ToolArgumentLocation
- ToolArguments
- ToolCreate
- ToolCreateDefinition
- ToolCreateRequest
- ToolDefinition
- ToolDetailResponse
- ToolFunction
- ToolHttpEndpoint
- ToolHttpMethod
- ToolParameterDefault
- ToolParameters
- ToolParameterTransform
- ToolParameterTransformCondition
- ToolPromptInfo
- ToolProperties
- ToolResponse
- ToolResultSet
- ToolUpdate
- ToolUpdateDefinition
- ToolUpdateRequest
- TtsProvider
- Type
- ValidationError
- Variables
- Operations
- Errors
Components
InsightToolDefinition
Example Usage
import { InsightToolDefinition } from "syllable-sdk/models/components";
let value: InsightToolDefinition = {
id: 618826,
name: "<value>",
type: "<value>",
description: "svelte ah hunt until",
toolParameters: {},
toolResultSet: {},
};
Fields
Field | Type | Required | Description |
---|---|---|---|
id | number | TRUE | Unique ID for Insight Tool Definition |
name | string | TRUE | Human readable name of Insight Tool Definition |
type | string | TRUE | Type of Insight Tool Definition |
description | string | TRUE | Text description of Insight Tool Definition |
toolParameters | components.ToolParameters | TRUE | Parameters for Insight Tool Definition |
toolResultSet | components.ToolResultSet | TRUE | Result key/types for Insight Tool Definition |
On this page