Skip to content

Commit f5fbbef

Browse files
authored
Update README.md
1 parent 238d8f9 commit f5fbbef

File tree

1 file changed

+59
-5
lines changed

1 file changed

+59
-5
lines changed

README.md

Lines changed: 59 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -80,10 +80,6 @@ This example illustrates how a Weather Agent can be modeled using a Thing Descri
8080
"ex:name": "WeatherAI Inc.",
8181
"ex:url": "https://weatherai.example.com"
8282
},
83-
"ex:model": {
84-
"ex:name": "gpt-4o",
85-
"ex:provider": "Azure"
86-
},
8783
"ex:serviceIntegration": {
8884
"ex:weatherAPI": "OpenWeatherMap",
8985
"ex:apiVersion": "v2.5",
@@ -108,6 +104,36 @@ This example illustrates how a Weather Agent can be modeled using a Thing Descri
108104
}
109105
},
110106
"security": "basic_sc",
107+
"properties": {
108+
"modelConfiguration": {
109+
"description": "Current configuration of the underlying LLM, including version, temperature, and maximum tokens.",
110+
"type": "object",
111+
"readOnly": true,
112+
"properties": {
113+
"modelName": {
114+
"type": "string",
115+
"description": "Name of the model in use, e.g., gpt-4o."
116+
},
117+
"temperature": {
118+
"type": "number",
119+
"description": "Temperature setting for controlling response randomness.",
120+
"minimum": 0,
121+
"maximum": 1
122+
},
123+
"maxTokens": {
124+
"type": "integer",
125+
"description": "Maximum number of tokens the model is allowed to generate."
126+
}
127+
},
128+
"forms": [
129+
{
130+
"op": "readproperty",
131+
"href": "https://weatherai.example.com/things/urn:uuid:6f1d3a7a-1f97-4e6b-b45f-f3c2e1c84c77/properties/modelConfiguration",
132+
"contentType": "application/json"
133+
}
134+
]
135+
}
136+
},
111137
"actions": {
112138
"getWeather": {
113139
"description": "Fetches weather information based on user input.",
@@ -134,12 +160,40 @@ This example illustrates how a Weather Agent can be modeled using a Thing Descri
134160
"forms": [
135161
{
136162
"op": "invokeaction",
137-
"href": "https://weatherai.example.com/weather",
163+
"href": "https://weatherai.example.com/things/urn:uuid:6f1d3a7a-1f97-4e6b-b45f-f3c2e1c84c77/actions/getWeather",
138164
"contentType": "application/json",
139165
"htv:methodName":"POST"
140166
}
141167
]
142168
}
169+
},
170+
"events": {
171+
"userFeedbackReceived": {
172+
"description": "Emitted when a user provides feedback on the service, with a rating from 1 to 5.",
173+
"data": {
174+
"type": "object",
175+
"properties": {
176+
"rating": {
177+
"type": "integer",
178+
"description": "User rating, where 1 is the lowest and 5 is the highest.",
179+
"minimum": 1,
180+
"maximum": 5
181+
},
182+
"comment": {
183+
"type": "string",
184+
"description": "Optional user comment providing additional feedback."
185+
}
186+
},
187+
"required": ["rating"]
188+
},
189+
"forms": [
190+
{
191+
"op": "subscribeevent",
192+
"href": "https://weatherai.example.com/things/urn:uuid:6f1d3a7a-1f97-4e6b-b45f-f3c2e1c84c77/events/userFeedbackReceived",
193+
"contentType": "application/json"
194+
}
195+
]
196+
}
143197
}
144198
}
145199
```

0 commit comments

Comments
 (0)