Skip to content

Class: ToolParameter

Configuration parameter for a tool

URI: revaise:ToolParameter

```mermaid classDiagram class ToolParameter click ToolParameter href "../ToolParameter/" ToolParameter : param_category

  ToolParameter : param_default

  ToolParameter : param_description

  ToolParameter : param_id

  ToolParameter : param_name

  ToolParameter : param_required

  ToolParameter : param_type





    ToolParameter --> "0..1" ParameterType : param_type
    click ParameterType href "../ParameterType/"



  ToolParameter : param_value

```

Slots

Name Cardinality and Range Description Inheritance
param_id 1
String
Unique identifier for the parameter direct
param_name 1
String
Name of the parameter direct
param_value 1
String
Value of the parameter direct
param_type 0..1
ParameterType
Data type of the parameter direct
param_category 0..1
String
Category of parameter (e direct
param_description 0..1
String
Description of what this parameter controls direct
param_default 0..1
String
Default value if not specified direct
param_required 0..1
Boolean
Whether this parameter is required direct

Usages

used by used in type used
ExternalTool tool_configuration_parameters range ToolParameter

Identifier and Mapping Information

Schema Source

  • from schema: https://open-and-sustainable.github.io/revaise-model/schema/objects/external_tool

Mappings

Mapping Type Mapped Value
self revaise:ToolParameter
native revaise:ToolParameter

LinkML Source

Direct

name: ToolParameter
description: Configuration parameter for a tool
from_schema: https://open-and-sustainable.github.io/revaise-model/schema/objects/external_tool
slots:
- param_id
- param_name
- param_value
- param_type
- param_category
- param_description
- param_default
- param_required
slot_usage:
  param_id:
    name: param_id
    description: Unique identifier for the parameter
    identifier: true
    range: string
  param_name:
    name: param_name
    description: Name of the parameter
    range: string
    required: true
  param_value:
    name: param_value
    description: Value of the parameter
    range: string
    required: true
  param_type:
    name: param_type
    description: Data type of the parameter
    range: ParameterType
  param_category:
    name: param_category
    description: Category of parameter (e.g., search, AI, export, filtering)
    range: string
  param_description:
    name: param_description
    description: Description of what this parameter controls
    range: string
  param_default:
    name: param_default
    description: Default value if not specified
    range: string
  param_required:
    name: param_required
    description: Whether this parameter is required
    range: boolean

Induced

name: ToolParameter
description: Configuration parameter for a tool
from_schema: https://open-and-sustainable.github.io/revaise-model/schema/objects/external_tool
slot_usage:
  param_id:
    name: param_id
    description: Unique identifier for the parameter
    identifier: true
    range: string
  param_name:
    name: param_name
    description: Name of the parameter
    range: string
    required: true
  param_value:
    name: param_value
    description: Value of the parameter
    range: string
    required: true
  param_type:
    name: param_type
    description: Data type of the parameter
    range: ParameterType
  param_category:
    name: param_category
    description: Category of parameter (e.g., search, AI, export, filtering)
    range: string
  param_description:
    name: param_description
    description: Description of what this parameter controls
    range: string
  param_default:
    name: param_default
    description: Default value if not specified
    range: string
  param_required:
    name: param_required
    description: Whether this parameter is required
    range: boolean
attributes:
  param_id:
    name: param_id
    description: Unique identifier for the parameter
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/objects/external_tool
    rank: 1000
    identifier: true
    owner: ToolParameter
    domain_of:
    - ToolParameter
    range: string
    required: true
  param_name:
    name: param_name
    description: Name of the parameter
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/objects/external_tool
    rank: 1000
    owner: ToolParameter
    domain_of:
    - ToolParameter
    range: string
    required: true
  param_value:
    name: param_value
    description: Value of the parameter
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/objects/external_tool
    rank: 1000
    owner: ToolParameter
    domain_of:
    - ToolParameter
    range: string
    required: true
  param_type:
    name: param_type
    description: Data type of the parameter
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/objects/external_tool
    rank: 1000
    owner: ToolParameter
    domain_of:
    - ToolParameter
    range: ParameterType
  param_category:
    name: param_category
    description: Category of parameter (e.g., search, AI, export, filtering)
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/objects/external_tool
    rank: 1000
    owner: ToolParameter
    domain_of:
    - ToolParameter
    range: string
  param_description:
    name: param_description
    description: Description of what this parameter controls
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/objects/external_tool
    rank: 1000
    owner: ToolParameter
    domain_of:
    - ToolParameter
    range: string
  param_default:
    name: param_default
    description: Default value if not specified
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/objects/external_tool
    rank: 1000
    owner: ToolParameter
    domain_of:
    - ToolParameter
    range: string
  param_required:
    name: param_required
    description: Whether this parameter is required
    from_schema: https://open-and-sustainable.github.io/revaise-model/schema/objects/external_tool
    rank: 1000
    owner: ToolParameter
    domain_of:
    - ToolParameter
    range: boolean