@ondewo/nlu-client-typescript 3.4.0 → 4.0.0

package/README.md

@@ -1,20 +1,34 @@
-<p align="center">
-  <a href="https://www.ondewo.com">
-    <img alt="ONDEWO Logo" src="https://raw.githubusercontent.com/ondewo/ondewo-logos/master/github/ondewo_logo_github_2.png"/>
-  </a>
+<div align="center">
+  <table>
+    <tr>
+      <td>
+        <a href="https://ondewo.com/en/products/natural-language-understanding/">
+            <img width="400px" src="https://raw.githubusercontent.com/ondewo/ondewo-logos/master/ondewo_we_automate_your_phone_calls.png"/>
+        </a>
+      </td>
+    </tr>
+    <tr>
+       <td align="center">
+          <a href="https://www.linkedin.com/company/ondewo "><img width="40px" src="https://cdn-icons-png.flaticon.com/512/3536/3536505.png"></a>
+          <a href="https://www.facebook.com/ondewo"><img width="40px" src="https://cdn-icons-png.flaticon.com/512/733/733547.png"></a>
+          <a href="https://twitter.com/ondewo"><img width="40px" src="https://cdn-icons-png.flaticon.com/512/733/733579.png"> </a>
+          <a href="https://www.instagram.com/ondewo.ai/"><img width="40px" src="https://cdn-icons-png.flaticon.com/512/174/174855.png"></a>
+          <a href="https://badge.fury.io/js/%40ondewo%2Fnlu-client-typescript"><img src="https://badge.fury.io/js/%40ondewo%2Fnlu-client-typescript.svg" alt="npm version" height="32"></a>
+       </td>
+    </tr>
+  </table>
   <h1 align="center">
     ONDEWO NLU Client Typescript
   </h1>
-  <p align="center">
-    <a href="https://badge.fury.io/js/%40ondewo%2Fnlu-client-typescript"><img src="https://badge.fury.io/js/%40ondewo%2Fnlu-client-typescript.svg" alt="npm version" height="18"></a>
-  </p>
-</p>
+</div>
 
-# @ondewo/nlu-client-typescript
+## Overview
 
