neuralseekui 1.0.0

package/docs/GovernanceApi.md

@@ -0,0 +1,410 @@
+# NeuralSeekUi.GovernanceApi
+
+All URIs are relative to *https://console.neuralseek.com/{instance}*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**aiPricing**](GovernanceApi.md#aiPricing) | **POST** /aiPricing | AI Pricing
+[**gomaistro**](GovernanceApi.md#gomaistro) | **POST** /gomaistro | Governance - mAIstro Usage
+[**gomaistrotokens**](GovernanceApi.md#gomaistrotokens) | **POST** /gomaistrotokens | Governance - mAIstro Token Usage
+[**gotokens**](GovernanceApi.md#gotokens) | **POST** /gotokens | Governance - Token Usage
+[**governanceDocumentationDetails**](GovernanceApi.md#governanceDocumentationDetails) | **POST** /godocument | Governance - Documentation Details
+[**governanceOverview**](GovernanceApi.md#governanceOverview) | **POST** /goover | Governance Overview
+[**governancePerformanceDetails**](GovernanceApi.md#governancePerformanceDetails) | **POST** /goperf | Governance - Performance Details
+[**governanceSemanticDetails**](GovernanceApi.md#governanceSemanticDetails) | **POST** /gosemantic | Governance - Semantic Details
+
+<a name="aiPricing"></a>
+# **aiPricing**
+> aiPricing()
+
+AI Pricing
+
+Retrieve AI pricing metadata
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.ApiClient.instance;
+
+// Configure API key authorization: apiKey
+let apiKey = defaultClient.authentications['apiKey'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+let apiInstance = new NeuralSeekUi.GovernanceApi();
+apiInstance.aiPricing((error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+This endpoint does not need any parameter.
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: Not defined
+
+<a name="gomaistro"></a>
+# **gomaistro**
+> gomaistro(body)
+
+Governance - mAIstro Usage
+
+mAIstro usage details
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.ApiClient.instance;
+
+// Configure API key authorization: apiKey
+let apiKey = defaultClient.authentications['apiKey'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+let apiInstance = new NeuralSeekUi.GovernanceApi();
+let body = new NeuralSeekUi.GomaistroBody(); // GomaistroBody | 
+
+apiInstance.gomaistro(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**GomaistroBody**](GomaistroBody.md)|  | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+<a name="gomaistrotokens"></a>
+# **gomaistrotokens**
+> gomaistrotokens(body)
+
+Governance - mAIstro Token Usage
+
+mAIstro token usage details
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.ApiClient.instance;
+
+// Configure API key authorization: apiKey
+let apiKey = defaultClient.authentications['apiKey'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+let apiInstance = new NeuralSeekUi.GovernanceApi();
+let body = new NeuralSeekUi.GomaistrotokensBody(); // GomaistrotokensBody | 
+
+apiInstance.gomaistrotokens(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**GomaistrotokensBody**](GomaistrotokensBody.md)|  | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+<a name="gotokens"></a>
+# **gotokens**
+> gotokens(body)
+
+Governance - Token Usage
+
+Token usage details (BYOLLM plans)
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.ApiClient.instance;
+
+// Configure API key authorization: apiKey
+let apiKey = defaultClient.authentications['apiKey'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+let apiInstance = new NeuralSeekUi.GovernanceApi();
+let body = new NeuralSeekUi.GotokensBody(); // GotokensBody | 
+
+apiInstance.gotokens(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**GotokensBody**](GotokensBody.md)|  | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+<a name="governanceDocumentationDetails"></a>
+# **governanceDocumentationDetails**
+> governanceDocumentationDetails(body)
+
+Governance - Documentation Details
+
+Governance - Documentation Details
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.ApiClient.instance;
+
+// Configure API key authorization: apiKey
+let apiKey = defaultClient.authentications['apiKey'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+let apiInstance = new NeuralSeekUi.GovernanceApi();
+let body = new NeuralSeekUi.GodocumentBody(); // GodocumentBody | 
+
+apiInstance.governanceDocumentationDetails(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**GodocumentBody**](GodocumentBody.md)|  | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+<a name="governanceOverview"></a>
+# **governanceOverview**
+> governanceOverview(body)
+
+Governance Overview
+
+Governance Overview
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.ApiClient.instance;
+
+// Configure API key authorization: apiKey
+let apiKey = defaultClient.authentications['apiKey'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+let apiInstance = new NeuralSeekUi.GovernanceApi();
+let body = new NeuralSeekUi.GooverBody(); // GooverBody | 
+
+apiInstance.governanceOverview(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**GooverBody**](GooverBody.md)|  | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+<a name="governancePerformanceDetails"></a>
+# **governancePerformanceDetails**
+> governancePerformanceDetails(body)
+
+Governance - Performance Details
+
+Governance - Performance Details
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.ApiClient.instance;
+
+// Configure API key authorization: apiKey
+let apiKey = defaultClient.authentications['apiKey'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+let apiInstance = new NeuralSeekUi.GovernanceApi();
+let body = new NeuralSeekUi.GoperfBody(); // GoperfBody | 
+
+apiInstance.governancePerformanceDetails(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**GoperfBody**](GoperfBody.md)|  | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+
+<a name="governanceSemanticDetails"></a>
+# **governanceSemanticDetails**
+> governanceSemanticDetails(body)
+
+Governance - Semantic Details
+
+Governance - Semantic Details
+
+### Example
+```javascript
+import {NeuralSeekUi} from 'neuralSeekUI';
+let defaultClient = NeuralSeekUi.ApiClient.instance;
+
+// Configure API key authorization: apiKey
+let apiKey = defaultClient.authentications['apiKey'];
+apiKey.apiKey = 'YOUR API KEY';
+// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
+//apiKey.apiKeyPrefix = 'Token';
+
+let apiInstance = new NeuralSeekUi.GovernanceApi();
+let body = new NeuralSeekUi.GosemanticBody(); // GosemanticBody | 
+
+apiInstance.governanceSemanticDetails(body, (error, data, response) => {
+  if (error) {
+    console.error(error);
+  } else {
+    console.log('API called successfully.');
+  }
+});
+```
+
+### Parameters
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **body** | [**GosemanticBody**](GosemanticBody.md)|  | 
+
+### Return type
+
+null (empty response body)
+
+### Authorization
+
+[apiKey](../README.md#apiKey)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: Not defined
+