Class: Azure::CognitiveServices::LuisAuthoring::V2_0::LuisAuthoringClient

Inherits:
MsRestAzure::AzureServiceClient
  • Object
show all
Includes:
MsRestAzure, MsRestAzure::Serialization
Defined in:
lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb

Overview

A service client - single point of access to the REST API.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(credentials = nil, options = nil) ⇒ LuisAuthoringClient

Creates initializes a new instance of the LuisAuthoringClient class.

Parameters:

  • credentials (MsRest::ServiceClientCredentials) (defaults to: nil) —

    credentials to authorize HTTP requests made by the service client.

  • options (Array) (defaults to: nil) —

    filters to be applied to the HTTP requests.



75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 75

def initialize(credentials = nil, options = nil)
  super(credentials, options)
  @base_url = '{Endpoint}/luis/api/v2.0'

  fail ArgumentError, 'invalid type of credentials input parameter' unless credentials.is_a?(MsRest::ServiceClientCredentials) unless credentials.nil?
  @credentials = credentials

  @features = Features.new(self)
  @examples = Examples.new(self)
  @model = Model.new(self)
  @apps = Apps.new(self)
  @versions = Versions.new(self)
  @train = Train.new(self)
  @permissions = Permissions.new(self)
  @pattern = Pattern.new(self)
  @settings = Settings.new(self)
  @azure_accounts = AzureAccounts.new(self)
  @accept_language = 'en-US'
  @long_running_operation_retry_timeout = 30
  @generate_client_request_id = true
  add_telemetry
end

Instance Attribute Details

#accept_language ⇒ String

Returns The preferred language for the response.

Returns:

  • (String) —

    The preferred language for the response.



29
30
31
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 29

def accept_language
  @accept_language
end

#apps ⇒ Apps (readonly)

Returns apps.

Returns:



50
51
52
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 50

def apps
  @apps
end

#azure_accounts ⇒ AzureAccounts (readonly)

Returns azure_accounts.

Returns:



68
69
70
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 68

def azure_accounts
  @azure_accounts
end

#base_url ⇒ String (readonly)

Returns the base URI of the service.

Returns:

  • (String) —

    the base URI of the service.



15
16
17
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 15

def base_url
  @base_url
end

#credentials ⇒ Object

subscription.

Returns:

  • Subscription credentials which uniquely identify client



26
27
28
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 26

def credentials
  @credentials
end

#credentials1 ⇒ Object (readonly)

Returns Credentials needed for the client to connect to Azure.

Returns:

  • Credentials needed for the client to connect to Azure.



18
19
20
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 18

def credentials1
  @credentials1
end

#endpoint ⇒ String

hostname, for example: westus.api.cognitive.microsoft.com).

Returns:

  • (String) —

    Supported Cognitive Services endpoints (protocol and



22
23
24
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 22

def endpoint
  @endpoint
end

#examples ⇒ Examples (readonly)

Returns examples.

Returns:



44
45
46
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 44

def examples
  @examples
end

#features ⇒ Features (readonly)

Returns features.

Returns:



41
42
43
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 41

def features
  @features
end

#generate_client_request_id ⇒ Boolean

generated. When set to true a unique x-ms-client-request-id value is generated and included in each request. Default is true.

Returns:

  • (Boolean) —

    Whether a unique x-ms-client-request-id should be



38
39
40
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 38

def generate_client_request_id
  @generate_client_request_id
end

#long_running_operation_retry_timeout ⇒ Integer

Operations. Default value is 30.

Returns:

  • (Integer) —

    The retry timeout in seconds for Long Running



33
34
35
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 33

def long_running_operation_retry_timeout
  @long_running_operation_retry_timeout
end

#model ⇒ Model (readonly)

Returns model.

Returns:



47
48
49
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 47

def model
  @model
end

#pattern ⇒ Pattern (readonly)

Returns pattern.

Returns:



62
63
64
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 62

def pattern
  @pattern
end

#permissions ⇒ Permissions (readonly)

Returns permissions.

Returns:



59
60
61
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 59

def permissions
  @permissions
end

#settings ⇒ Settings (readonly)

Returns settings.

Returns:



65
66
67
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 65

def settings
  @settings
end

#train ⇒ Train (readonly)

Returns train.

Returns:



56
57
58
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 56

def train
  @train
end

#versions ⇒ Versions (readonly)

Returns versions.

Returns:



53
54
55
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 53

def versions
  @versions
end

Instance Method Details

#make_request(method, path, options = {}) ⇒ Hash{String=>String}

Makes a request and returns the body of the response. Example:

request_content = "{'location':'westus','tags':{'tag1':'val1','tag2':'val2'}}"
path = "/path"
options = {
  body: request_content,
  query_params: {'api-version' => '2016-02-01'}
}
result = @client.make_request(:put, path, options)

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (Hash{String=>String}) —

    containing the body of the response.



114
115
116
117
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 114

def make_request(method, path, options = {})
  result = make_request_with_http_info(method, path, options)
  result.body unless result.nil?
end

#make_request_async(method, path, options = {}) ⇒ Concurrent::Promise

Makes a request asynchronously.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (Concurrent::Promise) —

    Promise object which holds the HTTP response.



139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 139

def make_request_async(method, path, options = {})
  fail ArgumentError, 'method is nil' if method.nil?
  fail ArgumentError, 'path is nil' if path.nil?

  request_url = options[:base_url] || @base_url
  if(!options[:headers].nil? && !options[:headers]['Content-Type'].nil?)
    @request_headers['Content-Type'] = options[:headers]['Content-Type']
  end

  request_headers = @request_headers
  request_headers.merge!({'accept-language' => @accept_language}) unless @accept_language.nil?
  options.merge!({headers: request_headers.merge(options[:headers] || {})})
  options.merge!({credentials: @credentials}) unless @credentials.nil?

  super(request_url, method, path, options)
end

#make_request_with_http_info(method, path, options = {}) ⇒ MsRestAzure::AzureOperationResponse

Makes a request and returns the operation response.

Parameters:

  • method (Symbol) —

    with any of the following values :get, :put, :post, :patch, :delete.

  • path (String) —

    the path, relative to #base_url.

  • options (Hash{String=>String}) (defaults to: {}) —

    specifying any request options like :body.

Returns:

  • (MsRestAzure::AzureOperationResponse) —

    Operation response containing the request, response and status.



126
127
128
129
130
 
# File 'lib/2.0/generated/azure_cognitiveservices_luisauthoring/luis_authoring_client.rb', line 126

def make_request_with_http_info(method, path, options = {})
  result = make_request_async(method, path, options).value!
  result.body = result.response.body.to_s.empty? ? nil : JSON.load(result.response.body)
  result
end