POST api/internalai/chat-structured

Request Information

URI Parameters

None.

Body Parameters

WorkPoint.AI.Models.ChatStructuredRequestDto
NameDescriptionTypeAdditional information
systemMessage

string

None.

jsonSchema

Object

None.

userInput

Object

None.

chatId

string

None.

history

Collection of WorkPoint365.WebAPI.Model.ChatHistoryMessage

None.

historyMode

WorkPoint365.WebAPI.Model.HistoryMode

None.

connection

WorkPoint365.WebAPI.Model.ChatRequestConnection

None.

Request Formats

application/json, text/json

Sample:
{
  "systemMessage": "sample string 1",
  "jsonSchema": {},
  "userInput": {},
  "chatId": "sample string 4",
  "history": [
    {
      "role": "sample string 1",
      "content": "sample string 2"
    },
    {
      "role": "sample string 1",
      "content": "sample string 2"
    }
  ],
  "historyMode": 0,
  "connection": {
    "Endpoint": "sample string 1",
    "Deployment": "sample string 2",
    "Key": "sample string 3",
    "Id": "sample string 4",
    "Title": "sample string 5",
    "ApiVersion": "sample string 6"
  }
}

application/xml, text/xml

Sample:
<ChatStructuredRequestDto xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/WorkPoint.AI.Models">
  <ChatId>sample string 4</ChatId>
  <Connection xmlns:d2p1="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
    <d2p1:ApiVersion>sample string 6</d2p1:ApiVersion>
    <d2p1:Deployment>sample string 2</d2p1:Deployment>
    <d2p1:Endpoint>sample string 1</d2p1:Endpoint>
    <d2p1:Id>sample string 4</d2p1:Id>
    <d2p1:Key>sample string 3</d2p1:Key>
    <d2p1:Title>sample string 5</d2p1:Title>
  </Connection>
  <History xmlns:d2p1="http://schemas.datacontract.org/2004/07/WorkPoint365.WebAPI.Model">
    <d2p1:ChatHistoryMessage>
      <d2p1:Content>sample string 2</d2p1:Content>
      <d2p1:Role>sample string 1</d2p1:Role>
    </d2p1:ChatHistoryMessage>
    <d2p1:ChatHistoryMessage>
      <d2p1:Content>sample string 2</d2p1:Content>
      <d2p1:Role>sample string 1</d2p1:Role>
    </d2p1:ChatHistoryMessage>
  </History>
  <HistoryMode>None</HistoryMode>
  <JsonSchema />
  <SystemMessage>sample string 1</SystemMessage>
  <UserInput />
</ChatStructuredRequestDto>

Response Information

Resource Description

System.Web.Http.IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.