diff --git a/classes/ainize.Ainize.html b/classes/ainize.Ainize.html index a232ed6..ae1fd94 100644 --- a/classes/ainize.Ainize.html +++ b/classes/ainize.Ainize.html @@ -21,7 +21,7 @@

Hierarchy

+
  • Defined in ainize.ts:12
    • @@ -61,19 +61,19 @@

    Parameters

    chainId: 0 | 1

    Returns Ainize

    +
  • Defined in ainize.ts:20

    • Properties

    internal

    internal: default
    +
  • Defined in ainize.ts:18

    • middleware

    middleware: default
    +
  • Defined in ainize.ts:17

    • Methods

    @@ -94,7 +94,7 @@
    deployConfig: Returns Promise<Service>
    +
  • Defined in ainize.ts:69

    • getAddress

    +
  • Defined in ainize.ts:54

    • getAinBalance

    +
  • Defined in ainize.ts:58

    • getService

    Returns Promise<Service>

    +
  • Defined in ainize.ts:99

    • login

    Returns Promise<void>

    +
  • Defined in ainize.ts:39

    • logout

    +
  • Defined in ainize.ts:48

    • test

    +
  • Defined in ainize.ts:108

    • Static createAinAccount

    +
  • Defined in ainize.ts:31
    • diff --git a/classes/service.Service.html b/classes/service.Service.html index 5f7c0d9..929c7a9 100644 --- a/classes/service.Service.html +++ b/classes/service.Service.html @@ -21,7 +21,7 @@

    Hierarchy

    • Service
    +
  • Defined in service.ts:3
    • @@ -63,14 +63,14 @@

    Parameters

    serviceName: string

    Returns Service

    +
  • Defined in service.ts:7

    • Properties

    serviceName

    serviceName: string
    +
  • Defined in service.ts:4

    • Methods

    @@ -89,7 +89,7 @@

    Parameters

    requestData: string

    Returns Promise<number>

    +
  • Defined in service.ts:33

    • changeServiceInfo

    Returns Promise<void>

    +
  • Defined in service.ts:107

    • chargeCredit

    Returns Promise<string>

    +
  • Defined in service.ts:44

    • getCreditBalance

    +
  • Defined in service.ts:63

    • getCreditHistory

    +
  • Defined in service.ts:72

    • getInformation

    +
  • Defined in service.ts:24

    • isRunning

    +
  • Defined in service.ts:16

    • request

    +
  • Defined in service.ts:82

    • run

    +
  • Defined in service.ts:90

    • stop

    +
  • Defined in service.ts:98

    • withdrawCredit

    Returns Promise<boolean>

    +
  • Defined in service.ts:54
    • diff --git a/enums/types_type.ContainerStatus.html b/enums/types_type.ContainerStatus.html index 8d4694e..bf215ef 100644 --- a/enums/types_type.ContainerStatus.html +++ b/enums/types_type.ContainerStatus.html @@ -17,7 +17,7 @@
  • ContainerStatus

    • Enumeration ContainerStatus

    +
  • Defined in types/type.ts:95
    • @@ -34,12 +34,12 @@

    Enumeration Members

    RUNNING

    RUNNING: "RUNNING"
    +
  • Defined in types/type.ts:96

    • STOP

    STOP: "STOP"
    +
  • Defined in types/type.ts:97
    • diff --git a/enums/types_type.HISTORY_TYPE.html b/enums/types_type.HISTORY_TYPE.html index 28ee454..4185750 100644 --- a/enums/types_type.HISTORY_TYPE.html +++ b/enums/types_type.HISTORY_TYPE.html @@ -17,7 +17,7 @@
  • HISTORY_TYPE

    • Enumeration HISTORY_TYPE

    +
  • Defined in types/type.ts:27
    • @@ -34,12 +34,12 @@

    Enumeration Members

    DEPOSIT

    DEPOSIT: "DEPOSIT"
    +
  • Defined in types/type.ts:28

    • USAGE

    USAGE: "USAGE"
    +
  • Defined in types/type.ts:29
    • diff --git a/enums/types_type.RESPONSE_STATUS.html b/enums/types_type.RESPONSE_STATUS.html index d4c40f0..679aeca 100644 --- a/enums/types_type.RESPONSE_STATUS.html +++ b/enums/types_type.RESPONSE_STATUS.html @@ -17,7 +17,7 @@
  • RESPONSE_STATUS

    • Enumeration RESPONSE_STATUS

    +
  • Defined in types/type.ts:58
    • @@ -34,12 +34,12 @@

    Enumeration Members

    FAIL

    FAIL: "FAIL"
    +
  • Defined in types/type.ts:60

    • SUCCESS

    SUCCESS: "SUCCESS"
    +
  • Defined in types/type.ts:59
    • diff --git a/index.html b/index.html index 210dd0c..92135c0 100644 --- a/index.html +++ b/index.html @@ -13,10 +13,10 @@

    Ainize-SDK

    - -

    ainize-sdk

    +     +

    ainize-js

     -

    A Typescript SDK for the Ainize, a system for running AI services on the AI Network.

    +

    A Typescript JS for the Ainize, a system for running AI services on the AI Network.

    Requirements

    @@ -30,13 +30,13 @@

    usage

    Install

     -
    npm install @ainize-team/ainize-sdk

    yarn install @ainize-team/ainize-sdk