-`@ondewo/nlu-client-typescript` is a compiled version of the [ONDEWO NLU API](https://github.com/ondewo/ondewo-nlu-api). Here you can find the NLU API [documentation](https://ondewo.github.io/ondewo-nlu-api/).
+`@ondewo/nlu-client-typescript` is a compiled version of the [ONDEWO NLU API](https://github.com/ondewo/ondewo-nlu-api) using the [ONDEWO PROTO COMPILER](https://github.com/ondewo/ondewo-proto-compiler). Here you can find the NLU API [documentation](https://ondewo.github.io).
 
-## Installation
+ONDEWO APIs use [Protocol Buffers](https://github.com/google/protobuf) version 3 (proto3) as their Interface Definition Language (IDL) to define the API interface and the structure of the payload messages. The same interface definition is used for gRPC versions of the API in all languages.
+
+## Setup
 
 Using NPM:
 
@@ -22,6 +36,59 @@ Using NPM:
 npm i --save @ondewo/nlu-client-typescript
 ```
 
-## Documentation
+Using GitHub:
+
+```shell
+git clone https://github.com/ondewo/ondewo-nlu-client-typescript.git ## Clone repository
+cd ondewo-nlu-client-typescript                                      ## Change into repo-directoy
+make setup_developer_environment_locally                             ## Install dependencies
+```
+
+## Package structure
+
+```
+npm
+├── api
+│   ├── google
+│   │   ├── api
+│   │   │   ├── annotations_pb.d.ts
+│   │   │   └── annotations_pb.js
+│   │   ├── protobuf
+│   │   │   ├── any_pb.d.ts
+│   │   │   ├── any_pb.js
+│   │   │   ├── empty_pb.d.ts
+│   │   │   ├── empty_pb.js
+│   │   │   ├── field_mask_pb.d.ts
+│   │   │   ├── field_mask_pb.js
+│   │   │   ├── struct_pb.d.ts
+│   │   │   ├── struct_pb.js
+│   │   │   ├── timestamp_pb.d.ts
+│   │   │   └── timestamp_pb.js
+│   │   ├── rpc
+│   │   │   ├── status_pb.d.ts
+│   │   │   └── status_pb.js
+│   │   └── type
+│   │       ├── latlng_pb.d.ts
+│   │       └── latlng_pb.js
+│   └── ondewo
+│       ├── nlu
+│       │   ├── agent_grpc_web_pb.d.ts
+│       │   ├── agent_grpc_web_pb.js
+│       │   ├── agent_pb.d.ts
+│       │   ├── agent_pb.js
+│       │   ├── aiservices_grpc_web_pb.d.ts
+│       │   ├── aiservices_grpc_web_pb.js
+│       │   ├── aiservices_pb.d.ts
+│       │   ├── aiservices_pb.js
+│       │   ├── ...
+│       └── qa
+│           ├── qa_grpc_web_pb.d.ts
+│           ├── qa_grpc_web_pb.js
+│           ├── qa_pb.d.ts
+│           └── qa_pb.js
+├── LICENSE
+├── package.json
+├── public-api.d.ts
+└── README.md
+```
 
-Read the full documentation on [GitHub](https://github.com/ondewo/ondewo-nlu-client-typescript).

package/api/ondewo/nlu/agent_grpc_web_pb.d.ts

@@ -157,6 +157,13 @@ export class AgentsClient {
                response: ondewo_nlu_agent_pb.GetAgentStatisticsResponse) => void
   ): grpcWeb.ClientReadableStream<ondewo_nlu_agent_pb.GetAgentStatisticsResponse>;
 
+  getSessionsStatistics(
+    request: ondewo_nlu_agent_pb.GetSessionsStatisticsRequest,
+    metadata: grpcWeb.Metadata | undefined,
+    callback: (err: grpcWeb.RpcError,
+               response: ondewo_nlu_agent_pb.GetSessionsStatisticsResponse) => void
+  ): grpcWeb.ClientReadableStream<ondewo_nlu_agent_pb.GetSessionsStatisticsResponse>;
+
   setAgentStatus(
     request: ondewo_nlu_agent_pb.SetAgentStatusRequest,
     metadata: grpcWeb.Metadata | undefined,
@@ -395,6 +402,11 @@ export class AgentsPromiseClient {
     metadata?: grpcWeb.Metadata
   ): Promise<ondewo_nlu_agent_pb.GetAgentStatisticsResponse>;
 
+  getSessionsStatistics(
+    request: ondewo_nlu_agent_pb.GetSessionsStatisticsRequest,
+    metadata?: grpcWeb.Metadata
+  ): Promise<ondewo_nlu_agent_pb.GetSessionsStatisticsResponse>;
+
   setAgentStatus(
     request: ondewo_nlu_agent_pb.SetAgentStatusRequest,
     metadata?: grpcWeb.Metadata

package/api/ondewo/nlu/agent_grpc_web_pb.js

@@ -24,8 +24,6 @@ var google_protobuf_empty_pb = require('google-protobuf/google/protobuf/empty_pb
 
 var google_protobuf_struct_pb = require('google-protobuf/google/protobuf/struct_pb.js')
 
-var google_protobuf_any_pb = require('google-protobuf/google/protobuf/any_pb.js')
-
 var ondewo_nlu_common_pb = require('../../ondewo/nlu/common_pb.js')
 
 var ondewo_nlu_intent_pb = require('../../ondewo/nlu/intent_pb.js')
@@ -36,6 +34,8 @@ var ondewo_nlu_project_role_pb = require('../../ondewo/nlu/project_role_pb.js')
 
 var ondewo_nlu_operations_pb = require('../../ondewo/nlu/operations_pb.js')
 
+var ondewo_nlu_session_pb = require('../../ondewo/nlu/session_pb.js')
+
 var google_protobuf_timestamp_pb = require('google-protobuf/google/protobuf/timestamp_pb.js')
 const proto = {};
 proto.ondewo = {};
@@ -1374,6 +1374,67 @@ proto.ondewo.nlu.AgentsPromiseClient.prototype.getAgentStatistics =
 };
 
 
+/**
+ * @const
+ * @type {!grpc.web.MethodDescriptor<
+ *   !proto.ondewo.nlu.GetSessionsStatisticsRequest,
+ *   !proto.ondewo.nlu.GetSessionsStatisticsResponse>}
+ */
+const methodDescriptor_Agents_GetSessionsStatistics = new grpc.web.MethodDescriptor(
+  '/ondewo.nlu.Agents/GetSessionsStatistics',
+  grpc.web.MethodType.UNARY,
+  proto.ondewo.nlu.GetSessionsStatisticsRequest,
+  proto.ondewo.nlu.GetSessionsStatisticsResponse,
+  /**
+   * @param {!proto.ondewo.nlu.GetSessionsStatisticsRequest} request
+   * @return {!Uint8Array}
+   */
+  function(request) {
+    return request.serializeBinary();
+  },
+  proto.ondewo.nlu.GetSessionsStatisticsResponse.deserializeBinary
+);
+
+
+/**
+ * @param {!proto.ondewo.nlu.GetSessionsStatisticsRequest} request The
+ *     request proto
+ * @param {?Object<string, string>} metadata User defined
+ *     call metadata
+ * @param {function(?grpc.web.RpcError, ?proto.ondewo.nlu.GetSessionsStatisticsResponse)}
+ *     callback The callback function(error, response)
+ * @return {!grpc.web.ClientReadableStream<!proto.ondewo.nlu.GetSessionsStatisticsResponse>|undefined}
+ *     The XHR Node Readable Stream
+ */
+proto.ondewo.nlu.AgentsClient.prototype.getSessionsStatistics =
+    function(request, metadata, callback) {
+  return this.client_.rpcCall(this.hostname_ +
+      '/ondewo.nlu.Agents/GetSessionsStatistics',
+      request,
+      metadata || {},
+      methodDescriptor_Agents_GetSessionsStatistics,
+      callback);
+};
+
+
+/**
+ * @param {!proto.ondewo.nlu.GetSessionsStatisticsRequest} request The
+ *     request proto
+ * @param {?Object<string, string>=} metadata User defined
+ *     call metadata
+ * @return {!Promise<!proto.ondewo.nlu.GetSessionsStatisticsResponse>}
+ *     Promise that resolves to the response
+ */
+proto.ondewo.nlu.AgentsPromiseClient.prototype.getSessionsStatistics =
+    function(request, metadata) {
+  return this.client_.unaryCall(this.hostname_ +
+      '/ondewo.nlu.Agents/GetSessionsStatistics',
+      request,
+      metadata || {},
+      methodDescriptor_Agents_GetSessionsStatistics);
+};
+
+
 /**
  * @const
  * @type {!grpc.web.MethodDescriptor<

package/api/ondewo/nlu/agent_pb.d.ts

@@ -4,12 +4,12 @@ import * as google_api_annotations_pb from '../../google/api/annotations_pb';
 import * as google_protobuf_field_mask_pb from 'google-protobuf/google/protobuf/field_mask_pb';
 import * as google_protobuf_empty_pb from 'google-protobuf/google/protobuf/empty_pb';
 import * as google_protobuf_struct_pb from 'google-protobuf/google/protobuf/struct_pb';
-import * as google_protobuf_any_pb from 'google-protobuf/google/protobuf/any_pb';
 import * as ondewo_nlu_common_pb from '../../ondewo/nlu/common_pb';
 import * as ondewo_nlu_intent_pb from '../../ondewo/nlu/intent_pb';
 import * as ondewo_nlu_user_pb from '../../ondewo/nlu/user_pb';
 import * as ondewo_nlu_project_role_pb from '../../ondewo/nlu/project_role_pb';
 import * as ondewo_nlu_operations_pb from '../../ondewo/nlu/operations_pb';
+import * as ondewo_nlu_session_pb from '../../ondewo/nlu/session_pb';
 import * as google_protobuf_timestamp_pb from 'google-protobuf/google/protobuf/timestamp_pb';
 
 
@@ -679,6 +679,98 @@ export namespace GetAgentStatisticsResponse {
   }
 }
 
+export class GetSessionsStatisticsRequest extends jspb.Message {
+  getParent(): string;
+  setParent(value: string): GetSessionsStatisticsRequest;
+
+  getFormat(): ReportFormat;
+  setFormat(value: ReportFormat): GetSessionsStatisticsRequest;
+
+  getType(): SessionsReportType;
+  setType(value: SessionsReportType): GetSessionsStatisticsRequest;
+
+  getSessionFilter(): ondewo_nlu_session_pb.SessionFilter | undefined;
+  setSessionFilter(value?: ondewo_nlu_session_pb.SessionFilter): GetSessionsStatisticsRequest;
+  hasSessionFilter(): boolean;
+  clearSessionFilter(): GetSessionsStatisticsRequest;
+
+  getContextFiltersList(): Array<ondewo_nlu_session_pb.ContextFilter>;
+  setContextFiltersList(value: Array<ondewo_nlu_session_pb.ContextFilter>): GetSessionsStatisticsRequest;
+  clearContextFiltersList(): GetSessionsStatisticsRequest;
+  addContextFilters(value?: ondewo_nlu_session_pb.ContextFilter, index?: number): ondewo_nlu_session_pb.ContextFilter;
+
+  getLimit(): number;
+  setLimit(value: number): GetSessionsStatisticsRequest;
+
+  getGroupBysList(): Array<string>;
+  setGroupBysList(value: Array<string>): GetSessionsStatisticsRequest;
+  clearGroupBysList(): GetSessionsStatisticsRequest;
+  addGroupBys(value: string, index?: number): GetSessionsStatisticsRequest;
+
+  getOrderBysList(): Array<string>;
+  setOrderBysList(value: Array<string>): GetSessionsStatisticsRequest;
+  clearOrderBysList(): GetSessionsStatisticsRequest;
+  addOrderBys(value: string, index?: number): GetSessionsStatisticsRequest;
+
+  getFieldMask(): google_protobuf_field_mask_pb.FieldMask | undefined;
+  setFieldMask(value?: google_protobuf_field_mask_pb.FieldMask): GetSessionsStatisticsRequest;
+  hasFieldMask(): boolean;
+  clearFieldMask(): GetSessionsStatisticsRequest;
+
+  getSqlQuery(): string;
+  setSqlQuery(value: string): GetSessionsStatisticsRequest;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): GetSessionsStatisticsRequest.AsObject;
+  static toObject(includeInstance: boolean, msg: GetSessionsStatisticsRequest): GetSessionsStatisticsRequest.AsObject;
+  static serializeBinaryToWriter(message: GetSessionsStatisticsRequest, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): GetSessionsStatisticsRequest;
+  static deserializeBinaryFromReader(message: GetSessionsStatisticsRequest, reader: jspb.BinaryReader): GetSessionsStatisticsRequest;
+}
+
+export namespace GetSessionsStatisticsRequest {
+  export type AsObject = {
+    parent: string,
+    format: ReportFormat,
+    type: SessionsReportType,
+    sessionFilter?: ondewo_nlu_session_pb.SessionFilter.AsObject,
+    contextFiltersList: Array<ondewo_nlu_session_pb.ContextFilter.AsObject>,
+    limit: number,
+    groupBysList: Array<string>,
+    orderBysList: Array<string>,
+    fieldMask?: google_protobuf_field_mask_pb.FieldMask.AsObject,
+    sqlQuery: string,
+  }
+}
+
+export class GetSessionsStatisticsResponse extends jspb.Message {
+  getReports(): Uint8Array | string;
+  getReports_asU8(): Uint8Array;
+  getReports_asB64(): string;
+  setReports(value: Uint8Array | string): GetSessionsStatisticsResponse;
+
+  getFormat(): ReportFormat;
+  setFormat(value: ReportFormat): GetSessionsStatisticsResponse;
+
+  getType(): SessionsReportType;
+  setType(value: SessionsReportType): GetSessionsStatisticsResponse;
+
+  serializeBinary(): Uint8Array;
+  toObject(includeInstance?: boolean): GetSessionsStatisticsResponse.AsObject;
+  static toObject(includeInstance: boolean, msg: GetSessionsStatisticsResponse): GetSessionsStatisticsResponse.AsObject;
+  static serializeBinaryToWriter(message: GetSessionsStatisticsResponse, writer: jspb.BinaryWriter): void;
+  static deserializeBinary(bytes: Uint8Array): GetSessionsStatisticsResponse;
+  static deserializeBinaryFromReader(message: GetSessionsStatisticsResponse, reader: jspb.BinaryReader): GetSessionsStatisticsResponse;
+}
+
+export namespace GetSessionsStatisticsResponse {
+  export type AsObject = {
+    reports: Uint8Array | string,
+    format: ReportFormat,
+    type: SessionsReportType,
+  }
+}
+
 export class AddUserToProjectRequest extends jspb.Message {
   getParent(): string;
   setParent(value: string): AddUserToProjectRequest;
@@ -2147,6 +2239,19 @@ export enum ReportType {
   ENTITY_COLLISION = 3,
   INTENT_GENERAL = 4,
 }
+export enum SessionsReportType { 
+  SESSIONS = 0,
+  SESSION_STEPS = 1,
+  SESSION_TOP_X_INTENTS = 2,
+  SESSION_TOP_X_ENTITY_TYPES = 3,
+  SESSION_TOP_X_ENTITY_VALUES = 4,
+  SESSION_TOP_X_USERS = 5,
+  SESSION_TOP_X_LABELS = 6,
+  SESSION_TOP_X_TAGS = 7,
+  SESSION_TOP_X_PHONE_NUMBERS = 8,
+  SESSION_HUMAN_HANDOVERS = 9,
+  SESSION_SQL_QUERY = 10,
+}
 export enum ReportFormat { 
   CSV = 0,
   HTML = 1,