# OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi

All URIs are relative to */*

Method | HTTP request | Description
------------- | ------------- | -------------
[**computeSimilarsBatchedDeepWalkModel**](MlModelsApi.md#computeSimilarsBatchedDeepWalkModel) | **POST** /core/v1/deepWalkMlModels/x-model-name/computeSimilarsBatch | Compute similars according to a deepwalk model (batched variant)
[**computeSimilarsBatchedPg2vecModel**](MlModelsApi.md#computeSimilarsBatchedPg2vecModel) | **POST** /core/v1/pg2vecMlModels/x-model-name/computeSimilarsBatch | Compute similar graphlets according to a pg2vec model (batched variant)
[**computeSimilarsDeepWalkModelRequest**](MlModelsApi.md#computeSimilarsDeepWalkModelRequest) | **POST** /core/v1/deepWalkMlModels/x-model-name/computeSimilars | Compute similars according to a deepwalk model
[**computeSimilarsPg2vecModel**](MlModelsApi.md#computeSimilarsPg2vecModel) | **POST** /core/v1/pg2vecMlModels/x-model-name/computeSimilars | Compute similars graphlets according to a pg2vec model
[**createDeepWalkModel**](MlModelsApi.md#createDeepWalkModel) | **POST** /core/v1/deepWalkMlModels | Create a DeepWalk model
[**createPg2vecModel**](MlModelsApi.md#createPg2vecModel) | **POST** /core/v1/pg2vecMlModels | Create a Pg2vec model
[**createSupervisedGraphWiseModel**](MlModelsApi.md#createSupervisedGraphWiseModel) | **POST** /core/v1/graphWiseMlModels | Create a Supervised GraphWise model
[**createUnsupervisedGraphWiseModel**](MlModelsApi.md#createUnsupervisedGraphWiseModel) | **POST** /core/v1/unsupervisedGraphWiseMlModels | Create a Unsupervised GraphWise model
[**destroyMlModel**](MlModelsApi.md#destroyMlModel) | **DELETE** /core/v1/mlModels/x-model-name | Delete an MlModel
[**explainGraphWiseModel**](MlModelsApi.md#explainGraphWiseModel) | **POST** /core/v1/graphWiseMlModels/x-model-name/explain | Infer and explain with a GraphWise model
[**fitDeepWalkModel**](MlModelsApi.md#fitDeepWalkModel) | **POST** /core/v1/deepWalkMlModels/x-model-name/fit | Train a DeepWalkModel
[**fitPg2vecModel**](MlModelsApi.md#fitPg2vecModel) | **POST** /core/v1/pg2vecMlModels/x-model-name/fit | Train a Pg2vecModel
[**fitSupervisedGraphWiseModel**](MlModelsApi.md#fitSupervisedGraphWiseModel) | **POST** /core/v1/graphWiseMlModels/x-model-name/fit | Train a SupervisedGraphWise model
[**fitUnsupervisedGraphWiseModel**](MlModelsApi.md#fitUnsupervisedGraphWiseModel) | **POST** /core/v1/unsupervisedGraphWiseMlModels/x-model-name/fit | Train a UnsupervisedGraphWise model
[**getTrainedGraphletVectorsPg2vecModel**](MlModelsApi.md#getTrainedGraphletVectorsPg2vecModel) | **GET** /core/v1/pg2vecMlModels/x-model-name/trainedGraphletVectors | Fetch the graphlets vectors of a Pg2vecModel
[**getTrainedVertexVectorsDeepWalkModel**](MlModelsApi.md#getTrainedVertexVectorsDeepWalkModel) | **GET** /core/v1/deepWalkMlModels/x-model-name/trainedVertexVectors | Fetch the vertex vectors of a DeepWalkModel
[**inferGraphletPg2vecModel**](MlModelsApi.md#inferGraphletPg2vecModel) | **POST** /core/v1/pg2vecMlModels/x-model-name/infer | Infer with a Pg2vecModel
[**inferSupervisedGraphWiseModel**](MlModelsApi.md#inferSupervisedGraphWiseModel) | **POST** /core/v1/graphWiseMlModels/x-model-name/infer | Infer with a Supervised GraphWise model
[**inferUnsupervisedGraphWiseModel**](MlModelsApi.md#inferUnsupervisedGraphWiseModel) | **POST** /core/v1/unsupervisedGraphWiseMlModels/x-model-name/infer | Infer with a Unsupervised GraphWise model
[**loadModel**](MlModelsApi.md#loadModel) | **POST** /core/v1/loadModel | Load a ML model
[**storeModelWithConfig**](MlModelsApi.md#storeModelWithConfig) | **POST** /core/v1/mlModels/x-model-name/storeWithConfig | Store a model

<a name="computeSimilarsBatchedDeepWalkModel"></a>
# **computeSimilarsBatchedDeepWalkModel**
> FrameMetaData computeSimilarsBatchedDeepWalkModel(body, SID, xModelName)

Compute similars according to a deepwalk model (batched variant)

Compute similars according to a deepwalk model  (batched variant) in current session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.ComputeSimilarsBatchedMlModelRequest(); // ComputeSimilarsBatchedMlModelRequest | The request body defines the details to the compute similars request.
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the deepwalk model to use

apiInstance.computeSimilarsBatchedDeepWalkModel(body, SID, xModelName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ComputeSimilarsBatchedMlModelRequest**](ComputeSimilarsBatchedMlModelRequest.md)| The request body defines the details to the compute similars request. | 
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the deepwalk model to use | 

### Return type

[**FrameMetaData**](FrameMetaData.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="computeSimilarsBatchedPg2vecModel"></a>
# **computeSimilarsBatchedPg2vecModel**
> FrameMetaData computeSimilarsBatchedPg2vecModel(body, SID, xModelName)

Compute similar graphlets according to a pg2vec model (batched variant)

Compute similar graphlets according to a pg2vec model  (batched variant) in current session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.ComputeSimilarsBatchedMlModelRequest(); // ComputeSimilarsBatchedMlModelRequest | The request body defines the details to the compute similars request.
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the pg2vec model to use

apiInstance.computeSimilarsBatchedPg2vecModel(body, SID, xModelName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ComputeSimilarsBatchedMlModelRequest**](ComputeSimilarsBatchedMlModelRequest.md)| The request body defines the details to the compute similars request. | 
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the pg2vec model to use | 

### Return type

[**FrameMetaData**](FrameMetaData.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="computeSimilarsDeepWalkModelRequest"></a>
# **computeSimilarsDeepWalkModelRequest**
> FrameMetaData computeSimilarsDeepWalkModelRequest(body, SID, xModelName)

Compute similars according to a deepwalk model

Compute similars according to a deepwalk model in current session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.ComputeSimilarsMlModelRequest(); // ComputeSimilarsMlModelRequest | The request body defines the details to the compute similars request.
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the deepwalk model to use

apiInstance.computeSimilarsDeepWalkModelRequest(body, SID, xModelName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ComputeSimilarsMlModelRequest**](ComputeSimilarsMlModelRequest.md)| The request body defines the details to the compute similars request. | 
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the deepwalk model to use | 

### Return type

[**FrameMetaData**](FrameMetaData.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="computeSimilarsPg2vecModel"></a>
# **computeSimilarsPg2vecModel**
> FrameMetaData computeSimilarsPg2vecModel(body, SID, xModelName)

Compute similars graphlets according to a pg2vec model

Compute similars graphlets according to a pg2vec model in current session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.ComputeSimilarsMlModelRequest(); // ComputeSimilarsMlModelRequest | The request body defines the details to the compute similars request.
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the pg2vec model to use

apiInstance.computeSimilarsPg2vecModel(body, SID, xModelName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ComputeSimilarsMlModelRequest**](ComputeSimilarsMlModelRequest.md)| The request body defines the details to the compute similars request. | 
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the pg2vec model to use | 

### Return type

[**FrameMetaData**](FrameMetaData.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="createDeepWalkModel"></a>
# **createDeepWalkModel**
> DeepWalkModelMetadata createDeepWalkModel(body, SID)

Create a DeepWalk model

Create a DeepWalk model in current session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.CreateDeepWalkModelRequest(); // CreateDeepWalkModelRequest | The request body defines the details to the deepwalk model creation request.
let SID = "SID_example"; // String | session ID

apiInstance.createDeepWalkModel(body, SID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**CreateDeepWalkModelRequest**](CreateDeepWalkModelRequest.md)| The request body defines the details to the deepwalk model creation request. | 
 **SID** | **String**| session ID | 

### Return type

[**DeepWalkModelMetadata**](DeepWalkModelMetadata.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="createPg2vecModel"></a>
# **createPg2vecModel**
> Pg2vecModelMetadata createPg2vecModel(body, SID)

Create a Pg2vec model

Create a Pg2vec model in current session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.CreatePg2vecModelRequest(); // CreatePg2vecModelRequest | The request body defines the details to the pg2vecmodel creation request.
let SID = "SID_example"; // String | session ID

apiInstance.createPg2vecModel(body, SID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**CreatePg2vecModelRequest**](CreatePg2vecModelRequest.md)| The request body defines the details to the pg2vecmodel creation request. | 
 **SID** | **String**| session ID | 

### Return type

[**Pg2vecModelMetadata**](Pg2vecModelMetadata.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="createSupervisedGraphWiseModel"></a>
# **createSupervisedGraphWiseModel**
> SupervisedGraphWiseModelMetadata createSupervisedGraphWiseModel(body, SID)

Create a Supervised GraphWise model

Create a Supervised GraphWise model in current session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.CreateSupervisedGraphWiseModelRequest(); // CreateSupervisedGraphWiseModelRequest | The request body defines the details to the graphwise model creation request.
let SID = "SID_example"; // String | session ID

apiInstance.createSupervisedGraphWiseModel(body, SID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**CreateSupervisedGraphWiseModelRequest**](CreateSupervisedGraphWiseModelRequest.md)| The request body defines the details to the graphwise model creation request. | 
 **SID** | **String**| session ID | 

### Return type

[**SupervisedGraphWiseModelMetadata**](SupervisedGraphWiseModelMetadata.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="createUnsupervisedGraphWiseModel"></a>
# **createUnsupervisedGraphWiseModel**
> UnsupervisedGraphWiseModelMetadata createUnsupervisedGraphWiseModel(body, SID)

Create a Unsupervised GraphWise model

Create a Unsupervised GraphWise model in current session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.CreateUnsupervisedGraphWiseModelRequest(); // CreateUnsupervisedGraphWiseModelRequest | The request body defines the details to the graphwise model creation request.
let SID = "SID_example"; // String | session ID

apiInstance.createUnsupervisedGraphWiseModel(body, SID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**CreateUnsupervisedGraphWiseModelRequest**](CreateUnsupervisedGraphWiseModelRequest.md)| The request body defines the details to the graphwise model creation request. | 
 **SID** | **String**| session ID | 

### Return type

[**UnsupervisedGraphWiseModelMetadata**](UnsupervisedGraphWiseModelMetadata.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="destroyMlModel"></a>
# **destroyMlModel**
> destroyMlModel(SID, xModelName, opts)

Delete an MlModel

Delete a specific MlModel in current session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the MlModel to be deleted
let opts = { 
  'csrfToken': "csrfToken_example" // String | CSRF token
};
apiInstance.destroyMlModel(SID, xModelName, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the MlModel to be deleted | 
 **csrfToken** | **String**| CSRF token | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: Not defined

<a name="explainGraphWiseModel"></a>
# **explainGraphWiseModel**
> FrameMetaData explainGraphWiseModel(body, SID, xModelName)

Infer and explain with a GraphWise model

Infer with a GraphWise model on provided vertices

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.GraphWiseInferenceRequest(); // GraphWiseInferenceRequest | The request body defines the details to the explanation request.
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the graphwise model to infer with

apiInstance.explainGraphWiseModel(body, SID, xModelName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**GraphWiseInferenceRequest**](GraphWiseInferenceRequest.md)| The request body defines the details to the explanation request. | 
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the graphwise model to infer with | 

### Return type

[**FrameMetaData**](FrameMetaData.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="fitDeepWalkModel"></a>
# **fitDeepWalkModel**
> fitDeepWalkModel(body, SID, xModelName)

Train a DeepWalkModel

Train a DeepWalkModel from the specified session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.ComputeMlModelRequest(); // ComputeMlModelRequest | The request body defines the details to the compute mlmodel request.
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the deepwalk model to train

apiInstance.fitDeepWalkModel(body, SID, xModelName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ComputeMlModelRequest**](ComputeMlModelRequest.md)| The request body defines the details to the compute mlmodel request. | 
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the deepwalk model to train | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: Not defined

<a name="fitPg2vecModel"></a>
# **fitPg2vecModel**
> fitPg2vecModel(body, SID, xModelName)

Train a Pg2vecModel

Train a Pg2vecModel from the specified session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.ComputeMlModelRequest(); // ComputeMlModelRequest | The request body defines the details to the compute mlmodel request.
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the pg2vec model to train

apiInstance.fitPg2vecModel(body, SID, xModelName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ComputeMlModelRequest**](ComputeMlModelRequest.md)| The request body defines the details to the compute mlmodel request. | 
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the pg2vec model to train | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: Not defined

<a name="fitSupervisedGraphWiseModel"></a>
# **fitSupervisedGraphWiseModel**
> fitSupervisedGraphWiseModel(body, SID, xModelName)

Train a SupervisedGraphWise model

Train a SupervisedGraphWise model from the specified session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.ComputeMlModelRequest(); // ComputeMlModelRequest | The request body defines the details to the compute mlmodel request.
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the graphwise model to train

apiInstance.fitSupervisedGraphWiseModel(body, SID, xModelName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ComputeMlModelRequest**](ComputeMlModelRequest.md)| The request body defines the details to the compute mlmodel request. | 
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the graphwise model to train | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: Not defined

<a name="fitUnsupervisedGraphWiseModel"></a>
# **fitUnsupervisedGraphWiseModel**
> fitUnsupervisedGraphWiseModel(body, SID, xModelName)

Train a UnsupervisedGraphWise model

Train a UnsupervisedGraphWise model from the specified session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.ComputeMlModelRequest(); // ComputeMlModelRequest | The request body defines the details to the compute mlmodel request.
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the graphwise model to train

apiInstance.fitUnsupervisedGraphWiseModel(body, SID, xModelName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ComputeMlModelRequest**](ComputeMlModelRequest.md)| The request body defines the details to the compute mlmodel request. | 
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the graphwise model to train | 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: Not defined

<a name="getTrainedGraphletVectorsPg2vecModel"></a>
# **getTrainedGraphletVectorsPg2vecModel**
> FrameMetaData getTrainedGraphletVectorsPg2vecModel(SID, xModelName)

Fetch the graphlets vectors of a Pg2vecModel

Fetch the graphlets vectors of a Pg2vecModel

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the pg2vec model for which to fetch the graphlet vectors

apiInstance.getTrainedGraphletVectorsPg2vecModel(SID, xModelName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the pg2vec model for which to fetch the graphlet vectors | 

### Return type

[**FrameMetaData**](FrameMetaData.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="getTrainedVertexVectorsDeepWalkModel"></a>
# **getTrainedVertexVectorsDeepWalkModel**
> FrameMetaData getTrainedVertexVectorsDeepWalkModel(SID, xModelName)

Fetch the vertex vectors of a DeepWalkModel

Fetch the vertex vectors of a DeepWalkModel

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the deepwalk model in which to fetch the vertex vectors

apiInstance.getTrainedVertexVectorsDeepWalkModel(SID, xModelName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the deepwalk model in which to fetch the vertex vectors | 

### Return type

[**FrameMetaData**](FrameMetaData.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: Not defined
 - **Accept**: application/json

<a name="inferGraphletPg2vecModel"></a>
# **inferGraphletPg2vecModel**
> FrameMetaData inferGraphletPg2vecModel(body, SID, xModelName)

Infer with a Pg2vecModel

Infer with a Pg2vecModel from the specified session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.ComputeMlModelRequest(); // ComputeMlModelRequest | The request body defines the details to the compute similars request.
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the pg2vec model to use

apiInstance.inferGraphletPg2vecModel(body, SID, xModelName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**ComputeMlModelRequest**](ComputeMlModelRequest.md)| The request body defines the details to the compute similars request. | 
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the pg2vec model to use | 

### Return type

[**FrameMetaData**](FrameMetaData.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="inferSupervisedGraphWiseModel"></a>
# **inferSupervisedGraphWiseModel**
> FrameMetaData inferSupervisedGraphWiseModel(body, SID, xModelName)

Infer with a Supervised GraphWise model

Infer with a Supervised GraphWise model on provided vertices

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.SupervisedGraphWiseInferenceRequest(); // SupervisedGraphWiseInferenceRequest | The request body defines the details to the inference request.
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the graphwise model to infer with

apiInstance.inferSupervisedGraphWiseModel(body, SID, xModelName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**SupervisedGraphWiseInferenceRequest**](SupervisedGraphWiseInferenceRequest.md)| The request body defines the details to the inference request. | 
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the graphwise model to infer with | 

### Return type

[**FrameMetaData**](FrameMetaData.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="inferUnsupervisedGraphWiseModel"></a>
# **inferUnsupervisedGraphWiseModel**
> FrameMetaData inferUnsupervisedGraphWiseModel(body, SID, xModelName)

Infer with a Unsupervised GraphWise model

Infer with a Unsupervised GraphWise model on provided vertices

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.UnsupervisedGraphWiseInferenceRequest(); // UnsupervisedGraphWiseInferenceRequest | The request body defines the details to the inference request.
let SID = "SID_example"; // String | session ID
let xModelName = "xModelName_example"; // String | the name of the graphwise model to infer with

apiInstance.inferUnsupervisedGraphWiseModel(body, SID, xModelName, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**UnsupervisedGraphWiseInferenceRequest**](UnsupervisedGraphWiseInferenceRequest.md)| The request body defines the details to the inference request. | 
 **SID** | **String**| session ID | 
 **xModelName** | **String**| the name of the graphwise model to infer with | 

### Return type

[**FrameMetaData**](FrameMetaData.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="loadModel"></a>
# **loadModel**
> Pg2vecModelMetadata loadModel(body, SID)

Load a ML model

Load a ML model in current session

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.LoadMlModelRequestConfig(); // LoadMlModelRequestConfig | The request body defines the details to the pg2vecmodel loading request.
let SID = "SID_example"; // String | session ID

apiInstance.loadModel(body, SID, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**LoadMlModelRequestConfig**](LoadMlModelRequestConfig.md)| The request body defines the details to the pg2vecmodel loading request. | 
 **SID** | **String**| session ID | 

### Return type

[**Pg2vecModelMetadata**](Pg2vecModelMetadata.md)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: application/json

<a name="storeModelWithConfig"></a>
# **storeModelWithConfig**
> storeModelWithConfig(body, SID, opts)

Store a model

The PGX server will store the model to a location specified in the StoreMlModelRequest json payload. The server needs to have access to the resource where you want to store the model to.

### Example
```javascript
import {OracleLabsParallelGraphAnalyticsPgxRestApi} from 'oracle_labs_parallel_graph_analytics__pgx_rest_api';

let apiInstance = new OracleLabsParallelGraphAnalyticsPgxRestApi.MlModelsApi();
let body = new OracleLabsParallelGraphAnalyticsPgxRestApi.StoreMlModelRequest(); // StoreMlModelRequest | object that holds information on where to store the graph
let SID = "SID_example"; // String | session ID
let opts = { 
  'xModelName': "xModelName_example" // String | 
};
apiInstance.storeModelWithConfig(body, SID, opts, (error, data, response) => {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully.');
  }
});
```

### Parameters

Name | Type | Description  | Notes
------------- | ------------- | ------------- | -------------
 **body** | [**StoreMlModelRequest**](StoreMlModelRequest.md)| object that holds information on where to store the graph | 
 **SID** | **String**| session ID | 
 **xModelName** | **String**|  | [optional] 

### Return type

null (empty response body)

### Authorization

No authorization required

### HTTP request headers

 - **Content-Type**: application/json
 - **Accept**: Not defined