+
    npm install @ainize-team/ainize-js

    yarn install @ainize-team/ainize-js
 
    
 
 
   
    Import
    
     
-
    import Ainize from '@ainize-team/ainize-sdk'
    const ainize = new Ainize(<CHAIN_ID>);
+
    import Ainize from '@ainize-team/ainize-js'
    const ainize = new Ainize(<CHAIN_ID>);
 
    
 
    CHAIN_ID
    
 
      
@@ -75,14 +75,14 @@ 
      Deploy
      
 
   
      Using Service
      
       
-
      You can use a service using ainize.service(<SERVICE_NAME>).
      
-
      const service = await ainize.service(<SERVICE_NAME>);
+
      You can use a service using ainize.getService(<SERVICE_NAME>).
      
+
      const service = await ainize.getService(<SERVICE_NAME>);
 
      
 
      You should deposit AIN to credit before using service.
      
 
      await service.chargeCredit(<AMOUNT>);
      const balance = await service.getCreditBalance();
 
      
 
      If you have enough credit, you can use the service.
      
-
      const result = await service.use(<REQUEST_DATA>);
+
      const result = await service.request(<REQUEST_DATA>);
    diff --git a/modules/ainize.html b/modules/ainize.html index f88ff9d..f58c1b1 100644 --- a/modules/ainize.html +++ b/modules/ainize.html @@ -16,7 +16,7 @@
  • ainize

    • Module ainize

    +
  • Defined in ainize.ts:1
    • diff --git a/modules/service.html b/modules/service.html index dc4c4fa..d70ae23 100644 --- a/modules/service.html +++ b/modules/service.html @@ -16,7 +16,7 @@
  • service

    • Module service

    +
  • Defined in service.ts:1
    • diff --git a/modules/types_type.html b/modules/types_type.html index 5558d11..8b6606d 100644 --- a/modules/types_type.html +++ b/modules/types_type.html @@ -16,7 +16,7 @@
  • types/type

    • Module types/type

    +
  • Defined in types/type.ts:1
    • diff --git a/types/types_type.appBillingConfig.html b/types/types_type.appBillingConfig.html index c324295..0af01e6 100644 --- a/types/types_type.appBillingConfig.html +++ b/types/types_type.appBillingConfig.html @@ -29,7 +29,7 @@
    Optional maxCost
    minCost: number
    +
  • Defined in types/type.ts:20
    • diff --git a/types/types_type.createAppConfig.html b/types/types_type.createAppConfig.html index 0092c5e..6bf95b3 100644 --- a/types/types_type.createAppConfig.html +++ b/types/types_type.createAppConfig.html @@ -27,7 +27,7 @@
    billingConfig:
    serviceUrl: string
    +
  • Defined in types/type.ts:89
    • diff --git a/types/types_type.creditHistories.html b/types/types_type.creditHistories.html index 18a16c2..71da158 100644 --- a/types/types_type.creditHistories.html +++ b/types/types_type.creditHistories.html @@ -23,7 +23,7 @@

    Type declaration

  • [timestamp: string]: creditHistory
    • +
  • Defined in types/type.ts:32
    • diff --git a/types/types_type.creditHistory.html b/types/types_type.creditHistory.html index 148819a..55b41fa 100644 --- a/types/types_type.creditHistory.html +++ b/types/types_type.creditHistory.html @@ -29,7 +29,7 @@
    Optional transferKey
    type: HISTORY_TYPE
    +
  • Defined in types/type.ts:36
    • diff --git a/types/types_type.deployConfig.html b/types/types_type.deployConfig.html index 805ce8d..c520987 100644 --- a/types/types_type.deployConfig.html +++ b/types/types_type.deployConfig.html @@ -27,7 +27,7 @@
    serviceName:
    Optional serviceUrl?: string
    +
  • Defined in types/type.ts:83
    • diff --git a/types/types_type.deposit.html b/types/types_type.deposit.html index 79d441f..ca3a53a 100644 --- a/types/types_type.deposit.html +++ b/types/types_type.deposit.html @@ -29,7 +29,7 @@
    transferKey:
    transferValue: number
    +
  • Defined in types/type.ts:76
    • diff --git a/types/types_type.opResult.html b/types/types_type.opResult.html index 5fc6534..173d6a4 100644 --- a/types/types_type.opResult.html +++ b/types/types_type.opResult.html @@ -27,7 +27,7 @@
    code:
    Optional message?: string
    +
  • Defined in types/type.ts:43
    • diff --git a/types/types_type.request.html b/types/types_type.request.html index b78053e..7ba0d91 100644 --- a/types/types_type.request.html +++ b/types/types_type.request.html @@ -29,7 +29,7 @@
    requestKey:
    requesterAddress: string
    +
  • Defined in types/type.ts:63
    • diff --git a/types/types_type.response.html b/types/types_type.response.html index 7231d89..e074d73 100644 --- a/types/types_type.response.html +++ b/types/types_type.response.html @@ -18,7 +18,7 @@

    Type alias response

    response: request & {
        cost: number;
        responseData: string;
        status: RESPONSE_STATUS;
    }
    +
  • Defined in types/type.ts:70
    • diff --git a/types/types_type.setRuleParam.html b/types/types_type.setRuleParam.html index 0ce3490..ea2f106 100644 --- a/types/types_type.setRuleParam.html +++ b/types/types_type.setRuleParam.html @@ -18,7 +18,7 @@

    Type alias setRuleParam

    setRuleParam: {
        ref: string;
    } & writeRuleConfig
    +
  • Defined in types/type.ts:15
    • diff --git a/types/types_type.setTriggerFunctionParm.html b/types/types_type.setTriggerFunctionParm.html index 8cee7b5..d019595 100644 --- a/types/types_type.setTriggerFunctionParm.html +++ b/types/types_type.setTriggerFunctionParm.html @@ -18,7 +18,7 @@

    Type alias setTriggerFunctionParm

    setTriggerFunctionParm: {
        ref: string;
    } & triggerFunctionConfig
    +
  • Defined in types/type.ts:7
    • diff --git a/types/types_type.triggerFunctionConfig.html b/types/types_type.triggerFunctionConfig.html index 8f78bd7..89d8b41 100644 --- a/types/types_type.triggerFunctionConfig.html +++ b/types/types_type.triggerFunctionConfig.html @@ -27,7 +27,7 @@
    function_type:
    function_url: string
    +
  • Defined in types/type.ts:1
    • diff --git a/types/types_type.txResult.html b/types/types_type.txResult.html index 2f6b303..2f5afc3 100644 --- a/types/types_type.txResult.html +++ b/types/types_type.txResult.html @@ -32,7 +32,7 @@
    Optional result_list
    [index: string]: opResult
    +
  • Defined in types/type.ts:49
    • diff --git a/types/types_type.writeRuleConfig.html b/types/types_type.writeRuleConfig.html index 2246888..51c22f6 100644 --- a/types/types_type.writeRuleConfig.html +++ b/types/types_type.writeRuleConfig.html @@ -23,7 +23,7 @@

    Type declaration

  • write: string
    • +
  • Defined in types/type.ts:11