Skip to content

Commit ef2ebce

Browse files
elliot-huffmanelliot-huffman
committed
Remove Chat Tenant Route
Since LicenseGPT now has access to all tenants by default, no more need to have a tenant specific chat route. Update description of existing route to match the new behavior. Update SDG spec version to match the new SDG version.
1 parent 120c3df commit ef2ebce

File tree

1 file changed

+2
-232
lines changed

1 file changed

+2
-232
lines changed

‎specs/Data-Gateway.json‎

Lines changed: 2 additions & 232 deletions
Original file line numberDiff line numberDiff line change
@@ -2323,7 +2323,7 @@
23232323
},
23242324
"description": "Collects data from the various SHI Lab products and makes it available in a standardized way.",
23252325
"title": "SHI - Data Gateway",
2326-
"version": "3.0.0"
2326+
"version": "3.1.0"
23272327
},
23282328
"openapi": "3.1.1",
23292329
"paths": {
@@ -3688,7 +3688,7 @@
36883688
"/Api/Chat/LicenseGpt": {
36893689
"post": {
36903690
"summary": "Inquire License Data from AI Agent",
3691-
"description": "Enables a conversation mode with AI agent to request details of the available license reports for the currently authenticated tenant.\n\nThis endpoint requires the `LicenseReport.Read`, `LicenseReport.ReadWrite`, `LicenseReport.Read.All`, or `LicenseReport.ReadWrite.All` scope (permission). This endpoint is also only accessible from the `SHI` and `SHI Lab` tenants. End user access is restricted.",
3691+
"description": "Process OpenAI GPT chat messages with tool calls available. Chats are not stored on data gateway, API client is expected to store chats. Available tools is dynamically determined by assigned API permissions. This endpoint is also only accessible from the `SHI` and `SHI Lab` tenants. End user access is restricted.",
36923692
"operationId": "/Api/Chat/LicenseGpt/Post",
36933693
"requestBody": {
36943694
"content": {
@@ -3890,236 +3890,6 @@
38903890
]
38913891
}
38923892
},
3893-
"/Api/Chat/LicenseGpt/Tenant/{tenantId}": {
3894-
"post": {
3895-
"summary": "Inquire License Data from AI Agent",
3896-
"description": "Enables a conversation mode with AI agent to request details of the available license reports for the specified tenant.\n\nThis endpoint requires the `LicenseReport.Read.All`, or `LicenseReport.ReadWrite.All` scope (permission). This endpoint is also only accessible from the `SHI` and `SHI Lab` tenants. End user access is restricted.",
3897-
"operationId": "/Api/Chat/LicenseGpt/Tenant/:tenantId/Post",
3898-
"parameters": [
3899-
{
3900-
"$ref": "#/components/parameters/tenantId"
3901-
}
3902-
],
3903-
"requestBody": {
3904-
"content": {
3905-
"application/json": {
3906-
"schema": {
3907-
"description": "Collection of conversation parts provided by user to be ingested by the agent",
3908-
"type": "array",
3909-
"items": {
3910-
"$ref": "#/components/schemas/Chat.OpenAIChatMessage"
3911-
},
3912-
"examples": [
3913-
[
3914-
{
3915-
"role": "assistant",
3916-
"content": "What are the available IDs?",
3917-
"tool_calls": [
3918-
{
3919-
"id": "call_abc123",
3920-
"type": "function",
3921-
"function": {
3922-
"arguments": "{\"startDate\":\"2025-07-01\",\"endDate\":\"2025-07-10\"}",
3923-
"name": "getCorrelationIDs"
3924-
}
3925-
}
3926-
]
3927-
}
3928-
]
3929-
]
3930-
},
3931-
"examples": {
3932-
"Chat request": {
3933-
"summary": "Example Chat Request",
3934-
"description": "An example request that represent a message initiated by the chat assistant to call a tool function for the specified tenant.",
3935-
"value": [
3936-
{
3937-
"role": "assistant",
3938-
"content": "What are the available IDs?",
3939-
"tool_calls": [
3940-
{
3941-
"id": "call_abc123",
3942-
"type": "function",
3943-
"function": {
3944-
"arguments": "{\"startDate\":\"2025-07-01\",\"endDate\":\"2025-07-10\"}",
3945-
"name": "getCorrelationIDs"
3946-
}
3947-
}
3948-
]
3949-
}
3950-
]
3951-
}
3952-
}
3953-
}
3954-
}
3955-
},
3956-
"responses": {
3957-
"200": {
3958-
"content": {
3959-
"application/json": {
3960-
"schema": {
3961-
"examples": [
3962-
{
3963-
"messageList": [
3964-
{
3965-
"role": "user",
3966-
"content": "Hello"
3967-
},
3968-
{
3969-
"role": "assistant",
3970-
"content": "Hello, how can I assist you today?"
3971-
},
3972-
{
3973-
"role": "user",
3974-
"content": "Can you show me what correlation records I have?"
3975-
},
3976-
{
3977-
"role": "assistant",
3978-
"content": "What are the available IDs?",
3979-
"tool_calls": [
3980-
{
3981-
"id": "call_abc123",
3982-
"type": "function",
3983-
"function": {
3984-
"arguments": "{\"startDate\":\"2025-07-01\",\"endDate\":\"2025-07-10\"}",
3985-
"name": "getCorrelationIDs"
3986-
}
3987-
}
3988-
]
3989-
},
3990-
{
3991-
"role": "tool",
3992-
"content": "{\"825a9d7e-0b62-4392-b8ef-ab6951a46ebd\":\"2025-07-03T18:39:50.828Z\",\"744c0878-3a82-48a7-b239-a1d4b9298a69\":\"2025-07-07T21:01:20.995Z\"}",
3993-
"tool_call_id": "call_abc123"
3994-
},
3995-
{
3996-
"role": "assistant",
3997-
"content": "You have correlation records for the following dates:\n- July 3, 2025\n- July 7, 2025\n\nWould you like to see details from any of these correlation records?"
3998-
}
3999-
],
4000-
"responseText": "You have correlation records for the following dates:\n- July 3, 2025\n- July 7, 2025\n\nWould you like to see details from any of these correlation records?"
4001-
}
4002-
],
4003-
"type": "object",
4004-
"properties": {
4005-
"messageList": {
4006-
"type": "array",
4007-
"description": "List of message objects in current conversation",
4008-
"items": {
4009-
"$ref": "#/components/schemas/Chat.OpenAIChatMessage"
4010-
},
4011-
"examples": [
4012-
[
4013-
{
4014-
"role": "user",
4015-
"content": "Hello"
4016-
},
4017-
{
4018-
"role": "assistant",
4019-
"content": "Hello, how can I assist you today?"
4020-
},
4021-
{
4022-
"role": "user",
4023-
"content": "Can you show me what correlation records I have?"
4024-
},
4025-
{
4026-
"role": "assistant",
4027-
"content": "What are the available IDs?",
4028-
"tool_calls": [
4029-
{
4030-
"id": "call_abc123",
4031-
"type": "function",
4032-
"function": {
4033-
"arguments": "{\"startDate\":\"2025-07-01\",\"endDate\":\"2025-07-10\"}",
4034-
"name": "getCorrelationIDs"
4035-
}
4036-
}
4037-
]
4038-
},
4039-
{
4040-
"role": "tool",
4041-
"content": "{\"825a9d7e-0b62-4392-b8ef-ab6951a46ebd\":\"2025-07-03T18:39:50.828Z\",\"744c0878-3a82-48a7-b239-a1d4b9298a69\":\"2025-07-07T21:01:20.995Z\"}",
4042-
"tool_call_id": "call_abc123"
4043-
},
4044-
{
4045-
"role": "assistant",
4046-
"content": "You have correlation records for the following dates:\n- July 3, 2025\n- July 7, 2025\n\nWould you like to see details from any of these correlation records?"
4047-
}
4048-
]
4049-
]
4050-
},
4051-
"responseText": {
4052-
"type": "string",
4053-
"description": "Most recent response text",
4054-
"examples": [
4055-
"You have correlation records for the following dates:\n- July 3, 2025\n- July 7, 2025\n\nWould you like to see details from any of these correlation records?"
4056-
]
4057-
}
4058-
},
4059-
"required": [
4060-
"messageList",
4061-
"responseText"
4062-
]
4063-
},
4064-
"examples": {
4065-
"Chat response": {
4066-
"summary": "Example Chat Response",
4067-
"description": "An example chat response that includes context of current chat session with the request appended for the specified tenant.",
4068-
"value": {
4069-
"messageList": [
4070-
{
4071-
"role": "user",
4072-
"content": "Hello"
4073-
},
4074-
{
4075-
"role": "assistant",
4076-
"content": "Hello, how can I assist you today?"
4077-
},
4078-
{
4079-
"role": "user",
4080-
"content": "Can you show me what correlation records I have?"
4081-
},
4082-
{
4083-
"role": "assistant",
4084-
"content": "What are the available IDs?",
4085-
"tool_calls": [
4086-
{
4087-
"id": "call_abc123",
4088-
"type": "function",
4089-
"function": {
4090-
"arguments": "{\"startDate\":\"2025-07-01\",\"endDate\":\"2025-07-10\"}",
4091-
"name": "getCorrelationIDs"
4092-
}
4093-
}
4094-
]
4095-
},
4096-
{
4097-
"role": "tool",
4098-
"content": "{\"825a9d7e-0b62-4392-b8ef-ab6951a46ebd\":\"2025-07-03T18:39:50.828Z\",\"744c0878-3a82-48a7-b239-a1d4b9298a69\":\"2025-07-07T21:01:20.995Z\"}",
4099-
"tool_call_id": "call_abc123"
4100-
},
4101-
{
4102-
"role": "assistant",
4103-
"content": "You have correlation records for the following dates:\n- July 3, 2025\n- July 7, 2025\n\nWould you like to see details from any of these correlation records?"
4104-
}
4105-
],
4106-
"responseText": "You have correlation records for the following dates:\n- July 3, 2025\n- July 7, 2025\n\nWould you like to see details from any of these correlation records?"
4107-
}
4108-
}
4109-
}
4110-
}
4111-
},
4112-
"description": "OK"
4113-
},
4114-
"400": {
4115-
"$ref": "#/components/responses/400"
4116-
}
4117-
},
4118-
"tags": [
4119-
"Chat"
4120-
]
4121-
}
4122-
},
41233893
"/Api/Chat/UpdateDocs": {
41243894
"post": {
41253895
"description": "Sends a request to update the cached Data Gateway documentation if there is a newer version.\n\nThis endpoint requires the `LicenseGptCache.ReadWrite` scope (permission). This endpoint is also only accessible from the `SHI Lab` tenant. End user access is restricted.",

0 commit comments

Comments
 (0)