Conversational Language Understanding API 2021-11-01-preview

This AnalyzeConversations API accepts a request and mediates among multiple Arbitration projects, such as LUIS Generally Available, Question Answering, CLU, and then calls the best candidate service to handle the request. At last, it returns a response with the candidate service's response as a payload. If the requested project is a CLU project, the runtime forwards the request and response without arbitration.

Analyze_Conversations

Analyzes the input conversation.

Select the testing console in the region where you created your resource:

Open API testing console

Request URL

Request parameters

string
string

Request headers

string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Post body of the request.

{
  "query": "string",
  "directTarget": "string",
  "language": "string",
  "verbose": true,
  "isLoggingEnabled": true,
  "parameters": {}
}
{
  "type": "object",
  "description": "The request body.",
  "properties": {
    "parameters": {
      "type": "object",
      "description": "A dictionary representing the input for each target project.",
      "additionalProperties": {
        "type": "object",
        "description": "This is the parameter set of either the Orchestration project itself or one of the target services.",
        "properties": {
          "apiVersion": {
            "type": "string",
            "description": "The API version to use when call a specific target service."
          },
          "targetKind": {
            "type": "string",
            "description": "The type of a target service.",
            "enum": [
              "luis",
              "conversation",
              "question_answering",
              "non_linked"
            ],
            "x-ms-enum": {
              "modelAsString": true,
              "name": "targetKind"
            }
          }
        },
        "required": [
          "targetKind"
        ],
        "discriminator": "targetKind"
      }
    },
    "query": {
      "type": "string",
      "description": "The conversation utterance to be analyzed."
    },
    "language": {
      "type": "string",
      "description": "The language to use in this request. This will be the language setting when communicating with all other target projects."
    },
    "directTarget": {
      "type": "string",
      "description": "The name of the target project this request is sending to directly."
    },
    "verbose": {
      "type": "boolean",
      "description": "If true, the service will return more detailed information in the response."
    },
    "isLoggingEnabled": {
      "type": "boolean",
      "description": "If true, the query will be kept by the service for customers to further review, to improve the model quality."
    }
  },
  "required": [
    "query"
  ]
}

Response 200

The conversation analysis response.

{
  "query": "string",
  "prediction": {
    "topIntent": "string",
    "projectKind": "string",
    "intents": {}
  }
}
{
  "type": "object",
  "description": "This is the base class of prediction",
  "properties": {
    "projectKind": {
      "type": "string",
      "description": "The type of the project.",
      "enum": [
        "conversation",
        "workflow"
      ],
      "x-ms-enum": {
        "modelAsString": true,
        "name": "projectKind"
      }
    },
    "topIntent": {
      "type": "string",
      "description": "The intent with the highest score."
    }
  },
  "required": [
    "projectKind"
  ],
  "discriminator": "projectKind"
}

Response 500

One or more errors occurred. Corresponding activity ID: .

Response 400

The requested project or deployment is not found.

Response 401

Access denied due to invalid subscription key. Make sure you are subscribed to an API you are trying to call and provide the right key.

Response 403

You do not have permissions to view the requested resource.

Response 404

The requested project or deployment is not found.

Response 503

Service Unavailable

Code samples

@ECHO OFF

curl -v -X POST "https://switzerlandwest.api.cognitive.microsoft.com/language/:analyze-conversations?api-version=2021-11-01-preview?projectName={string}&deploymentName={string}"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["projectName"] = "{string}";
            queryString["deploymentName"] = "{string}";
            var uri = "https://switzerlandwest.api.cognitive.microsoft.com/language/:analyze-conversations?api-version=2021-11-01-preview&" + queryString;

            HttpResponseMessage response;

            // Request body
            byte[] byteData = Encoding.UTF8.GetBytes("{body}");

            using (var content = new ByteArrayContent(byteData))
            {
               content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
               response = await client.PostAsync(uri, content);
            }

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://switzerlandwest.api.cognitive.microsoft.com/language/:analyze-conversations?api-version=2021-11-01-preview");

            builder.setParameter("projectName", "{string}");
            builder.setParameter("deploymentName", "{string}");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "projectName": "{string}",
            "deploymentName": "{string}",
        };
      
        $.ajax({
            url: "https://switzerlandwest.api.cognitive.microsoft.com/language/:analyze-conversations?api-version=2021-11-01-preview&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "POST",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://switzerlandwest.api.cognitive.microsoft.com/language/:analyze-conversations?api-version=2021-11-01-preview";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"projectName={string}",
                         @"deploymentName={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"POST"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://switzerlandwest.api.cognitive.microsoft.com/language/:analyze-conversations?api-version=2021-11-01-preview');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'projectName' => '{string}',
    'deploymentName' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_POST);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'projectName': '{string}',
    'deploymentName': '{string}',
})

try:
    conn = httplib.HTTPSConnection('switzerlandwest.api.cognitive.microsoft.com')
    conn.request("POST", "/language/:analyze-conversations?api-version=2021-11-01-preview&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'projectName': '{string}',
    'deploymentName': '{string}',
})

try:
    conn = http.client.HTTPSConnection('switzerlandwest.api.cognitive.microsoft.com')
    conn.request("POST", "/language/:analyze-conversations?api-version=2021-11-01-preview&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://switzerlandwest.api.cognitive.microsoft.com/language/:analyze-conversations?api-version=2021-11-01-preview')

query = URI.encode_www_form({
    # Request parameters
    'projectName' => '{string}',
    'deploymentName' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body