diff --git a/.nojekyll b/.nojekyll new file mode 100644 index 00000000..e69de29b diff --git a/404.html b/404.html new file mode 100644 index 00000000..0fcf55f8 --- /dev/null +++ b/404.html @@ -0,0 +1,2703 @@ + + + + + + + + + + + + + + + + + + + + + + + Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ +

404 - Not found

+ +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/CNAME b/CNAME new file mode 100644 index 00000000..30833f82 --- /dev/null +++ b/CNAME @@ -0,0 +1 @@ +cxcli.xavidop.me \ No newline at end of file diff --git a/agents/create/index.html b/agents/create/index.html new file mode 100644 index 00000000..144c2862 --- /dev/null +++ b/agents/create/index.html @@ -0,0 +1,2856 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Create

+

Usage

+

You can find the create functionality within the cxcli agent create subcommand. You can read the documentation about this command here.

+

The argument to --timezone is a value from the IANA time zone database. This is an example: +

America/New_York
+Europe/Madrid
+

+

Example

+

Here is a simple example of the cxcli agent create command:

+
cxcli agent create test-agent --project-id test-cx-346408 --location-id us-central1 --locale en --timezone Europe/Madrid
+
+

The above command will give you output similar to the following:

+
$ cxcli agent create test-agent --project-id test-cx-346408 --location-id us-central1 --locale en --timezone Europe/Madrid
+INFO Agent created with id: projects/test-cx-346408/locations/us-central1/agents/e2ae2503-f38c-46a1-a3bf-22e57617baf0
+
+ +

If you want to learn more about Dialogflow CX Agent creation, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/agents/delete/index.html b/agents/delete/index.html new file mode 100644 index 00000000..42791fb8 --- /dev/null +++ b/agents/delete/index.html @@ -0,0 +1,2852 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Delete

+

Usage

+

You can find the delete functionality within the cxcli agent delete subcommand. You can read the documentation about this command here.

+

Example

+

Here is a simple example of the cxcli agent delete command:

+
cxcli agent delete test-agent --project-id test-cx-346408 --location-id us-central1
+
+

The above command will give you output similar to the following:

+
$ cxcli agent delete test-agent --project-id test-cx-346408 --location-id us-central1
+INFO Agent deleted
+
+ +

If you want to learn more about Dialogflow CX Agent deletion, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/agents/export/index.html b/agents/export/index.html new file mode 100644 index 00000000..2f49dce8 --- /dev/null +++ b/agents/export/index.html @@ -0,0 +1,2860 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Export - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Export

+

Usage

+

You can find the export functionality within the cxcli agent export subcommand. You can read the documentation about this command here.

+
+

Exported file format

+

You can export your agent in blob or json format. When you choose json format, the output file is going to be a zip file.

+
+

Example

+

Here is a simple example of the cxcli agent export command:

+
cxcli agent export test-agent --project-id test-cx-346408 --location-id us-central1 --export-format blob
+
+

The above command will give you output similar to the following:

+
$ cxcli agent export test-agent --project-id test-cx-346408 --location-id us-central1 --export-format json --output-file agent.zip
+INFO Agent exported to file: agent.zip
+
+
+

are you running this command in a CI/CD pipeline?

+

If this is the case, we recommend that you set the --output-format parameter to json.

+
+ +

If you want to learn more about Dialogflow CX exports, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/agents/introduction/index.html b/agents/introduction/index.html new file mode 100644 index 00000000..28e194c7 --- /dev/null +++ b/agents/introduction/index.html @@ -0,0 +1,2934 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Introduction - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Agents

+

What is this?

+

An agent in Dialogflow CX is the entity that handles all the conversations that we have defined on the Dialogflow CX console with the end users.

+

An agent is basically an assistant that will manage the state of each user's conversation when the end users are interacting with the agent through text or audio in multiple channels.

+

With cxcli, you can easily interact with your Dialogflow CX agents.

+

All of the commands that are available in cxcli to interact with your agents are located within the cxcli agent subcommand.

+

Create

+

You can create an agent using this tool.

+

The cxcli has a command that allows you to create an agent. You can find a more detailed explanation here

+

Update

+

You can update an agent using this cli.

+

The cxcli has a command that allows you to update an agent. You can find a more detailed explanation here

+

Delete

+

The cxcli has a command that allows you to delete your agent. You can find a more detailed explanation here

+

Restore

+

You can restore an agent using a blob or a json-package file. Right now the Dialogflow CX API, used by the cxcli, works with the blob and json format.

+

The cxcli has a command that allows you to restore an agent. You can find a more detailed explanation here

+

Export

+

An agent can be exported as a blob or a json-package file. Right now the Dialogflow CX API, used by the cxcli, works with the blob and json format.

+

The cxcli has a command that allows you to export your agent. You can find a more detailed explanation here

+ +

If you want to see the full usage of the cxcli agent command, please refer to this page.

+

If you want to learn more about Dialogflow CX agents, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/agents/restore/index.html b/agents/restore/index.html new file mode 100644 index 00000000..ee83594d --- /dev/null +++ b/agents/restore/index.html @@ -0,0 +1,2860 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Restore - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Restore

+

Usage

+

You can find the restore functionality within the cxcli agent restore subcommand. You can read the documentation about this command here.

+
+

File format to be restored

+

Now you can restore your agents in blob or json format. When you choose json format, the input file has to be a zip file with a proper Dialogflow CX structure.

+
+

Example

+

Here is a simple example of the cxcli agent restore command:

+
cxcli agent restore test-agent --project-id test-cx-346408 --location-id us-central1 --input agent.blob
+
+

The above command will give you output similar to the following:

+
$ cxcli agent restore test-agent --project-id test-cx-346408 --location-id us-central1 --input agent.zip
+INFO Agent restored
+
+
+

Are you running this command in a CI/CD pipeline?

+

If this is the case, we recommend that you set the --output-format parameter to json.

+
+ +

If you want to learn more about Dialogflow CX restores, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/agents/update/index.html b/agents/update/index.html new file mode 100644 index 00000000..31374961 --- /dev/null +++ b/agents/update/index.html @@ -0,0 +1,2856 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Update - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + + Skip to content + + +
+
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Update

+

Usage

+

You can find the update functionality within the cxcli agent update subcommand. You can read the documentation about this command here.

+

The argument to --timezone is a value from the IANA time zone database. This is an example: +

America/New_York
+Europe/Madrid
+

+

Example

+

Here is a simple example of the cxcli agent update command:

+
cxcli agent update test-agent --project-id test-cx-346408 --location-id us-central1 --locale en --timezone Europe/Madrid
+
+

The above command will give you output similar to the following:

+
$ cxcli agent update test-agent --project-id test-cx-346408 --location-id us-central1 --locale en --timezone Europe/Madrid
+INFO Agent updated
+
+ +

If you want to learn more about Dialogflow CX Agent update, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/assets/images/favicon.png b/assets/images/favicon.png new file mode 100644 index 00000000..1cf13b9f Binary files /dev/null and b/assets/images/favicon.png differ diff --git a/assets/javascripts/bundle.a7c05c9e.min.js b/assets/javascripts/bundle.a7c05c9e.min.js new file mode 100644 index 00000000..31d74078 --- /dev/null +++ b/assets/javascripts/bundle.a7c05c9e.min.js @@ -0,0 +1,29 @@ +"use strict";(()=>{var Fi=Object.create;var gr=Object.defineProperty;var ji=Object.getOwnPropertyDescriptor;var Wi=Object.getOwnPropertyNames,Dt=Object.getOwnPropertySymbols,Ui=Object.getPrototypeOf,xr=Object.prototype.hasOwnProperty,no=Object.prototype.propertyIsEnumerable;var oo=(e,t,r)=>t in e?gr(e,t,{enumerable:!0,configurable:!0,writable:!0,value:r}):e[t]=r,R=(e,t)=>{for(var r in t||(t={}))xr.call(t,r)&&oo(e,r,t[r]);if(Dt)for(var r of Dt(t))no.call(t,r)&&oo(e,r,t[r]);return e};var io=(e,t)=>{var r={};for(var o in e)xr.call(e,o)&&t.indexOf(o)<0&&(r[o]=e[o]);if(e!=null&&Dt)for(var o of Dt(e))t.indexOf(o)<0&&no.call(e,o)&&(r[o]=e[o]);return r};var yr=(e,t)=>()=>(t||e((t={exports:{}}).exports,t),t.exports);var Di=(e,t,r,o)=>{if(t&&typeof t=="object"||typeof t=="function")for(let n of Wi(t))!xr.call(e,n)&&n!==r&&gr(e,n,{get:()=>t[n],enumerable:!(o=ji(t,n))||o.enumerable});return e};var Vt=(e,t,r)=>(r=e!=null?Fi(Ui(e)):{},Di(t||!e||!e.__esModule?gr(r,"default",{value:e,enumerable:!0}):r,e));var ao=(e,t,r)=>new Promise((o,n)=>{var i=p=>{try{s(r.next(p))}catch(c){n(c)}},a=p=>{try{s(r.throw(p))}catch(c){n(c)}},s=p=>p.done?o(p.value):Promise.resolve(p.value).then(i,a);s((r=r.apply(e,t)).next())});var co=yr((Er,so)=>{(function(e,t){typeof Er=="object"&&typeof so!="undefined"?t():typeof define=="function"&&define.amd?define(t):t()})(Er,function(){"use strict";function e(r){var o=!0,n=!1,i=null,a={text:!0,search:!0,url:!0,tel:!0,email:!0,password:!0,number:!0,date:!0,month:!0,week:!0,time:!0,datetime:!0,"datetime-local":!0};function s(H){return!!(H&&H!==document&&H.nodeName!=="HTML"&&H.nodeName!=="BODY"&&"classList"in H&&"contains"in H.classList)}function p(H){var mt=H.type,ze=H.tagName;return!!(ze==="INPUT"&&a[mt]&&!H.readOnly||ze==="TEXTAREA"&&!H.readOnly||H.isContentEditable)}function c(H){H.classList.contains("focus-visible")||(H.classList.add("focus-visible"),H.setAttribute("data-focus-visible-added",""))}function l(H){H.hasAttribute("data-focus-visible-added")&&(H.classList.remove("focus-visible"),H.removeAttribute("data-focus-visible-added"))}function f(H){H.metaKey||H.altKey||H.ctrlKey||(s(r.activeElement)&&c(r.activeElement),o=!0)}function u(H){o=!1}function h(H){s(H.target)&&(o||p(H.target))&&c(H.target)}function w(H){s(H.target)&&(H.target.classList.contains("focus-visible")||H.target.hasAttribute("data-focus-visible-added"))&&(n=!0,window.clearTimeout(i),i=window.setTimeout(function(){n=!1},100),l(H.target))}function A(H){document.visibilityState==="hidden"&&(n&&(o=!0),te())}function te(){document.addEventListener("mousemove",J),document.addEventListener("mousedown",J),document.addEventListener("mouseup",J),document.addEventListener("pointermove",J),document.addEventListener("pointerdown",J),document.addEventListener("pointerup",J),document.addEventListener("touchmove",J),document.addEventListener("touchstart",J),document.addEventListener("touchend",J)}function ie(){document.removeEventListener("mousemove",J),document.removeEventListener("mousedown",J),document.removeEventListener("mouseup",J),document.removeEventListener("pointermove",J),document.removeEventListener("pointerdown",J),document.removeEventListener("pointerup",J),document.removeEventListener("touchmove",J),document.removeEventListener("touchstart",J),document.removeEventListener("touchend",J)}function J(H){H.target.nodeName&&H.target.nodeName.toLowerCase()==="html"||(o=!1,ie())}document.addEventListener("keydown",f,!0),document.addEventListener("mousedown",u,!0),document.addEventListener("pointerdown",u,!0),document.addEventListener("touchstart",u,!0),document.addEventListener("visibilitychange",A,!0),te(),r.addEventListener("focus",h,!0),r.addEventListener("blur",w,!0),r.nodeType===Node.DOCUMENT_FRAGMENT_NODE&&r.host?r.host.setAttribute("data-js-focus-visible",""):r.nodeType===Node.DOCUMENT_NODE&&(document.documentElement.classList.add("js-focus-visible"),document.documentElement.setAttribute("data-js-focus-visible",""))}if(typeof window!="undefined"&&typeof document!="undefined"){window.applyFocusVisiblePolyfill=e;var t;try{t=new CustomEvent("focus-visible-polyfill-ready")}catch(r){t=document.createEvent("CustomEvent"),t.initCustomEvent("focus-visible-polyfill-ready",!1,!1,{})}window.dispatchEvent(t)}typeof document!="undefined"&&e(document)})});var Yr=yr((Rt,Kr)=>{/*! + * clipboard.js v2.0.11 + * https://clipboardjs.com/ + * + * Licensed MIT © Zeno Rocha + */(function(t,r){typeof Rt=="object"&&typeof Kr=="object"?Kr.exports=r():typeof define=="function"&&define.amd?define([],r):typeof Rt=="object"?Rt.ClipboardJS=r():t.ClipboardJS=r()})(Rt,function(){return function(){var e={686:function(o,n,i){"use strict";i.d(n,{default:function(){return Ii}});var a=i(279),s=i.n(a),p=i(370),c=i.n(p),l=i(817),f=i.n(l);function u(V){try{return document.execCommand(V)}catch(_){return!1}}var h=function(_){var O=f()(_);return u("cut"),O},w=h;function A(V){var _=document.documentElement.getAttribute("dir")==="rtl",O=document.createElement("textarea");O.style.fontSize="12pt",O.style.border="0",O.style.padding="0",O.style.margin="0",O.style.position="absolute",O.style[_?"right":"left"]="-9999px";var j=window.pageYOffset||document.documentElement.scrollTop;return O.style.top="".concat(j,"px"),O.setAttribute("readonly",""),O.value=V,O}var te=function(_,O){var j=A(_);O.container.appendChild(j);var D=f()(j);return u("copy"),j.remove(),D},ie=function(_){var O=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body},j="";return typeof _=="string"?j=te(_,O):_ instanceof HTMLInputElement&&!["text","search","url","tel","password"].includes(_==null?void 0:_.type)?j=te(_.value,O):(j=f()(_),u("copy")),j},J=ie;function H(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?H=function(O){return typeof O}:H=function(O){return O&&typeof Symbol=="function"&&O.constructor===Symbol&&O!==Symbol.prototype?"symbol":typeof O},H(V)}var mt=function(){var _=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{},O=_.action,j=O===void 0?"copy":O,D=_.container,Y=_.target,ke=_.text;if(j!=="copy"&&j!=="cut")throw new Error('Invalid "action" value, use either "copy" or "cut"');if(Y!==void 0)if(Y&&H(Y)==="object"&&Y.nodeType===1){if(j==="copy"&&Y.hasAttribute("disabled"))throw new Error('Invalid "target" attribute. Please use "readonly" instead of "disabled" attribute');if(j==="cut"&&(Y.hasAttribute("readonly")||Y.hasAttribute("disabled")))throw new Error(`Invalid "target" attribute. You can't cut text from elements with "readonly" or "disabled" attributes`)}else throw new Error('Invalid "target" value, use a valid Element');if(ke)return J(ke,{container:D});if(Y)return j==="cut"?w(Y):J(Y,{container:D})},ze=mt;function Ie(V){"@babel/helpers - typeof";return typeof Symbol=="function"&&typeof Symbol.iterator=="symbol"?Ie=function(O){return typeof O}:Ie=function(O){return O&&typeof Symbol=="function"&&O.constructor===Symbol&&O!==Symbol.prototype?"symbol":typeof O},Ie(V)}function _i(V,_){if(!(V instanceof _))throw new TypeError("Cannot call a class as a function")}function ro(V,_){for(var O=0;O<_.length;O++){var j=_[O];j.enumerable=j.enumerable||!1,j.configurable=!0,"value"in j&&(j.writable=!0),Object.defineProperty(V,j.key,j)}}function Ai(V,_,O){return _&&ro(V.prototype,_),O&&ro(V,O),V}function Ci(V,_){if(typeof _!="function"&&_!==null)throw new TypeError("Super expression must either be null or a function");V.prototype=Object.create(_&&_.prototype,{constructor:{value:V,writable:!0,configurable:!0}}),_&&br(V,_)}function br(V,_){return br=Object.setPrototypeOf||function(j,D){return j.__proto__=D,j},br(V,_)}function Hi(V){var _=Pi();return function(){var j=Wt(V),D;if(_){var Y=Wt(this).constructor;D=Reflect.construct(j,arguments,Y)}else D=j.apply(this,arguments);return ki(this,D)}}function ki(V,_){return _&&(Ie(_)==="object"||typeof _=="function")?_:$i(V)}function $i(V){if(V===void 0)throw new ReferenceError("this hasn't been initialised - super() hasn't been called");return V}function Pi(){if(typeof Reflect=="undefined"||!Reflect.construct||Reflect.construct.sham)return!1;if(typeof Proxy=="function")return!0;try{return Date.prototype.toString.call(Reflect.construct(Date,[],function(){})),!0}catch(V){return!1}}function Wt(V){return Wt=Object.setPrototypeOf?Object.getPrototypeOf:function(O){return O.__proto__||Object.getPrototypeOf(O)},Wt(V)}function vr(V,_){var O="data-clipboard-".concat(V);if(_.hasAttribute(O))return _.getAttribute(O)}var Ri=function(V){Ci(O,V);var _=Hi(O);function O(j,D){var Y;return _i(this,O),Y=_.call(this),Y.resolveOptions(D),Y.listenClick(j),Y}return Ai(O,[{key:"resolveOptions",value:function(){var D=arguments.length>0&&arguments[0]!==void 0?arguments[0]:{};this.action=typeof D.action=="function"?D.action:this.defaultAction,this.target=typeof D.target=="function"?D.target:this.defaultTarget,this.text=typeof D.text=="function"?D.text:this.defaultText,this.container=Ie(D.container)==="object"?D.container:document.body}},{key:"listenClick",value:function(D){var Y=this;this.listener=c()(D,"click",function(ke){return Y.onClick(ke)})}},{key:"onClick",value:function(D){var Y=D.delegateTarget||D.currentTarget,ke=this.action(Y)||"copy",Ut=ze({action:ke,container:this.container,target:this.target(Y),text:this.text(Y)});this.emit(Ut?"success":"error",{action:ke,text:Ut,trigger:Y,clearSelection:function(){Y&&Y.focus(),window.getSelection().removeAllRanges()}})}},{key:"defaultAction",value:function(D){return vr("action",D)}},{key:"defaultTarget",value:function(D){var Y=vr("target",D);if(Y)return document.querySelector(Y)}},{key:"defaultText",value:function(D){return vr("text",D)}},{key:"destroy",value:function(){this.listener.destroy()}}],[{key:"copy",value:function(D){var Y=arguments.length>1&&arguments[1]!==void 0?arguments[1]:{container:document.body};return J(D,Y)}},{key:"cut",value:function(D){return w(D)}},{key:"isSupported",value:function(){var D=arguments.length>0&&arguments[0]!==void 0?arguments[0]:["copy","cut"],Y=typeof D=="string"?[D]:D,ke=!!document.queryCommandSupported;return Y.forEach(function(Ut){ke=ke&&!!document.queryCommandSupported(Ut)}),ke}}]),O}(s()),Ii=Ri},828:function(o){var n=9;if(typeof Element!="undefined"&&!Element.prototype.matches){var i=Element.prototype;i.matches=i.matchesSelector||i.mozMatchesSelector||i.msMatchesSelector||i.oMatchesSelector||i.webkitMatchesSelector}function a(s,p){for(;s&&s.nodeType!==n;){if(typeof s.matches=="function"&&s.matches(p))return s;s=s.parentNode}}o.exports=a},438:function(o,n,i){var a=i(828);function s(l,f,u,h,w){var A=c.apply(this,arguments);return l.addEventListener(u,A,w),{destroy:function(){l.removeEventListener(u,A,w)}}}function p(l,f,u,h,w){return typeof l.addEventListener=="function"?s.apply(null,arguments):typeof u=="function"?s.bind(null,document).apply(null,arguments):(typeof l=="string"&&(l=document.querySelectorAll(l)),Array.prototype.map.call(l,function(A){return s(A,f,u,h,w)}))}function c(l,f,u,h){return function(w){w.delegateTarget=a(w.target,f),w.delegateTarget&&h.call(l,w)}}o.exports=p},879:function(o,n){n.node=function(i){return i!==void 0&&i instanceof HTMLElement&&i.nodeType===1},n.nodeList=function(i){var a=Object.prototype.toString.call(i);return i!==void 0&&(a==="[object NodeList]"||a==="[object HTMLCollection]")&&"length"in i&&(i.length===0||n.node(i[0]))},n.string=function(i){return typeof i=="string"||i instanceof String},n.fn=function(i){var a=Object.prototype.toString.call(i);return a==="[object Function]"}},370:function(o,n,i){var a=i(879),s=i(438);function p(u,h,w){if(!u&&!h&&!w)throw new Error("Missing required arguments");if(!a.string(h))throw new TypeError("Second argument must be a String");if(!a.fn(w))throw new TypeError("Third argument must be a Function");if(a.node(u))return c(u,h,w);if(a.nodeList(u))return l(u,h,w);if(a.string(u))return f(u,h,w);throw new TypeError("First argument must be a String, HTMLElement, HTMLCollection, or NodeList")}function c(u,h,w){return u.addEventListener(h,w),{destroy:function(){u.removeEventListener(h,w)}}}function l(u,h,w){return Array.prototype.forEach.call(u,function(A){A.addEventListener(h,w)}),{destroy:function(){Array.prototype.forEach.call(u,function(A){A.removeEventListener(h,w)})}}}function f(u,h,w){return s(document.body,u,h,w)}o.exports=p},817:function(o){function n(i){var a;if(i.nodeName==="SELECT")i.focus(),a=i.value;else if(i.nodeName==="INPUT"||i.nodeName==="TEXTAREA"){var s=i.hasAttribute("readonly");s||i.setAttribute("readonly",""),i.select(),i.setSelectionRange(0,i.value.length),s||i.removeAttribute("readonly"),a=i.value}else{i.hasAttribute("contenteditable")&&i.focus();var p=window.getSelection(),c=document.createRange();c.selectNodeContents(i),p.removeAllRanges(),p.addRange(c),a=p.toString()}return a}o.exports=n},279:function(o){function n(){}n.prototype={on:function(i,a,s){var p=this.e||(this.e={});return(p[i]||(p[i]=[])).push({fn:a,ctx:s}),this},once:function(i,a,s){var p=this;function c(){p.off(i,c),a.apply(s,arguments)}return c._=a,this.on(i,c,s)},emit:function(i){var a=[].slice.call(arguments,1),s=((this.e||(this.e={}))[i]||[]).slice(),p=0,c=s.length;for(p;p{"use strict";/*! + * escape-html + * Copyright(c) 2012-2013 TJ Holowaychuk + * Copyright(c) 2015 Andreas Lubbe + * Copyright(c) 2015 Tiancheng "Timothy" Gu + * MIT Licensed + */var ts=/["'&<>]/;ei.exports=rs;function rs(e){var t=""+e,r=ts.exec(t);if(!r)return t;var o,n="",i=0,a=0;for(i=r.index;i0&&i[i.length-1])&&(c[0]===6||c[0]===2)){r=0;continue}if(c[0]===3&&(!i||c[1]>i[0]&&c[1]=e.length&&(e=void 0),{value:e&&e[o++],done:!e}}};throw new TypeError(t?"Object is not iterable.":"Symbol.iterator is not defined.")}function N(e,t){var r=typeof Symbol=="function"&&e[Symbol.iterator];if(!r)return e;var o=r.call(e),n,i=[],a;try{for(;(t===void 0||t-- >0)&&!(n=o.next()).done;)i.push(n.value)}catch(s){a={error:s}}finally{try{n&&!n.done&&(r=o.return)&&r.call(o)}finally{if(a)throw a.error}}return i}function q(e,t,r){if(r||arguments.length===2)for(var o=0,n=t.length,i;o1||s(u,h)})})}function s(u,h){try{p(o[u](h))}catch(w){f(i[0][3],w)}}function p(u){u.value instanceof nt?Promise.resolve(u.value.v).then(c,l):f(i[0][2],u)}function c(u){s("next",u)}function l(u){s("throw",u)}function f(u,h){u(h),i.shift(),i.length&&s(i[0][0],i[0][1])}}function mo(e){if(!Symbol.asyncIterator)throw new TypeError("Symbol.asyncIterator is not defined.");var t=e[Symbol.asyncIterator],r;return t?t.call(e):(e=typeof de=="function"?de(e):e[Symbol.iterator](),r={},o("next"),o("throw"),o("return"),r[Symbol.asyncIterator]=function(){return this},r);function o(i){r[i]=e[i]&&function(a){return new Promise(function(s,p){a=e[i](a),n(s,p,a.done,a.value)})}}function n(i,a,s,p){Promise.resolve(p).then(function(c){i({value:c,done:s})},a)}}function k(e){return typeof e=="function"}function ft(e){var t=function(o){Error.call(o),o.stack=new Error().stack},r=e(t);return r.prototype=Object.create(Error.prototype),r.prototype.constructor=r,r}var zt=ft(function(e){return function(r){e(this),this.message=r?r.length+` errors occurred during unsubscription: +`+r.map(function(o,n){return n+1+") "+o.toString()}).join(` + `):"",this.name="UnsubscriptionError",this.errors=r}});function qe(e,t){if(e){var r=e.indexOf(t);0<=r&&e.splice(r,1)}}var Fe=function(){function e(t){this.initialTeardown=t,this.closed=!1,this._parentage=null,this._finalizers=null}return e.prototype.unsubscribe=function(){var t,r,o,n,i;if(!this.closed){this.closed=!0;var a=this._parentage;if(a)if(this._parentage=null,Array.isArray(a))try{for(var s=de(a),p=s.next();!p.done;p=s.next()){var c=p.value;c.remove(this)}}catch(A){t={error:A}}finally{try{p&&!p.done&&(r=s.return)&&r.call(s)}finally{if(t)throw t.error}}else a.remove(this);var l=this.initialTeardown;if(k(l))try{l()}catch(A){i=A instanceof zt?A.errors:[A]}var f=this._finalizers;if(f){this._finalizers=null;try{for(var u=de(f),h=u.next();!h.done;h=u.next()){var w=h.value;try{fo(w)}catch(A){i=i!=null?i:[],A instanceof zt?i=q(q([],N(i)),N(A.errors)):i.push(A)}}}catch(A){o={error:A}}finally{try{h&&!h.done&&(n=u.return)&&n.call(u)}finally{if(o)throw o.error}}}if(i)throw new zt(i)}},e.prototype.add=function(t){var r;if(t&&t!==this)if(this.closed)fo(t);else{if(t instanceof e){if(t.closed||t._hasParent(this))return;t._addParent(this)}(this._finalizers=(r=this._finalizers)!==null&&r!==void 0?r:[]).push(t)}},e.prototype._hasParent=function(t){var r=this._parentage;return r===t||Array.isArray(r)&&r.includes(t)},e.prototype._addParent=function(t){var r=this._parentage;this._parentage=Array.isArray(r)?(r.push(t),r):r?[r,t]:t},e.prototype._removeParent=function(t){var r=this._parentage;r===t?this._parentage=null:Array.isArray(r)&&qe(r,t)},e.prototype.remove=function(t){var r=this._finalizers;r&&qe(r,t),t instanceof e&&t._removeParent(this)},e.EMPTY=function(){var t=new e;return t.closed=!0,t}(),e}();var Tr=Fe.EMPTY;function qt(e){return e instanceof Fe||e&&"closed"in e&&k(e.remove)&&k(e.add)&&k(e.unsubscribe)}function fo(e){k(e)?e():e.unsubscribe()}var $e={onUnhandledError:null,onStoppedNotification:null,Promise:void 0,useDeprecatedSynchronousErrorHandling:!1,useDeprecatedNextContext:!1};var ut={setTimeout:function(e,t){for(var r=[],o=2;o0},enumerable:!1,configurable:!0}),t.prototype._trySubscribe=function(r){return this._throwIfClosed(),e.prototype._trySubscribe.call(this,r)},t.prototype._subscribe=function(r){return this._throwIfClosed(),this._checkFinalizedStatuses(r),this._innerSubscribe(r)},t.prototype._innerSubscribe=function(r){var o=this,n=this,i=n.hasError,a=n.isStopped,s=n.observers;return i||a?Tr:(this.currentObservers=null,s.push(r),new Fe(function(){o.currentObservers=null,qe(s,r)}))},t.prototype._checkFinalizedStatuses=function(r){var o=this,n=o.hasError,i=o.thrownError,a=o.isStopped;n?r.error(i):a&&r.complete()},t.prototype.asObservable=function(){var r=new F;return r.source=this,r},t.create=function(r,o){return new Eo(r,o)},t}(F);var Eo=function(e){re(t,e);function t(r,o){var n=e.call(this)||this;return n.destination=r,n.source=o,n}return t.prototype.next=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.next)===null||n===void 0||n.call(o,r)},t.prototype.error=function(r){var o,n;(n=(o=this.destination)===null||o===void 0?void 0:o.error)===null||n===void 0||n.call(o,r)},t.prototype.complete=function(){var r,o;(o=(r=this.destination)===null||r===void 0?void 0:r.complete)===null||o===void 0||o.call(r)},t.prototype._subscribe=function(r){var o,n;return(n=(o=this.source)===null||o===void 0?void 0:o.subscribe(r))!==null&&n!==void 0?n:Tr},t}(g);var _r=function(e){re(t,e);function t(r){var o=e.call(this)||this;return o._value=r,o}return Object.defineProperty(t.prototype,"value",{get:function(){return this.getValue()},enumerable:!1,configurable:!0}),t.prototype._subscribe=function(r){var o=e.prototype._subscribe.call(this,r);return!o.closed&&r.next(this._value),o},t.prototype.getValue=function(){var r=this,o=r.hasError,n=r.thrownError,i=r._value;if(o)throw n;return this._throwIfClosed(),i},t.prototype.next=function(r){e.prototype.next.call(this,this._value=r)},t}(g);var Lt={now:function(){return(Lt.delegate||Date).now()},delegate:void 0};var _t=function(e){re(t,e);function t(r,o,n){r===void 0&&(r=1/0),o===void 0&&(o=1/0),n===void 0&&(n=Lt);var i=e.call(this)||this;return i._bufferSize=r,i._windowTime=o,i._timestampProvider=n,i._buffer=[],i._infiniteTimeWindow=!0,i._infiniteTimeWindow=o===1/0,i._bufferSize=Math.max(1,r),i._windowTime=Math.max(1,o),i}return t.prototype.next=function(r){var o=this,n=o.isStopped,i=o._buffer,a=o._infiniteTimeWindow,s=o._timestampProvider,p=o._windowTime;n||(i.push(r),!a&&i.push(s.now()+p)),this._trimBuffer(),e.prototype.next.call(this,r)},t.prototype._subscribe=function(r){this._throwIfClosed(),this._trimBuffer();for(var o=this._innerSubscribe(r),n=this,i=n._infiniteTimeWindow,a=n._buffer,s=a.slice(),p=0;p0?e.prototype.schedule.call(this,r,o):(this.delay=o,this.state=r,this.scheduler.flush(this),this)},t.prototype.execute=function(r,o){return o>0||this.closed?e.prototype.execute.call(this,r,o):this._execute(r,o)},t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!=null&&n>0||n==null&&this.delay>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.flush(this),0)},t}(vt);var So=function(e){re(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t}(gt);var Hr=new So(To);var Oo=function(e){re(t,e);function t(r,o){var n=e.call(this,r,o)||this;return n.scheduler=r,n.work=o,n}return t.prototype.requestAsyncId=function(r,o,n){return n===void 0&&(n=0),n!==null&&n>0?e.prototype.requestAsyncId.call(this,r,o,n):(r.actions.push(this),r._scheduled||(r._scheduled=bt.requestAnimationFrame(function(){return r.flush(void 0)})))},t.prototype.recycleAsyncId=function(r,o,n){var i;if(n===void 0&&(n=0),n!=null?n>0:this.delay>0)return e.prototype.recycleAsyncId.call(this,r,o,n);var a=r.actions;o!=null&&((i=a[a.length-1])===null||i===void 0?void 0:i.id)!==o&&(bt.cancelAnimationFrame(o),r._scheduled=void 0)},t}(vt);var Mo=function(e){re(t,e);function t(){return e!==null&&e.apply(this,arguments)||this}return t.prototype.flush=function(r){this._active=!0;var o=this._scheduled;this._scheduled=void 0;var n=this.actions,i;r=r||n.shift();do if(i=r.execute(r.state,r.delay))break;while((r=n[0])&&r.id===o&&n.shift());if(this._active=!1,i){for(;(r=n[0])&&r.id===o&&n.shift();)r.unsubscribe();throw i}},t}(gt);var me=new Mo(Oo);var M=new F(function(e){return e.complete()});function Yt(e){return e&&k(e.schedule)}function kr(e){return e[e.length-1]}function Xe(e){return k(kr(e))?e.pop():void 0}function He(e){return Yt(kr(e))?e.pop():void 0}function Bt(e,t){return typeof kr(e)=="number"?e.pop():t}var xt=function(e){return e&&typeof e.length=="number"&&typeof e!="function"};function Gt(e){return k(e==null?void 0:e.then)}function Jt(e){return k(e[ht])}function Xt(e){return Symbol.asyncIterator&&k(e==null?void 0:e[Symbol.asyncIterator])}function Zt(e){return new TypeError("You provided "+(e!==null&&typeof e=="object"?"an invalid object":"'"+e+"'")+" where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.")}function Gi(){return typeof Symbol!="function"||!Symbol.iterator?"@@iterator":Symbol.iterator}var er=Gi();function tr(e){return k(e==null?void 0:e[er])}function rr(e){return lo(this,arguments,function(){var r,o,n,i;return Nt(this,function(a){switch(a.label){case 0:r=e.getReader(),a.label=1;case 1:a.trys.push([1,,9,10]),a.label=2;case 2:return[4,nt(r.read())];case 3:return o=a.sent(),n=o.value,i=o.done,i?[4,nt(void 0)]:[3,5];case 4:return[2,a.sent()];case 5:return[4,nt(n)];case 6:return[4,a.sent()];case 7:return a.sent(),[3,2];case 8:return[3,10];case 9:return r.releaseLock(),[7];case 10:return[2]}})})}function or(e){return k(e==null?void 0:e.getReader)}function W(e){if(e instanceof F)return e;if(e!=null){if(Jt(e))return Ji(e);if(xt(e))return Xi(e);if(Gt(e))return Zi(e);if(Xt(e))return Lo(e);if(tr(e))return ea(e);if(or(e))return ta(e)}throw Zt(e)}function Ji(e){return new F(function(t){var r=e[ht]();if(k(r.subscribe))return r.subscribe(t);throw new TypeError("Provided object does not correctly implement Symbol.observable")})}function Xi(e){return new F(function(t){for(var r=0;r=2;return function(o){return o.pipe(e?b(function(n,i){return e(n,i,o)}):le,we(1),r?Be(t):zo(function(){return new ir}))}}function Fr(e){return e<=0?function(){return M}:x(function(t,r){var o=[];t.subscribe(T(r,function(n){o.push(n),e=2,!0))}function pe(e){e===void 0&&(e={});var t=e.connector,r=t===void 0?function(){return new g}:t,o=e.resetOnError,n=o===void 0?!0:o,i=e.resetOnComplete,a=i===void 0?!0:i,s=e.resetOnRefCountZero,p=s===void 0?!0:s;return function(c){var l,f,u,h=0,w=!1,A=!1,te=function(){f==null||f.unsubscribe(),f=void 0},ie=function(){te(),l=u=void 0,w=A=!1},J=function(){var H=l;ie(),H==null||H.unsubscribe()};return x(function(H,mt){h++,!A&&!w&&te();var ze=u=u!=null?u:r();mt.add(function(){h--,h===0&&!A&&!w&&(f=Wr(J,p))}),ze.subscribe(mt),!l&&h>0&&(l=new at({next:function(Ie){return ze.next(Ie)},error:function(Ie){A=!0,te(),f=Wr(ie,n,Ie),ze.error(Ie)},complete:function(){w=!0,te(),f=Wr(ie,a),ze.complete()}}),W(H).subscribe(l))})(c)}}function Wr(e,t){for(var r=[],o=2;oe.next(document)),e}function $(e,t=document){return Array.from(t.querySelectorAll(e))}function P(e,t=document){let r=fe(e,t);if(typeof r=="undefined")throw new ReferenceError(`Missing element: expected "${e}" to be present`);return r}function fe(e,t=document){return t.querySelector(e)||void 0}function Re(){var e,t,r,o;return(o=(r=(t=(e=document.activeElement)==null?void 0:e.shadowRoot)==null?void 0:t.activeElement)!=null?r:document.activeElement)!=null?o:void 0}var xa=S(d(document.body,"focusin"),d(document.body,"focusout")).pipe(_e(1),Q(void 0),m(()=>Re()||document.body),B(1));function et(e){return xa.pipe(m(t=>e.contains(t)),K())}function kt(e,t){return C(()=>S(d(e,"mouseenter").pipe(m(()=>!0)),d(e,"mouseleave").pipe(m(()=>!1))).pipe(t?Ht(r=>Me(+!r*t)):le,Q(e.matches(":hover"))))}function Bo(e,t){if(typeof t=="string"||typeof t=="number")e.innerHTML+=t.toString();else if(t instanceof Node)e.appendChild(t);else if(Array.isArray(t))for(let r of t)Bo(e,r)}function E(e,t,...r){let o=document.createElement(e);if(t)for(let n of Object.keys(t))typeof t[n]!="undefined"&&(typeof t[n]!="boolean"?o.setAttribute(n,t[n]):o.setAttribute(n,""));for(let n of r)Bo(o,n);return o}function sr(e){if(e>999){let t=+((e-950)%1e3>99);return`${((e+1e-6)/1e3).toFixed(t)}k`}else return e.toString()}function wt(e){let t=E("script",{src:e});return C(()=>(document.head.appendChild(t),S(d(t,"load"),d(t,"error").pipe(v(()=>$r(()=>new ReferenceError(`Invalid script: ${e}`))))).pipe(m(()=>{}),L(()=>document.head.removeChild(t)),we(1))))}var Go=new g,ya=C(()=>typeof ResizeObserver=="undefined"?wt("https://unpkg.com/resize-observer-polyfill"):I(void 0)).pipe(m(()=>new ResizeObserver(e=>e.forEach(t=>Go.next(t)))),v(e=>S(Ke,I(e)).pipe(L(()=>e.disconnect()))),B(1));function ce(e){return{width:e.offsetWidth,height:e.offsetHeight}}function ge(e){let t=e;for(;t.clientWidth===0&&t.parentElement;)t=t.parentElement;return ya.pipe(y(r=>r.observe(t)),v(r=>Go.pipe(b(o=>o.target===t),L(()=>r.unobserve(t)))),m(()=>ce(e)),Q(ce(e)))}function Tt(e){return{width:e.scrollWidth,height:e.scrollHeight}}function cr(e){let t=e.parentElement;for(;t&&(e.scrollWidth<=t.scrollWidth&&e.scrollHeight<=t.scrollHeight);)t=(e=t).parentElement;return t?e:void 0}function Jo(e){let t=[],r=e.parentElement;for(;r;)(e.clientWidth>r.clientWidth||e.clientHeight>r.clientHeight)&&t.push(r),r=(e=r).parentElement;return t.length===0&&t.push(document.documentElement),t}function Ue(e){return{x:e.offsetLeft,y:e.offsetTop}}function Xo(e){let t=e.getBoundingClientRect();return{x:t.x+window.scrollX,y:t.y+window.scrollY}}function Zo(e){return S(d(window,"load"),d(window,"resize")).pipe(Le(0,me),m(()=>Ue(e)),Q(Ue(e)))}function pr(e){return{x:e.scrollLeft,y:e.scrollTop}}function De(e){return S(d(e,"scroll"),d(window,"scroll"),d(window,"resize")).pipe(Le(0,me),m(()=>pr(e)),Q(pr(e)))}var en=new g,Ea=C(()=>I(new IntersectionObserver(e=>{for(let t of e)en.next(t)},{threshold:0}))).pipe(v(e=>S(Ke,I(e)).pipe(L(()=>e.disconnect()))),B(1));function tt(e){return Ea.pipe(y(t=>t.observe(e)),v(t=>en.pipe(b(({target:r})=>r===e),L(()=>t.unobserve(e)),m(({isIntersecting:r})=>r))))}function tn(e,t=16){return De(e).pipe(m(({y:r})=>{let o=ce(e),n=Tt(e);return r>=n.height-o.height-t}),K())}var lr={drawer:P("[data-md-toggle=drawer]"),search:P("[data-md-toggle=search]")};function rn(e){return lr[e].checked}function Je(e,t){lr[e].checked!==t&&lr[e].click()}function Ve(e){let t=lr[e];return d(t,"change").pipe(m(()=>t.checked),Q(t.checked))}function wa(e,t){switch(e.constructor){case HTMLInputElement:return e.type==="radio"?/^Arrow/.test(t):!0;case HTMLSelectElement:case HTMLTextAreaElement:return!0;default:return e.isContentEditable}}function Ta(){return S(d(window,"compositionstart").pipe(m(()=>!0)),d(window,"compositionend").pipe(m(()=>!1))).pipe(Q(!1))}function on(){let e=d(window,"keydown").pipe(b(t=>!(t.metaKey||t.ctrlKey)),m(t=>({mode:rn("search")?"search":"global",type:t.key,claim(){t.preventDefault(),t.stopPropagation()}})),b(({mode:t,type:r})=>{if(t==="global"){let o=Re();if(typeof o!="undefined")return!wa(o,r)}return!0}),pe());return Ta().pipe(v(t=>t?M:e))}function xe(){return new URL(location.href)}function pt(e,t=!1){if(G("navigation.instant")&&!t){let r=E("a",{href:e.href});document.body.appendChild(r),r.click(),r.remove()}else location.href=e.href}function nn(){return new g}function an(){return location.hash.slice(1)}function sn(e){let t=E("a",{href:e});t.addEventListener("click",r=>r.stopPropagation()),t.click()}function Sa(e){return S(d(window,"hashchange"),e).pipe(m(an),Q(an()),b(t=>t.length>0),B(1))}function cn(e){return Sa(e).pipe(m(t=>fe(`[id="${t}"]`)),b(t=>typeof t!="undefined"))}function $t(e){let t=matchMedia(e);return ar(r=>t.addListener(()=>r(t.matches))).pipe(Q(t.matches))}function pn(){let e=matchMedia("print");return S(d(window,"beforeprint").pipe(m(()=>!0)),d(window,"afterprint").pipe(m(()=>!1))).pipe(Q(e.matches))}function Nr(e,t){return e.pipe(v(r=>r?t():M))}function zr(e,t){return new F(r=>{let o=new XMLHttpRequest;return o.open("GET",`${e}`),o.responseType="blob",o.addEventListener("load",()=>{o.status>=200&&o.status<300?(r.next(o.response),r.complete()):r.error(new Error(o.statusText))}),o.addEventListener("error",()=>{r.error(new Error("Network error"))}),o.addEventListener("abort",()=>{r.complete()}),typeof(t==null?void 0:t.progress$)!="undefined"&&(o.addEventListener("progress",n=>{var i;if(n.lengthComputable)t.progress$.next(n.loaded/n.total*100);else{let a=(i=o.getResponseHeader("Content-Length"))!=null?i:0;t.progress$.next(n.loaded/+a*100)}}),t.progress$.next(5)),o.send(),()=>o.abort()})}function Ne(e,t){return zr(e,t).pipe(v(r=>r.text()),m(r=>JSON.parse(r)),B(1))}function ln(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/html")),B(1))}function mn(e,t){let r=new DOMParser;return zr(e,t).pipe(v(o=>o.text()),m(o=>r.parseFromString(o,"text/xml")),B(1))}function fn(){return{x:Math.max(0,scrollX),y:Math.max(0,scrollY)}}function un(){return S(d(window,"scroll",{passive:!0}),d(window,"resize",{passive:!0})).pipe(m(fn),Q(fn()))}function dn(){return{width:innerWidth,height:innerHeight}}function hn(){return d(window,"resize",{passive:!0}).pipe(m(dn),Q(dn()))}function bn(){return z([un(),hn()]).pipe(m(([e,t])=>({offset:e,size:t})),B(1))}function mr(e,{viewport$:t,header$:r}){let o=t.pipe(Z("size")),n=z([o,r]).pipe(m(()=>Ue(e)));return z([r,t,n]).pipe(m(([{height:i},{offset:a,size:s},{x:p,y:c}])=>({offset:{x:a.x-p,y:a.y-c+i},size:s})))}function Oa(e){return d(e,"message",t=>t.data)}function Ma(e){let t=new g;return t.subscribe(r=>e.postMessage(r)),t}function vn(e,t=new Worker(e)){let r=Oa(t),o=Ma(t),n=new g;n.subscribe(o);let i=o.pipe(X(),ne(!0));return n.pipe(X(),Pe(r.pipe(U(i))),pe())}var La=P("#__config"),St=JSON.parse(La.textContent);St.base=`${new URL(St.base,xe())}`;function Te(){return St}function G(e){return St.features.includes(e)}function ye(e,t){return typeof t!="undefined"?St.translations[e].replace("#",t.toString()):St.translations[e]}function Se(e,t=document){return P(`[data-md-component=${e}]`,t)}function ae(e,t=document){return $(`[data-md-component=${e}]`,t)}function _a(e){let t=P(".md-typeset > :first-child",e);return d(t,"click",{once:!0}).pipe(m(()=>P(".md-typeset",e)),m(r=>({hash:__md_hash(r.innerHTML)})))}function gn(e){if(!G("announce.dismiss")||!e.childElementCount)return M;if(!e.hidden){let t=P(".md-typeset",e);__md_hash(t.innerHTML)===__md_get("__announce")&&(e.hidden=!0)}return C(()=>{let t=new g;return t.subscribe(({hash:r})=>{e.hidden=!0,__md_set("__announce",r)}),_a(e).pipe(y(r=>t.next(r)),L(()=>t.complete()),m(r=>R({ref:e},r)))})}function Aa(e,{target$:t}){return t.pipe(m(r=>({hidden:r!==e})))}function xn(e,t){let r=new g;return r.subscribe(({hidden:o})=>{e.hidden=o}),Aa(e,t).pipe(y(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))}function Pt(e,t){return t==="inline"?E("div",{class:"md-tooltip md-tooltip--inline",id:e,role:"tooltip"},E("div",{class:"md-tooltip__inner md-typeset"})):E("div",{class:"md-tooltip",id:e,role:"tooltip"},E("div",{class:"md-tooltip__inner md-typeset"}))}function yn(...e){return E("div",{class:"md-tooltip2",role:"tooltip"},E("div",{class:"md-tooltip2__inner md-typeset"},e))}function En(e,t){if(t=t?`${t}_annotation_${e}`:void 0,t){let r=t?`#${t}`:void 0;return E("aside",{class:"md-annotation",tabIndex:0},Pt(t),E("a",{href:r,class:"md-annotation__index",tabIndex:-1},E("span",{"data-md-annotation-id":e})))}else return E("aside",{class:"md-annotation",tabIndex:0},Pt(t),E("span",{class:"md-annotation__index",tabIndex:-1},E("span",{"data-md-annotation-id":e})))}function wn(e){return E("button",{class:"md-clipboard md-icon",title:ye("clipboard.copy"),"data-clipboard-target":`#${e} > code`})}function qr(e,t){let r=t&2,o=t&1,n=Object.keys(e.terms).filter(p=>!e.terms[p]).reduce((p,c)=>[...p,E("del",null,c)," "],[]).slice(0,-1),i=Te(),a=new URL(e.location,i.base);G("search.highlight")&&a.searchParams.set("h",Object.entries(e.terms).filter(([,p])=>p).reduce((p,[c])=>`${p} ${c}`.trim(),""));let{tags:s}=Te();return E("a",{href:`${a}`,class:"md-search-result__link",tabIndex:-1},E("article",{class:"md-search-result__article md-typeset","data-md-score":e.score.toFixed(2)},r>0&&E("div",{class:"md-search-result__icon md-icon"}),r>0&&E("h1",null,e.title),r<=0&&E("h2",null,e.title),o>0&&e.text.length>0&&e.text,e.tags&&e.tags.map(p=>{let c=s?p in s?`md-tag-icon md-tag--${s[p]}`:"md-tag-icon":"";return E("span",{class:`md-tag ${c}`},p)}),o>0&&n.length>0&&E("p",{class:"md-search-result__terms"},ye("search.result.term.missing"),": ",...n)))}function Tn(e){let t=e[0].score,r=[...e],o=Te(),n=r.findIndex(l=>!`${new URL(l.location,o.base)}`.includes("#")),[i]=r.splice(n,1),a=r.findIndex(l=>l.scoreqr(l,1)),...p.length?[E("details",{class:"md-search-result__more"},E("summary",{tabIndex:-1},E("div",null,p.length>0&&p.length===1?ye("search.result.more.one"):ye("search.result.more.other",p.length))),...p.map(l=>qr(l,1)))]:[]];return E("li",{class:"md-search-result__item"},c)}function Sn(e){return E("ul",{class:"md-source__facts"},Object.entries(e).map(([t,r])=>E("li",{class:`md-source__fact md-source__fact--${t}`},typeof r=="number"?sr(r):r)))}function Qr(e){let t=`tabbed-control tabbed-control--${e}`;return E("div",{class:t,hidden:!0},E("button",{class:"tabbed-button",tabIndex:-1,"aria-hidden":"true"}))}function On(e){return E("div",{class:"md-typeset__scrollwrap"},E("div",{class:"md-typeset__table"},e))}function Ca(e){let t=Te(),r=new URL(`../${e.version}/`,t.base);return E("li",{class:"md-version__item"},E("a",{href:`${r}`,class:"md-version__link"},e.title))}function Mn(e,t){return e=e.filter(r=>{var o;return!((o=r.properties)!=null&&o.hidden)}),E("div",{class:"md-version"},E("button",{class:"md-version__current","aria-label":ye("select.version")},t.title),E("ul",{class:"md-version__list"},e.map(Ca)))}var Ha=0;function ka(e){let t=z([et(e),kt(e)]).pipe(m(([o,n])=>o||n),K()),r=C(()=>Jo(e)).pipe(oe(De),ct(1),m(()=>Xo(e)));return t.pipe(Ae(o=>o),v(()=>z([t,r])),m(([o,n])=>({active:o,offset:n})),pe())}function $a(e,t){let{content$:r,viewport$:o}=t,n=`__tooltip2_${Ha++}`;return C(()=>{let i=new g,a=new _r(!1);i.pipe(X(),ne(!1)).subscribe(a);let s=a.pipe(Ht(c=>Me(+!c*250,Hr)),K(),v(c=>c?r:M),y(c=>c.id=n),pe());z([i.pipe(m(({active:c})=>c)),s.pipe(v(c=>kt(c,250)),Q(!1))]).pipe(m(c=>c.some(l=>l))).subscribe(a);let p=a.pipe(b(c=>c),ee(s,o),m(([c,l,{size:f}])=>{let u=e.getBoundingClientRect(),h=u.width/2;if(l.role==="tooltip")return{x:h,y:8+u.height};if(u.y>=f.height/2){let{height:w}=ce(l);return{x:h,y:-16-w}}else return{x:h,y:16+u.height}}));return z([s,i,p]).subscribe(([c,{offset:l},f])=>{c.style.setProperty("--md-tooltip-host-x",`${l.x}px`),c.style.setProperty("--md-tooltip-host-y",`${l.y}px`),c.style.setProperty("--md-tooltip-x",`${f.x}px`),c.style.setProperty("--md-tooltip-y",`${f.y}px`),c.classList.toggle("md-tooltip2--top",f.y<0),c.classList.toggle("md-tooltip2--bottom",f.y>=0)}),a.pipe(b(c=>c),ee(s,(c,l)=>l),b(c=>c.role==="tooltip")).subscribe(c=>{let l=ce(P(":scope > *",c));c.style.setProperty("--md-tooltip-width",`${l.width}px`),c.style.setProperty("--md-tooltip-tail","0px")}),a.pipe(K(),be(me),ee(s)).subscribe(([c,l])=>{l.classList.toggle("md-tooltip2--active",c)}),z([a.pipe(b(c=>c)),s]).subscribe(([c,l])=>{l.role==="dialog"?(e.setAttribute("aria-controls",n),e.setAttribute("aria-haspopup","dialog")):e.setAttribute("aria-describedby",n)}),a.pipe(b(c=>!c)).subscribe(()=>{e.removeAttribute("aria-controls"),e.removeAttribute("aria-describedby"),e.removeAttribute("aria-haspopup")}),ka(e).pipe(y(c=>i.next(c)),L(()=>i.complete()),m(c=>R({ref:e},c)))})}function lt(e,{viewport$:t},r=document.body){return $a(e,{content$:new F(o=>{let n=e.title,i=yn(n);return o.next(i),e.removeAttribute("title"),r.append(i),()=>{i.remove(),e.setAttribute("title",n)}}),viewport$:t})}function Pa(e,t){let r=C(()=>z([Zo(e),De(t)])).pipe(m(([{x:o,y:n},i])=>{let{width:a,height:s}=ce(e);return{x:o-i.x+a/2,y:n-i.y+s/2}}));return et(e).pipe(v(o=>r.pipe(m(n=>({active:o,offset:n})),we(+!o||1/0))))}function Ln(e,t,{target$:r}){let[o,n]=Array.from(e.children);return C(()=>{let i=new g,a=i.pipe(X(),ne(!0));return i.subscribe({next({offset:s}){e.style.setProperty("--md-tooltip-x",`${s.x}px`),e.style.setProperty("--md-tooltip-y",`${s.y}px`)},complete(){e.style.removeProperty("--md-tooltip-x"),e.style.removeProperty("--md-tooltip-y")}}),tt(e).pipe(U(a)).subscribe(s=>{e.toggleAttribute("data-md-visible",s)}),S(i.pipe(b(({active:s})=>s)),i.pipe(_e(250),b(({active:s})=>!s))).subscribe({next({active:s}){s?e.prepend(o):o.remove()},complete(){e.prepend(o)}}),i.pipe(Le(16,me)).subscribe(({active:s})=>{o.classList.toggle("md-tooltip--active",s)}),i.pipe(ct(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:s})=>s)).subscribe({next(s){s?e.style.setProperty("--md-tooltip-0",`${-s}px`):e.style.removeProperty("--md-tooltip-0")},complete(){e.style.removeProperty("--md-tooltip-0")}}),d(n,"click").pipe(U(a),b(s=>!(s.metaKey||s.ctrlKey))).subscribe(s=>{s.stopPropagation(),s.preventDefault()}),d(n,"mousedown").pipe(U(a),ee(i)).subscribe(([s,{active:p}])=>{var c;if(s.button!==0||s.metaKey||s.ctrlKey)s.preventDefault();else if(p){s.preventDefault();let l=e.parentElement.closest(".md-annotation");l instanceof HTMLElement?l.focus():(c=Re())==null||c.blur()}}),r.pipe(U(a),b(s=>s===o),Ge(125)).subscribe(()=>e.focus()),Pa(e,t).pipe(y(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))})}function Ra(e){return e.tagName==="CODE"?$(".c, .c1, .cm",e):[e]}function Ia(e){let t=[];for(let r of Ra(e)){let o=[],n=document.createNodeIterator(r,NodeFilter.SHOW_TEXT);for(let i=n.nextNode();i;i=n.nextNode())o.push(i);for(let i of o){let a;for(;a=/(\(\d+\))(!)?/.exec(i.textContent);){let[,s,p]=a;if(typeof p=="undefined"){let c=i.splitText(a.index);i=c.splitText(s.length),t.push(c)}else{i.textContent=s,t.push(i);break}}}}return t}function _n(e,t){t.append(...Array.from(e.childNodes))}function fr(e,t,{target$:r,print$:o}){let n=t.closest("[id]"),i=n==null?void 0:n.id,a=new Map;for(let s of Ia(t)){let[,p]=s.textContent.match(/\((\d+)\)/);fe(`:scope > li:nth-child(${p})`,e)&&(a.set(p,En(p,i)),s.replaceWith(a.get(p)))}return a.size===0?M:C(()=>{let s=new g,p=s.pipe(X(),ne(!0)),c=[];for(let[l,f]of a)c.push([P(".md-typeset",f),P(`:scope > li:nth-child(${l})`,e)]);return o.pipe(U(p)).subscribe(l=>{e.hidden=!l,e.classList.toggle("md-annotation-list",l);for(let[f,u]of c)l?_n(f,u):_n(u,f)}),S(...[...a].map(([,l])=>Ln(l,t,{target$:r}))).pipe(L(()=>s.complete()),pe())})}function An(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return An(t)}}function Cn(e,t){return C(()=>{let r=An(e);return typeof r!="undefined"?fr(r,e,t):M})}var Hn=Vt(Yr());var Fa=0;function kn(e){if(e.nextElementSibling){let t=e.nextElementSibling;if(t.tagName==="OL")return t;if(t.tagName==="P"&&!t.children.length)return kn(t)}}function ja(e){return ge(e).pipe(m(({width:t})=>({scrollable:Tt(e).width>t})),Z("scrollable"))}function $n(e,t){let{matches:r}=matchMedia("(hover)"),o=C(()=>{let n=new g,i=n.pipe(Fr(1));n.subscribe(({scrollable:c})=>{c&&r?e.setAttribute("tabindex","0"):e.removeAttribute("tabindex")});let a=[];if(Hn.default.isSupported()&&(e.closest(".copy")||G("content.code.copy")&&!e.closest(".no-copy"))){let c=e.closest("pre");c.id=`__code_${Fa++}`;let l=wn(c.id);c.insertBefore(l,e),G("content.tooltips")&&a.push(lt(l,{viewport$}))}let s=e.closest(".highlight");if(s instanceof HTMLElement){let c=kn(s);if(typeof c!="undefined"&&(s.classList.contains("annotate")||G("content.code.annotate"))){let l=fr(c,e,t);a.push(ge(s).pipe(U(i),m(({width:f,height:u})=>f&&u),K(),v(f=>f?l:M)))}}return $(":scope > span[id]",e).length&&e.classList.add("md-code__content"),ja(e).pipe(y(c=>n.next(c)),L(()=>n.complete()),m(c=>R({ref:e},c)),Pe(...a))});return G("content.lazy")?tt(e).pipe(b(n=>n),we(1),v(()=>o)):o}function Wa(e,{target$:t,print$:r}){let o=!0;return S(t.pipe(m(n=>n.closest("details:not([open])")),b(n=>e===n),m(()=>({action:"open",reveal:!0}))),r.pipe(b(n=>n||!o),y(()=>o=e.open),m(n=>({action:n?"open":"close"}))))}function Pn(e,t){return C(()=>{let r=new g;return r.subscribe(({action:o,reveal:n})=>{e.toggleAttribute("open",o==="open"),n&&e.scrollIntoView()}),Wa(e,t).pipe(y(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}var Rn=".node circle,.node ellipse,.node path,.node polygon,.node rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}marker{fill:var(--md-mermaid-edge-color)!important}.edgeLabel .label rect{fill:#0000}.label{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.label foreignObject{line-height:normal;overflow:visible}.label div .edgeLabel{color:var(--md-mermaid-label-fg-color)}.edgeLabel,.edgeLabel rect,.label div .edgeLabel{background-color:var(--md-mermaid-label-bg-color)}.edgeLabel,.edgeLabel rect{fill:var(--md-mermaid-label-bg-color);color:var(--md-mermaid-edge-color)}.edgePath .path,.flowchart-link{stroke:var(--md-mermaid-edge-color);stroke-width:.05rem}.edgePath .arrowheadPath{fill:var(--md-mermaid-edge-color);stroke:none}.cluster rect{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}.cluster span{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}g #flowchart-circleEnd,g #flowchart-circleStart,g #flowchart-crossEnd,g #flowchart-crossStart,g #flowchart-pointEnd,g #flowchart-pointStart{stroke:none}g.classGroup line,g.classGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.classGroup text{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.classLabel .box{fill:var(--md-mermaid-label-bg-color);background-color:var(--md-mermaid-label-bg-color);opacity:1}.classLabel .label{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node .divider{stroke:var(--md-mermaid-node-fg-color)}.relation{stroke:var(--md-mermaid-edge-color)}.cardinality{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.cardinality text{fill:inherit!important}defs #classDiagram-compositionEnd,defs #classDiagram-compositionStart,defs #classDiagram-dependencyEnd,defs #classDiagram-dependencyStart,defs #classDiagram-extensionEnd,defs #classDiagram-extensionStart{fill:var(--md-mermaid-edge-color)!important;stroke:var(--md-mermaid-edge-color)!important}defs #classDiagram-aggregationEnd,defs #classDiagram-aggregationStart{fill:var(--md-mermaid-label-bg-color)!important;stroke:var(--md-mermaid-edge-color)!important}g.stateGroup rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}g.stateGroup .state-title{fill:var(--md-mermaid-label-fg-color)!important;font-family:var(--md-mermaid-font-family)}g.stateGroup .composit{fill:var(--md-mermaid-label-bg-color)}.nodeLabel,.nodeLabel p{color:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.node circle.state-end,.node circle.state-start,.start-state{fill:var(--md-mermaid-edge-color);stroke:none}.end-state-inner,.end-state-outer{fill:var(--md-mermaid-edge-color)}.end-state-inner,.node circle.state-end{stroke:var(--md-mermaid-label-bg-color)}.transition{stroke:var(--md-mermaid-edge-color)}[id^=state-fork] rect,[id^=state-join] rect{fill:var(--md-mermaid-edge-color)!important;stroke:none!important}.statediagram-cluster.statediagram-cluster .inner{fill:var(--md-default-bg-color)}.statediagram-cluster rect{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.statediagram-state rect.divider{fill:var(--md-default-fg-color--lightest);stroke:var(--md-default-fg-color--lighter)}defs #statediagram-barbEnd{stroke:var(--md-mermaid-edge-color)}.attributeBoxEven,.attributeBoxOdd{fill:var(--md-mermaid-node-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityBox{fill:var(--md-mermaid-label-bg-color);stroke:var(--md-mermaid-node-fg-color)}.entityLabel{fill:var(--md-mermaid-label-fg-color);font-family:var(--md-mermaid-font-family)}.relationshipLabelBox{fill:var(--md-mermaid-label-bg-color);fill-opacity:1;background-color:var(--md-mermaid-label-bg-color);opacity:1}.relationshipLabel{fill:var(--md-mermaid-label-fg-color)}.relationshipLine{stroke:var(--md-mermaid-edge-color)}defs #ONE_OR_MORE_END *,defs #ONE_OR_MORE_START *,defs #ONLY_ONE_END *,defs #ONLY_ONE_START *,defs #ZERO_OR_MORE_END *,defs #ZERO_OR_MORE_START *,defs #ZERO_OR_ONE_END *,defs #ZERO_OR_ONE_START *{stroke:var(--md-mermaid-edge-color)!important}defs #ZERO_OR_MORE_END circle,defs #ZERO_OR_MORE_START circle{fill:var(--md-mermaid-label-bg-color)}.actor{fill:var(--md-mermaid-sequence-actor-bg-color);stroke:var(--md-mermaid-sequence-actor-border-color)}text.actor>tspan{fill:var(--md-mermaid-sequence-actor-fg-color);font-family:var(--md-mermaid-font-family)}line{stroke:var(--md-mermaid-sequence-actor-line-color)}.actor-man circle,.actor-man line{fill:var(--md-mermaid-sequence-actorman-bg-color);stroke:var(--md-mermaid-sequence-actorman-line-color)}.messageLine0,.messageLine1{stroke:var(--md-mermaid-sequence-message-line-color)}.note{fill:var(--md-mermaid-sequence-note-bg-color);stroke:var(--md-mermaid-sequence-note-border-color)}.loopText,.loopText>tspan,.messageText,.noteText>tspan{stroke:none;font-family:var(--md-mermaid-font-family)!important}.messageText{fill:var(--md-mermaid-sequence-message-fg-color)}.loopText,.loopText>tspan{fill:var(--md-mermaid-sequence-loop-fg-color)}.noteText>tspan{fill:var(--md-mermaid-sequence-note-fg-color)}#arrowhead path{fill:var(--md-mermaid-sequence-message-line-color);stroke:none}.loopLine{fill:var(--md-mermaid-sequence-loop-bg-color);stroke:var(--md-mermaid-sequence-loop-border-color)}.labelBox{fill:var(--md-mermaid-sequence-label-bg-color);stroke:none}.labelText,.labelText>span{fill:var(--md-mermaid-sequence-label-fg-color);font-family:var(--md-mermaid-font-family)}.sequenceNumber{fill:var(--md-mermaid-sequence-number-fg-color)}rect.rect{fill:var(--md-mermaid-sequence-box-bg-color);stroke:none}rect.rect+text.text{fill:var(--md-mermaid-sequence-box-fg-color)}defs #sequencenumber{fill:var(--md-mermaid-sequence-number-bg-color)!important}";var Br,Da=0;function Va(){return typeof mermaid=="undefined"||mermaid instanceof Element?wt("https://unpkg.com/mermaid@10/dist/mermaid.min.js"):I(void 0)}function In(e){return e.classList.remove("mermaid"),Br||(Br=Va().pipe(y(()=>mermaid.initialize({startOnLoad:!1,themeCSS:Rn,sequence:{actorFontSize:"16px",messageFontSize:"16px",noteFontSize:"16px"}})),m(()=>{}),B(1))),Br.subscribe(()=>ao(this,null,function*(){e.classList.add("mermaid");let t=`__mermaid_${Da++}`,r=E("div",{class:"mermaid"}),o=e.textContent,{svg:n,fn:i}=yield mermaid.render(t,o),a=r.attachShadow({mode:"closed"});a.innerHTML=n,e.replaceWith(r),i==null||i(a)})),Br.pipe(m(()=>({ref:e})))}var Fn=E("table");function jn(e){return e.replaceWith(Fn),Fn.replaceWith(On(e)),I({ref:e})}function Na(e){let t=e.find(r=>r.checked)||e[0];return S(...e.map(r=>d(r,"change").pipe(m(()=>P(`label[for="${r.id}"]`))))).pipe(Q(P(`label[for="${t.id}"]`)),m(r=>({active:r})))}function Wn(e,{viewport$:t,target$:r}){let o=P(".tabbed-labels",e),n=$(":scope > input",e),i=Qr("prev");e.append(i);let a=Qr("next");return e.append(a),C(()=>{let s=new g,p=s.pipe(X(),ne(!0));z([s,ge(e)]).pipe(U(p),Le(1,me)).subscribe({next([{active:c},l]){let f=Ue(c),{width:u}=ce(c);e.style.setProperty("--md-indicator-x",`${f.x}px`),e.style.setProperty("--md-indicator-width",`${u}px`);let h=pr(o);(f.xh.x+l.width)&&o.scrollTo({left:Math.max(0,f.x-16),behavior:"smooth"})},complete(){e.style.removeProperty("--md-indicator-x"),e.style.removeProperty("--md-indicator-width")}}),z([De(o),ge(o)]).pipe(U(p)).subscribe(([c,l])=>{let f=Tt(o);i.hidden=c.x<16,a.hidden=c.x>f.width-l.width-16}),S(d(i,"click").pipe(m(()=>-1)),d(a,"click").pipe(m(()=>1))).pipe(U(p)).subscribe(c=>{let{width:l}=ce(o);o.scrollBy({left:l*c,behavior:"smooth"})}),r.pipe(U(p),b(c=>n.includes(c))).subscribe(c=>c.click()),o.classList.add("tabbed-labels--linked");for(let c of n){let l=P(`label[for="${c.id}"]`);l.replaceChildren(E("a",{href:`#${l.htmlFor}`,tabIndex:-1},...Array.from(l.childNodes))),d(l.firstElementChild,"click").pipe(U(p),b(f=>!(f.metaKey||f.ctrlKey)),y(f=>{f.preventDefault(),f.stopPropagation()})).subscribe(()=>{history.replaceState({},"",`#${l.htmlFor}`),l.click()})}return G("content.tabs.link")&&s.pipe(Ce(1),ee(t)).subscribe(([{active:c},{offset:l}])=>{let f=c.innerText.trim();if(c.hasAttribute("data-md-switching"))c.removeAttribute("data-md-switching");else{let u=e.offsetTop-l.y;for(let w of $("[data-tabs]"))for(let A of $(":scope > input",w)){let te=P(`label[for="${A.id}"]`);if(te!==c&&te.innerText.trim()===f){te.setAttribute("data-md-switching",""),A.click();break}}window.scrollTo({top:e.offsetTop-u});let h=__md_get("__tabs")||[];__md_set("__tabs",[...new Set([f,...h])])}}),s.pipe(U(p)).subscribe(()=>{for(let c of $("audio, video",e))c.pause()}),tt(e).pipe(v(()=>Na(n)),y(c=>s.next(c)),L(()=>s.complete()),m(c=>R({ref:e},c)))}).pipe(Qe(se))}function Un(e,{viewport$:t,target$:r,print$:o}){return S(...$(".annotate:not(.highlight)",e).map(n=>Cn(n,{target$:r,print$:o})),...$("pre:not(.mermaid) > code",e).map(n=>$n(n,{target$:r,print$:o})),...$("pre.mermaid",e).map(n=>In(n)),...$("table:not([class])",e).map(n=>jn(n)),...$("details",e).map(n=>Pn(n,{target$:r,print$:o})),...$("[data-tabs]",e).map(n=>Wn(n,{viewport$:t,target$:r})),...$("[title]",e).filter(()=>G("content.tooltips")).map(n=>lt(n,{viewport$:t})))}function za(e,{alert$:t}){return t.pipe(v(r=>S(I(!0),I(!1).pipe(Ge(2e3))).pipe(m(o=>({message:r,active:o})))))}function Dn(e,t){let r=P(".md-typeset",e);return C(()=>{let o=new g;return o.subscribe(({message:n,active:i})=>{e.classList.toggle("md-dialog--active",i),r.textContent=n}),za(e,t).pipe(y(n=>o.next(n)),L(()=>o.complete()),m(n=>R({ref:e},n)))})}var qa=0;function Qa(e,t){document.body.append(e);let{width:r}=ce(e);e.style.setProperty("--md-tooltip-width",`${r}px`),e.remove();let o=cr(t),n=typeof o!="undefined"?De(o):I({x:0,y:0}),i=S(et(t),kt(t)).pipe(K());return z([i,n]).pipe(m(([a,s])=>{let{x:p,y:c}=Ue(t),l=ce(t),f=t.closest("table");return f&&t.parentElement&&(p+=f.offsetLeft+t.parentElement.offsetLeft,c+=f.offsetTop+t.parentElement.offsetTop),{active:a,offset:{x:p-s.x+l.width/2-r/2,y:c-s.y+l.height+8}}}))}function Vn(e){let t=e.title;if(!t.length)return M;let r=`__tooltip_${qa++}`,o=Pt(r,"inline"),n=P(".md-typeset",o);return n.innerHTML=t,C(()=>{let i=new g;return i.subscribe({next({offset:a}){o.style.setProperty("--md-tooltip-x",`${a.x}px`),o.style.setProperty("--md-tooltip-y",`${a.y}px`)},complete(){o.style.removeProperty("--md-tooltip-x"),o.style.removeProperty("--md-tooltip-y")}}),S(i.pipe(b(({active:a})=>a)),i.pipe(_e(250),b(({active:a})=>!a))).subscribe({next({active:a}){a?(e.insertAdjacentElement("afterend",o),e.setAttribute("aria-describedby",r),e.removeAttribute("title")):(o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t))},complete(){o.remove(),e.removeAttribute("aria-describedby"),e.setAttribute("title",t)}}),i.pipe(Le(16,me)).subscribe(({active:a})=>{o.classList.toggle("md-tooltip--active",a)}),i.pipe(ct(125,me),b(()=>!!e.offsetParent),m(()=>e.offsetParent.getBoundingClientRect()),m(({x:a})=>a)).subscribe({next(a){a?o.style.setProperty("--md-tooltip-0",`${-a}px`):o.style.removeProperty("--md-tooltip-0")},complete(){o.style.removeProperty("--md-tooltip-0")}}),Qa(o,e).pipe(y(a=>i.next(a)),L(()=>i.complete()),m(a=>R({ref:e},a)))}).pipe(Qe(se))}function Ka({viewport$:e}){if(!G("header.autohide"))return I(!1);let t=e.pipe(m(({offset:{y:n}})=>n),Ye(2,1),m(([n,i])=>[nMath.abs(i-n.y)>100),m(([,[n]])=>n),K()),o=Ve("search");return z([e,o]).pipe(m(([{offset:n},i])=>n.y>400&&!i),K(),v(n=>n?r:I(!1)),Q(!1))}function Nn(e,t){return C(()=>z([ge(e),Ka(t)])).pipe(m(([{height:r},o])=>({height:r,hidden:o})),K((r,o)=>r.height===o.height&&r.hidden===o.hidden),B(1))}function zn(e,{header$:t,main$:r}){return C(()=>{let o=new g,n=o.pipe(X(),ne(!0));o.pipe(Z("active"),We(t)).subscribe(([{active:a},{hidden:s}])=>{e.classList.toggle("md-header--shadow",a&&!s),e.hidden=s});let i=ue($("[title]",e)).pipe(b(()=>G("content.tooltips")),oe(a=>Vn(a)));return r.subscribe(o),t.pipe(U(n),m(a=>R({ref:e},a)),Pe(i.pipe(U(n))))})}function Ya(e,{viewport$:t,header$:r}){return mr(e,{viewport$:t,header$:r}).pipe(m(({offset:{y:o}})=>{let{height:n}=ce(e);return{active:o>=n}}),Z("active"))}function qn(e,t){return C(()=>{let r=new g;r.subscribe({next({active:n}){e.classList.toggle("md-header__title--active",n)},complete(){e.classList.remove("md-header__title--active")}});let o=fe(".md-content h1");return typeof o=="undefined"?M:Ya(o,t).pipe(y(n=>r.next(n)),L(()=>r.complete()),m(n=>R({ref:e},n)))})}function Qn(e,{viewport$:t,header$:r}){let o=r.pipe(m(({height:i})=>i),K()),n=o.pipe(v(()=>ge(e).pipe(m(({height:i})=>({top:e.offsetTop,bottom:e.offsetTop+i})),Z("bottom"))));return z([o,n,t]).pipe(m(([i,{top:a,bottom:s},{offset:{y:p},size:{height:c}}])=>(c=Math.max(0,c-Math.max(0,a-p,i)-Math.max(0,c+p-s)),{offset:a-i,height:c,active:a-i<=p})),K((i,a)=>i.offset===a.offset&&i.height===a.height&&i.active===a.active))}function Ba(e){let t=__md_get("__palette")||{index:e.findIndex(o=>matchMedia(o.getAttribute("data-md-color-media")).matches)},r=Math.max(0,Math.min(t.index,e.length-1));return I(...e).pipe(oe(o=>d(o,"change").pipe(m(()=>o))),Q(e[r]),m(o=>({index:e.indexOf(o),color:{media:o.getAttribute("data-md-color-media"),scheme:o.getAttribute("data-md-color-scheme"),primary:o.getAttribute("data-md-color-primary"),accent:o.getAttribute("data-md-color-accent")}})),B(1))}function Kn(e){let t=$("input",e),r=E("meta",{name:"theme-color"});document.head.appendChild(r);let o=E("meta",{name:"color-scheme"});document.head.appendChild(o);let n=$t("(prefers-color-scheme: light)");return C(()=>{let i=new g;return i.subscribe(a=>{if(document.body.setAttribute("data-md-color-switching",""),a.color.media==="(prefers-color-scheme)"){let s=matchMedia("(prefers-color-scheme: light)"),p=document.querySelector(s.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");a.color.scheme=p.getAttribute("data-md-color-scheme"),a.color.primary=p.getAttribute("data-md-color-primary"),a.color.accent=p.getAttribute("data-md-color-accent")}for(let[s,p]of Object.entries(a.color))document.body.setAttribute(`data-md-color-${s}`,p);for(let s=0;sa.key==="Enter"),ee(i,(a,s)=>s)).subscribe(({index:a})=>{a=(a+1)%t.length,t[a].click(),t[a].focus()}),i.pipe(m(()=>{let a=Se("header"),s=window.getComputedStyle(a);return o.content=s.colorScheme,s.backgroundColor.match(/\d+/g).map(p=>(+p).toString(16).padStart(2,"0")).join("")})).subscribe(a=>r.content=`#${a}`),i.pipe(be(se)).subscribe(()=>{document.body.removeAttribute("data-md-color-switching")}),Ba(t).pipe(U(n.pipe(Ce(1))),st(),y(a=>i.next(a)),L(()=>i.complete()),m(a=>R({ref:e},a)))})}function Yn(e,{progress$:t}){return C(()=>{let r=new g;return r.subscribe(({value:o})=>{e.style.setProperty("--md-progress-value",`${o}`)}),t.pipe(y(o=>r.next({value:o})),L(()=>r.complete()),m(o=>({ref:e,value:o})))})}var Gr=Vt(Yr());function Ga(e){e.setAttribute("data-md-copying","");let t=e.closest("[data-copy]"),r=t?t.getAttribute("data-copy"):e.innerText;return e.removeAttribute("data-md-copying"),r.trimEnd()}function Bn({alert$:e}){Gr.default.isSupported()&&new F(t=>{new Gr.default("[data-clipboard-target], [data-clipboard-text]",{text:r=>r.getAttribute("data-clipboard-text")||Ga(P(r.getAttribute("data-clipboard-target")))}).on("success",r=>t.next(r))}).pipe(y(t=>{t.trigger.focus()}),m(()=>ye("clipboard.copied"))).subscribe(e)}function Gn(e,t){return e.protocol=t.protocol,e.hostname=t.hostname,e}function Ja(e,t){let r=new Map;for(let o of $("url",e)){let n=P("loc",o),i=[Gn(new URL(n.textContent),t)];r.set(`${i[0]}`,i);for(let a of $("[rel=alternate]",o)){let s=a.getAttribute("href");s!=null&&i.push(Gn(new URL(s),t))}}return r}function ur(e){return mn(new URL("sitemap.xml",e)).pipe(m(t=>Ja(t,new URL(e))),ve(()=>I(new Map)))}function Xa(e,t){if(!(e.target instanceof Element))return M;let r=e.target.closest("a");if(r===null)return M;if(r.target||e.metaKey||e.ctrlKey)return M;let o=new URL(r.href);return o.search=o.hash="",t.has(`${o}`)?(e.preventDefault(),I(new URL(r.href))):M}function Jn(e){let t=new Map;for(let r of $(":scope > *",e.head))t.set(r.outerHTML,r);return t}function Xn(e){for(let t of $("[href], [src]",e))for(let r of["href","src"]){let o=t.getAttribute(r);if(o&&!/^(?:[a-z]+:)?\/\//i.test(o)){t[r]=t[r];break}}return I(e)}function Za(e){for(let o of["[data-md-component=announce]","[data-md-component=container]","[data-md-component=header-topic]","[data-md-component=outdated]","[data-md-component=logo]","[data-md-component=skip]",...G("navigation.tabs.sticky")?["[data-md-component=tabs]"]:[]]){let n=fe(o),i=fe(o,e);typeof n!="undefined"&&typeof i!="undefined"&&n.replaceWith(i)}let t=Jn(document);for(let[o,n]of Jn(e))t.has(o)?t.delete(o):document.head.appendChild(n);for(let o of t.values()){let n=o.getAttribute("name");n!=="theme-color"&&n!=="color-scheme"&&o.remove()}let r=Se("container");return je($("script",r)).pipe(v(o=>{let n=e.createElement("script");if(o.src){for(let i of o.getAttributeNames())n.setAttribute(i,o.getAttribute(i));return o.replaceWith(n),new F(i=>{n.onload=()=>i.complete()})}else return n.textContent=o.textContent,o.replaceWith(n),M}),X(),ne(document))}function Zn({location$:e,viewport$:t,progress$:r}){let o=Te();if(location.protocol==="file:")return M;let n=ur(o.base);I(document).subscribe(Xn);let i=d(document.body,"click").pipe(We(n),v(([p,c])=>Xa(p,c)),pe()),a=d(window,"popstate").pipe(m(xe),pe());i.pipe(ee(t)).subscribe(([p,{offset:c}])=>{history.replaceState(c,""),history.pushState(null,"",p)}),S(i,a).subscribe(e);let s=e.pipe(Z("pathname"),v(p=>ln(p,{progress$:r}).pipe(ve(()=>(pt(p,!0),M)))),v(Xn),v(Za),pe());return S(s.pipe(ee(e,(p,c)=>c)),e.pipe(Z("pathname"),v(()=>e),Z("hash")),e.pipe(K((p,c)=>p.pathname===c.pathname&&p.hash===c.hash),v(()=>i),y(()=>history.back()))).subscribe(p=>{var c,l;history.state!==null||!p.hash?window.scrollTo(0,(l=(c=history.state)==null?void 0:c.y)!=null?l:0):(history.scrollRestoration="auto",sn(p.hash),history.scrollRestoration="manual")}),e.subscribe(()=>{history.scrollRestoration="manual"}),d(window,"beforeunload").subscribe(()=>{history.scrollRestoration="auto"}),t.pipe(Z("offset"),_e(100)).subscribe(({offset:p})=>{history.replaceState(p,"")}),s}var ri=Vt(ti());function oi(e){let t=e.separator.split("|").map(n=>n.replace(/(\(\?[!=<][^)]+\))/g,"").length===0?"\uFFFD":n).join("|"),r=new RegExp(t,"img"),o=(n,i,a)=>`${i}${a}`;return n=>{n=n.replace(/[\s*+\-:~^]+/g," ").trim();let i=new RegExp(`(^|${e.separator}|)(${n.replace(/[|\\{}()[\]^$+*?.-]/g,"\\$&").replace(r,"|")})`,"img");return a=>(0,ri.default)(a).replace(i,o).replace(/<\/mark>(\s+)]*>/img,"$1")}}function It(e){return e.type===1}function dr(e){return e.type===3}function ni(e,t){let r=vn(e);return S(I(location.protocol!=="file:"),Ve("search")).pipe(Ae(o=>o),v(()=>t)).subscribe(({config:o,docs:n})=>r.next({type:0,data:{config:o,docs:n,options:{suggest:G("search.suggest")}}})),r}function ii({document$:e}){let t=Te(),r=Ne(new URL("../versions.json",t.base)).pipe(ve(()=>M)),o=r.pipe(m(n=>{let[,i]=t.base.match(/([^/]+)\/?$/);return n.find(({version:a,aliases:s})=>a===i||s.includes(i))||n[0]}));r.pipe(m(n=>new Map(n.map(i=>[`${new URL(`../${i.version}/`,t.base)}`,i]))),v(n=>d(document.body,"click").pipe(b(i=>!i.metaKey&&!i.ctrlKey),ee(o),v(([i,a])=>{if(i.target instanceof Element){let s=i.target.closest("a");if(s&&!s.target&&n.has(s.href)){let p=s.href;return!i.target.closest(".md-version")&&n.get(p)===a?M:(i.preventDefault(),I(p))}}return M}),v(i=>{let{version:a}=n.get(i);return ur(new URL(i)).pipe(m(s=>{let c=xe().href.replace(t.base,"");return s.has(c.split("#")[0])?new URL(`../${a}/${c}`,t.base):new URL(i)}))})))).subscribe(n=>pt(n,!0)),z([r,o]).subscribe(([n,i])=>{P(".md-header__topic").appendChild(Mn(n,i))}),e.pipe(v(()=>o)).subscribe(n=>{var a;let i=__md_get("__outdated",sessionStorage);if(i===null){i=!0;let s=((a=t.version)==null?void 0:a.default)||"latest";Array.isArray(s)||(s=[s]);e:for(let p of s)for(let c of n.aliases.concat(n.version))if(new RegExp(p,"i").test(c)){i=!1;break e}__md_set("__outdated",i,sessionStorage)}if(i)for(let s of ae("outdated"))s.hidden=!1})}function ns(e,{worker$:t}){let{searchParams:r}=xe();r.has("q")&&(Je("search",!0),e.value=r.get("q"),e.focus(),Ve("search").pipe(Ae(i=>!i)).subscribe(()=>{let i=xe();i.searchParams.delete("q"),history.replaceState({},"",`${i}`)}));let o=et(e),n=S(t.pipe(Ae(It)),d(e,"keyup"),o).pipe(m(()=>e.value),K());return z([n,o]).pipe(m(([i,a])=>({value:i,focus:a})),B(1))}function ai(e,{worker$:t}){let r=new g,o=r.pipe(X(),ne(!0));z([t.pipe(Ae(It)),r],(i,a)=>a).pipe(Z("value")).subscribe(({value:i})=>t.next({type:2,data:i})),r.pipe(Z("focus")).subscribe(({focus:i})=>{i&&Je("search",i)}),d(e.form,"reset").pipe(U(o)).subscribe(()=>e.focus());let n=P("header [for=__search]");return d(n,"click").subscribe(()=>e.focus()),ns(e,{worker$:t}).pipe(y(i=>r.next(i)),L(()=>r.complete()),m(i=>R({ref:e},i)),B(1))}function si(e,{worker$:t,query$:r}){let o=new g,n=tn(e.parentElement).pipe(b(Boolean)),i=e.parentElement,a=P(":scope > :first-child",e),s=P(":scope > :last-child",e);Ve("search").subscribe(l=>s.setAttribute("role",l?"list":"presentation")),o.pipe(ee(r),Ur(t.pipe(Ae(It)))).subscribe(([{items:l},{value:f}])=>{switch(l.length){case 0:a.textContent=f.length?ye("search.result.none"):ye("search.result.placeholder");break;case 1:a.textContent=ye("search.result.one");break;default:let u=sr(l.length);a.textContent=ye("search.result.other",u)}});let p=o.pipe(y(()=>s.innerHTML=""),v(({items:l})=>S(I(...l.slice(0,10)),I(...l.slice(10)).pipe(Ye(4),Vr(n),v(([f])=>f)))),m(Tn),pe());return p.subscribe(l=>s.appendChild(l)),p.pipe(oe(l=>{let f=fe("details",l);return typeof f=="undefined"?M:d(f,"toggle").pipe(U(o),m(()=>f))})).subscribe(l=>{l.open===!1&&l.offsetTop<=i.scrollTop&&i.scrollTo({top:l.offsetTop})}),t.pipe(b(dr),m(({data:l})=>l)).pipe(y(l=>o.next(l)),L(()=>o.complete()),m(l=>R({ref:e},l)))}function is(e,{query$:t}){return t.pipe(m(({value:r})=>{let o=xe();return o.hash="",r=r.replace(/\s+/g,"+").replace(/&/g,"%26").replace(/=/g,"%3D"),o.search=`q=${r}`,{url:o}}))}function ci(e,t){let r=new g,o=r.pipe(X(),ne(!0));return r.subscribe(({url:n})=>{e.setAttribute("data-clipboard-text",e.href),e.href=`${n}`}),d(e,"click").pipe(U(o)).subscribe(n=>n.preventDefault()),is(e,t).pipe(y(n=>r.next(n)),L(()=>r.complete()),m(n=>R({ref:e},n)))}function pi(e,{worker$:t,keyboard$:r}){let o=new g,n=Se("search-query"),i=S(d(n,"keydown"),d(n,"focus")).pipe(be(se),m(()=>n.value),K());return o.pipe(We(i),m(([{suggest:s},p])=>{let c=p.split(/([\s-]+)/);if(s!=null&&s.length&&c[c.length-1]){let l=s[s.length-1];l.startsWith(c[c.length-1])&&(c[c.length-1]=l)}else c.length=0;return c})).subscribe(s=>e.innerHTML=s.join("").replace(/\s/g," ")),r.pipe(b(({mode:s})=>s==="search")).subscribe(s=>{switch(s.type){case"ArrowRight":e.innerText.length&&n.selectionStart===n.value.length&&(n.value=e.innerText);break}}),t.pipe(b(dr),m(({data:s})=>s)).pipe(y(s=>o.next(s)),L(()=>o.complete()),m(()=>({ref:e})))}function li(e,{index$:t,keyboard$:r}){let o=Te();try{let n=ni(o.search,t),i=Se("search-query",e),a=Se("search-result",e);d(e,"click").pipe(b(({target:p})=>p instanceof Element&&!!p.closest("a"))).subscribe(()=>Je("search",!1)),r.pipe(b(({mode:p})=>p==="search")).subscribe(p=>{let c=Re();switch(p.type){case"Enter":if(c===i){let l=new Map;for(let f of $(":first-child [href]",a)){let u=f.firstElementChild;l.set(f,parseFloat(u.getAttribute("data-md-score")))}if(l.size){let[[f]]=[...l].sort(([,u],[,h])=>h-u);f.click()}p.claim()}break;case"Escape":case"Tab":Je("search",!1),i.blur();break;case"ArrowUp":case"ArrowDown":if(typeof c=="undefined")i.focus();else{let l=[i,...$(":not(details) > [href], summary, details[open] [href]",a)],f=Math.max(0,(Math.max(0,l.indexOf(c))+l.length+(p.type==="ArrowUp"?-1:1))%l.length);l[f].focus()}p.claim();break;default:i!==Re()&&i.focus()}}),r.pipe(b(({mode:p})=>p==="global")).subscribe(p=>{switch(p.type){case"f":case"s":case"/":i.focus(),i.select(),p.claim();break}});let s=ai(i,{worker$:n});return S(s,si(a,{worker$:n,query$:s})).pipe(Pe(...ae("search-share",e).map(p=>ci(p,{query$:s})),...ae("search-suggest",e).map(p=>pi(p,{worker$:n,keyboard$:r}))))}catch(n){return e.hidden=!0,Ke}}function mi(e,{index$:t,location$:r}){return z([t,r.pipe(Q(xe()),b(o=>!!o.searchParams.get("h")))]).pipe(m(([o,n])=>oi(o.config)(n.searchParams.get("h"))),m(o=>{var a;let n=new Map,i=document.createNodeIterator(e,NodeFilter.SHOW_TEXT);for(let s=i.nextNode();s;s=i.nextNode())if((a=s.parentElement)!=null&&a.offsetHeight){let p=s.textContent,c=o(p);c.length>p.length&&n.set(s,c)}for(let[s,p]of n){let{childNodes:c}=E("span",null,p);s.replaceWith(...Array.from(c))}return{ref:e,nodes:n}}))}function as(e,{viewport$:t,main$:r}){let o=e.closest(".md-grid"),n=o.offsetTop-o.parentElement.offsetTop;return z([r,t]).pipe(m(([{offset:i,height:a},{offset:{y:s}}])=>(a=a+Math.min(n,Math.max(0,s-i))-n,{height:a,locked:s>=i+n})),K((i,a)=>i.height===a.height&&i.locked===a.locked))}function Jr(e,o){var n=o,{header$:t}=n,r=io(n,["header$"]);let i=P(".md-sidebar__scrollwrap",e),{y:a}=Ue(i);return C(()=>{let s=new g,p=s.pipe(X(),ne(!0)),c=s.pipe(Le(0,me));return c.pipe(ee(t)).subscribe({next([{height:l},{height:f}]){i.style.height=`${l-2*a}px`,e.style.top=`${f}px`},complete(){i.style.height="",e.style.top=""}}),c.pipe(Ae()).subscribe(()=>{for(let l of $(".md-nav__link--active[href]",e)){if(!l.clientHeight)continue;let f=l.closest(".md-sidebar__scrollwrap");if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:h}=ce(f);f.scrollTo({top:u-h/2})}}}),ue($("label[tabindex]",e)).pipe(oe(l=>d(l,"click").pipe(be(se),m(()=>l),U(p)))).subscribe(l=>{let f=P(`[id="${l.htmlFor}"]`);P(`[aria-labelledby="${l.id}"]`).setAttribute("aria-expanded",`${f.checked}`)}),as(e,r).pipe(y(l=>s.next(l)),L(()=>s.complete()),m(l=>R({ref:e},l)))})}function fi(e,t){if(typeof t!="undefined"){let r=`https://api.github.com/repos/${e}/${t}`;return Ct(Ne(`${r}/releases/latest`).pipe(ve(()=>M),m(o=>({version:o.tag_name})),Be({})),Ne(r).pipe(ve(()=>M),m(o=>({stars:o.stargazers_count,forks:o.forks_count})),Be({}))).pipe(m(([o,n])=>R(R({},o),n)))}else{let r=`https://api.github.com/users/${e}`;return Ne(r).pipe(m(o=>({repositories:o.public_repos})),Be({}))}}function ui(e,t){let r=`https://${e}/api/v4/projects/${encodeURIComponent(t)}`;return Ne(r).pipe(ve(()=>M),m(({star_count:o,forks_count:n})=>({stars:o,forks:n})),Be({}))}function di(e){let t=e.match(/^.+github\.com\/([^/]+)\/?([^/]+)?/i);if(t){let[,r,o]=t;return fi(r,o)}if(t=e.match(/^.+?([^/]*gitlab[^/]+)\/(.+?)\/?$/i),t){let[,r,o]=t;return ui(r,o)}return M}var ss;function cs(e){return ss||(ss=C(()=>{let t=__md_get("__source",sessionStorage);if(t)return I(t);if(ae("consent").length){let o=__md_get("__consent");if(!(o&&o.github))return M}return di(e.href).pipe(y(o=>__md_set("__source",o,sessionStorage)))}).pipe(ve(()=>M),b(t=>Object.keys(t).length>0),m(t=>({facts:t})),B(1)))}function hi(e){let t=P(":scope > :last-child",e);return C(()=>{let r=new g;return r.subscribe(({facts:o})=>{t.appendChild(Sn(o)),t.classList.add("md-source__repository--active")}),cs(e).pipe(y(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}function ps(e,{viewport$:t,header$:r}){return ge(document.body).pipe(v(()=>mr(e,{header$:r,viewport$:t})),m(({offset:{y:o}})=>({hidden:o>=10})),Z("hidden"))}function bi(e,t){return C(()=>{let r=new g;return r.subscribe({next({hidden:o}){e.hidden=o},complete(){e.hidden=!1}}),(G("navigation.tabs.sticky")?I({hidden:!1}):ps(e,t)).pipe(y(o=>r.next(o)),L(()=>r.complete()),m(o=>R({ref:e},o)))})}function ls(e,{viewport$:t,header$:r}){let o=new Map,n=$(".md-nav__link",e);for(let s of n){let p=decodeURIComponent(s.hash.substring(1)),c=fe(`[id="${p}"]`);typeof c!="undefined"&&o.set(s,c)}let i=r.pipe(Z("height"),m(({height:s})=>{let p=Se("main"),c=P(":scope > :first-child",p);return s+.8*(c.offsetTop-p.offsetTop)}),pe());return ge(document.body).pipe(Z("height"),v(s=>C(()=>{let p=[];return I([...o].reduce((c,[l,f])=>{for(;p.length&&o.get(p[p.length-1]).tagName>=f.tagName;)p.pop();let u=f.offsetTop;for(;!u&&f.parentElement;)f=f.parentElement,u=f.offsetTop;let h=f.offsetParent;for(;h;h=h.offsetParent)u+=h.offsetTop;return c.set([...p=[...p,l]].reverse(),u)},new Map))}).pipe(m(p=>new Map([...p].sort(([,c],[,l])=>c-l))),We(i),v(([p,c])=>t.pipe(jr(([l,f],{offset:{y:u},size:h})=>{let w=u+h.height>=Math.floor(s.height);for(;f.length;){let[,A]=f[0];if(A-c=u&&!w)f=[l.pop(),...f];else break}return[l,f]},[[],[...p]]),K((l,f)=>l[0]===f[0]&&l[1]===f[1])))))).pipe(m(([s,p])=>({prev:s.map(([c])=>c),next:p.map(([c])=>c)})),Q({prev:[],next:[]}),Ye(2,1),m(([s,p])=>s.prev.length{let i=new g,a=i.pipe(X(),ne(!0));if(i.subscribe(({prev:s,next:p})=>{for(let[c]of p)c.classList.remove("md-nav__link--passed"),c.classList.remove("md-nav__link--active");for(let[c,[l]]of s.entries())l.classList.add("md-nav__link--passed"),l.classList.toggle("md-nav__link--active",c===s.length-1)}),G("toc.follow")){let s=S(t.pipe(_e(1),m(()=>{})),t.pipe(_e(250),m(()=>"smooth")));i.pipe(b(({prev:p})=>p.length>0),We(o.pipe(be(se))),ee(s)).subscribe(([[{prev:p}],c])=>{let[l]=p[p.length-1];if(l.offsetHeight){let f=cr(l);if(typeof f!="undefined"){let u=l.offsetTop-f.offsetTop,{height:h}=ce(f);f.scrollTo({top:u-h/2,behavior:c})}}})}return G("navigation.tracking")&&t.pipe(U(a),Z("offset"),_e(250),Ce(1),U(n.pipe(Ce(1))),st({delay:250}),ee(i)).subscribe(([,{prev:s}])=>{let p=xe(),c=s[s.length-1];if(c&&c.length){let[l]=c,{hash:f}=new URL(l.href);p.hash!==f&&(p.hash=f,history.replaceState({},"",`${p}`))}else p.hash="",history.replaceState({},"",`${p}`)}),ls(e,{viewport$:t,header$:r}).pipe(y(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))})}function ms(e,{viewport$:t,main$:r,target$:o}){let n=t.pipe(m(({offset:{y:a}})=>a),Ye(2,1),m(([a,s])=>a>s&&s>0),K()),i=r.pipe(m(({active:a})=>a));return z([i,n]).pipe(m(([a,s])=>!(a&&s)),K(),U(o.pipe(Ce(1))),ne(!0),st({delay:250}),m(a=>({hidden:a})))}function gi(e,{viewport$:t,header$:r,main$:o,target$:n}){let i=new g,a=i.pipe(X(),ne(!0));return i.subscribe({next({hidden:s}){e.hidden=s,s?(e.setAttribute("tabindex","-1"),e.blur()):e.removeAttribute("tabindex")},complete(){e.style.top="",e.hidden=!0,e.removeAttribute("tabindex")}}),r.pipe(U(a),Z("height")).subscribe(({height:s})=>{e.style.top=`${s+16}px`}),d(e,"click").subscribe(s=>{s.preventDefault(),window.scrollTo({top:0})}),ms(e,{viewport$:t,main$:o,target$:n}).pipe(y(s=>i.next(s)),L(()=>i.complete()),m(s=>R({ref:e},s)))}function xi({document$:e,viewport$:t}){e.pipe(v(()=>$(".md-ellipsis")),oe(r=>tt(r).pipe(U(e.pipe(Ce(1))),b(o=>o),m(()=>r),we(1))),b(r=>r.offsetWidth{let o=r.innerText,n=r.closest("a")||r;return n.title=o,lt(n,{viewport$:t}).pipe(U(e.pipe(Ce(1))),L(()=>n.removeAttribute("title")))})).subscribe(),e.pipe(v(()=>$(".md-status")),oe(r=>lt(r,{viewport$:t}))).subscribe()}function yi({document$:e,tablet$:t}){e.pipe(v(()=>$(".md-toggle--indeterminate")),y(r=>{r.indeterminate=!0,r.checked=!1}),oe(r=>d(r,"change").pipe(Dr(()=>r.classList.contains("md-toggle--indeterminate")),m(()=>r))),ee(t)).subscribe(([r,o])=>{r.classList.remove("md-toggle--indeterminate"),o&&(r.checked=!1)})}function fs(){return/(iPad|iPhone|iPod)/.test(navigator.userAgent)}function Ei({document$:e}){e.pipe(v(()=>$("[data-md-scrollfix]")),y(t=>t.removeAttribute("data-md-scrollfix")),b(fs),oe(t=>d(t,"touchstart").pipe(m(()=>t)))).subscribe(t=>{let r=t.scrollTop;r===0?t.scrollTop=1:r+t.offsetHeight===t.scrollHeight&&(t.scrollTop=r-1)})}function wi({viewport$:e,tablet$:t}){z([Ve("search"),t]).pipe(m(([r,o])=>r&&!o),v(r=>I(r).pipe(Ge(r?400:100))),ee(e)).subscribe(([r,{offset:{y:o}}])=>{if(r)document.body.setAttribute("data-md-scrolllock",""),document.body.style.top=`-${o}px`;else{let n=-1*parseInt(document.body.style.top,10);document.body.removeAttribute("data-md-scrolllock"),document.body.style.top="",n&&window.scrollTo(0,n)}})}Object.entries||(Object.entries=function(e){let t=[];for(let r of Object.keys(e))t.push([r,e[r]]);return t});Object.values||(Object.values=function(e){let t=[];for(let r of Object.keys(e))t.push(e[r]);return t});typeof Element!="undefined"&&(Element.prototype.scrollTo||(Element.prototype.scrollTo=function(e,t){typeof e=="object"?(this.scrollLeft=e.left,this.scrollTop=e.top):(this.scrollLeft=e,this.scrollTop=t)}),Element.prototype.replaceWith||(Element.prototype.replaceWith=function(...e){let t=this.parentNode;if(t){e.length===0&&t.removeChild(this);for(let r=e.length-1;r>=0;r--){let o=e[r];typeof o=="string"?o=document.createTextNode(o):o.parentNode&&o.parentNode.removeChild(o),r?t.insertBefore(this.previousSibling,o):t.replaceChild(o,this)}}}));function us(){return location.protocol==="file:"?wt(`${new URL("search/search_index.js",Xr.base)}`).pipe(m(()=>__index),B(1)):Ne(new URL("search/search_index.json",Xr.base))}document.documentElement.classList.remove("no-js");document.documentElement.classList.add("js");var ot=Yo(),jt=nn(),Ot=cn(jt),Zr=on(),Oe=bn(),hr=$t("(min-width: 960px)"),Si=$t("(min-width: 1220px)"),Oi=pn(),Xr=Te(),Mi=document.forms.namedItem("search")?us():Ke,eo=new g;Bn({alert$:eo});var to=new g;G("navigation.instant")&&Zn({location$:jt,viewport$:Oe,progress$:to}).subscribe(ot);var Ti;((Ti=Xr.version)==null?void 0:Ti.provider)==="mike"&&ii({document$:ot});S(jt,Ot).pipe(Ge(125)).subscribe(()=>{Je("drawer",!1),Je("search",!1)});Zr.pipe(b(({mode:e})=>e==="global")).subscribe(e=>{switch(e.type){case"p":case",":let t=fe("link[rel=prev]");typeof t!="undefined"&&pt(t);break;case"n":case".":let r=fe("link[rel=next]");typeof r!="undefined"&&pt(r);break;case"Enter":let o=Re();o instanceof HTMLLabelElement&&o.click()}});xi({viewport$:Oe,document$:ot});yi({document$:ot,tablet$:hr});Ei({document$:ot});wi({viewport$:Oe,tablet$:hr});var rt=Nn(Se("header"),{viewport$:Oe}),Ft=ot.pipe(m(()=>Se("main")),v(e=>Qn(e,{viewport$:Oe,header$:rt})),B(1)),ds=S(...ae("consent").map(e=>xn(e,{target$:Ot})),...ae("dialog").map(e=>Dn(e,{alert$:eo})),...ae("header").map(e=>zn(e,{viewport$:Oe,header$:rt,main$:Ft})),...ae("palette").map(e=>Kn(e)),...ae("progress").map(e=>Yn(e,{progress$:to})),...ae("search").map(e=>li(e,{index$:Mi,keyboard$:Zr})),...ae("source").map(e=>hi(e))),hs=C(()=>S(...ae("announce").map(e=>gn(e)),...ae("content").map(e=>Un(e,{viewport$:Oe,target$:Ot,print$:Oi})),...ae("content").map(e=>G("search.highlight")?mi(e,{index$:Mi,location$:jt}):M),...ae("header-title").map(e=>qn(e,{viewport$:Oe,header$:rt})),...ae("sidebar").map(e=>e.getAttribute("data-md-type")==="navigation"?Nr(Si,()=>Jr(e,{viewport$:Oe,header$:rt,main$:Ft})):Nr(hr,()=>Jr(e,{viewport$:Oe,header$:rt,main$:Ft}))),...ae("tabs").map(e=>bi(e,{viewport$:Oe,header$:rt})),...ae("toc").map(e=>vi(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Ot})),...ae("top").map(e=>gi(e,{viewport$:Oe,header$:rt,main$:Ft,target$:Ot})))),Li=ot.pipe(v(()=>hs),Pe(ds),B(1));Li.subscribe();window.document$=ot;window.location$=jt;window.target$=Ot;window.keyboard$=Zr;window.viewport$=Oe;window.tablet$=hr;window.screen$=Si;window.print$=Oi;window.alert$=eo;window.progress$=to;window.component$=Li;})(); +//# sourceMappingURL=bundle.a7c05c9e.min.js.map + diff --git a/assets/javascripts/bundle.a7c05c9e.min.js.map b/assets/javascripts/bundle.a7c05c9e.min.js.map new file mode 100644 index 00000000..99cdca1f --- /dev/null +++ b/assets/javascripts/bundle.a7c05c9e.min.js.map @@ -0,0 +1,7 @@ +{ + "version": 3, + "sources": ["node_modules/focus-visible/dist/focus-visible.js", "node_modules/clipboard/dist/clipboard.js", "node_modules/escape-html/index.js", "src/templates/assets/javascripts/bundle.ts", "node_modules/rxjs/node_modules/tslib/tslib.es6.js", "node_modules/rxjs/src/internal/util/isFunction.ts", "node_modules/rxjs/src/internal/util/createErrorClass.ts", "node_modules/rxjs/src/internal/util/UnsubscriptionError.ts", "node_modules/rxjs/src/internal/util/arrRemove.ts", "node_modules/rxjs/src/internal/Subscription.ts", "node_modules/rxjs/src/internal/config.ts", "node_modules/rxjs/src/internal/scheduler/timeoutProvider.ts", "node_modules/rxjs/src/internal/util/reportUnhandledError.ts", "node_modules/rxjs/src/internal/util/noop.ts", "node_modules/rxjs/src/internal/NotificationFactories.ts", "node_modules/rxjs/src/internal/util/errorContext.ts", "node_modules/rxjs/src/internal/Subscriber.ts", "node_modules/rxjs/src/internal/symbol/observable.ts", "node_modules/rxjs/src/internal/util/identity.ts", "node_modules/rxjs/src/internal/util/pipe.ts", "node_modules/rxjs/src/internal/Observable.ts", "node_modules/rxjs/src/internal/util/lift.ts", "node_modules/rxjs/src/internal/operators/OperatorSubscriber.ts", "node_modules/rxjs/src/internal/scheduler/animationFrameProvider.ts", "node_modules/rxjs/src/internal/util/ObjectUnsubscribedError.ts", "node_modules/rxjs/src/internal/Subject.ts", "node_modules/rxjs/src/internal/BehaviorSubject.ts", "node_modules/rxjs/src/internal/scheduler/dateTimestampProvider.ts", "node_modules/rxjs/src/internal/ReplaySubject.ts", "node_modules/rxjs/src/internal/scheduler/Action.ts", "node_modules/rxjs/src/internal/scheduler/intervalProvider.ts", "node_modules/rxjs/src/internal/scheduler/AsyncAction.ts", "node_modules/rxjs/src/internal/Scheduler.ts", "node_modules/rxjs/src/internal/scheduler/AsyncScheduler.ts", "node_modules/rxjs/src/internal/scheduler/async.ts", "node_modules/rxjs/src/internal/scheduler/QueueAction.ts", "node_modules/rxjs/src/internal/scheduler/QueueScheduler.ts", "node_modules/rxjs/src/internal/scheduler/queue.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameAction.ts", "node_modules/rxjs/src/internal/scheduler/AnimationFrameScheduler.ts", "node_modules/rxjs/src/internal/scheduler/animationFrame.ts", "node_modules/rxjs/src/internal/observable/empty.ts", "node_modules/rxjs/src/internal/util/isScheduler.ts", "node_modules/rxjs/src/internal/util/args.ts", "node_modules/rxjs/src/internal/util/isArrayLike.ts", "node_modules/rxjs/src/internal/util/isPromise.ts", "node_modules/rxjs/src/internal/util/isInteropObservable.ts", "node_modules/rxjs/src/internal/util/isAsyncIterable.ts", "node_modules/rxjs/src/internal/util/throwUnobservableError.ts", "node_modules/rxjs/src/internal/symbol/iterator.ts", "node_modules/rxjs/src/internal/util/isIterable.ts", "node_modules/rxjs/src/internal/util/isReadableStreamLike.ts", "node_modules/rxjs/src/internal/observable/innerFrom.ts", "node_modules/rxjs/src/internal/util/executeSchedule.ts", "node_modules/rxjs/src/internal/operators/observeOn.ts", "node_modules/rxjs/src/internal/operators/subscribeOn.ts", "node_modules/rxjs/src/internal/scheduled/scheduleObservable.ts", "node_modules/rxjs/src/internal/scheduled/schedulePromise.ts", "node_modules/rxjs/src/internal/scheduled/scheduleArray.ts", "node_modules/rxjs/src/internal/scheduled/scheduleIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleAsyncIterable.ts", "node_modules/rxjs/src/internal/scheduled/scheduleReadableStreamLike.ts", "node_modules/rxjs/src/internal/scheduled/scheduled.ts", "node_modules/rxjs/src/internal/observable/from.ts", "node_modules/rxjs/src/internal/observable/of.ts", "node_modules/rxjs/src/internal/observable/throwError.ts", "node_modules/rxjs/src/internal/util/EmptyError.ts", "node_modules/rxjs/src/internal/util/isDate.ts", "node_modules/rxjs/src/internal/operators/map.ts", "node_modules/rxjs/src/internal/util/mapOneOrManyArgs.ts", "node_modules/rxjs/src/internal/util/argsArgArrayOrObject.ts", "node_modules/rxjs/src/internal/util/createObject.ts", "node_modules/rxjs/src/internal/observable/combineLatest.ts", "node_modules/rxjs/src/internal/operators/mergeInternals.ts", "node_modules/rxjs/src/internal/operators/mergeMap.ts", "node_modules/rxjs/src/internal/operators/mergeAll.ts", "node_modules/rxjs/src/internal/operators/concatAll.ts", "node_modules/rxjs/src/internal/observable/concat.ts", "node_modules/rxjs/src/internal/observable/defer.ts", "node_modules/rxjs/src/internal/observable/fromEvent.ts", "node_modules/rxjs/src/internal/observable/fromEventPattern.ts", "node_modules/rxjs/src/internal/observable/timer.ts", "node_modules/rxjs/src/internal/observable/merge.ts", "node_modules/rxjs/src/internal/observable/never.ts", "node_modules/rxjs/src/internal/util/argsOrArgArray.ts", "node_modules/rxjs/src/internal/operators/filter.ts", "node_modules/rxjs/src/internal/observable/zip.ts", "node_modules/rxjs/src/internal/operators/audit.ts", "node_modules/rxjs/src/internal/operators/auditTime.ts", "node_modules/rxjs/src/internal/operators/bufferCount.ts", "node_modules/rxjs/src/internal/operators/catchError.ts", "node_modules/rxjs/src/internal/operators/scanInternals.ts", "node_modules/rxjs/src/internal/operators/combineLatest.ts", "node_modules/rxjs/src/internal/operators/combineLatestWith.ts", "node_modules/rxjs/src/internal/operators/debounce.ts", "node_modules/rxjs/src/internal/operators/debounceTime.ts", "node_modules/rxjs/src/internal/operators/defaultIfEmpty.ts", "node_modules/rxjs/src/internal/operators/take.ts", "node_modules/rxjs/src/internal/operators/ignoreElements.ts", "node_modules/rxjs/src/internal/operators/mapTo.ts", "node_modules/rxjs/src/internal/operators/delayWhen.ts", "node_modules/rxjs/src/internal/operators/delay.ts", "node_modules/rxjs/src/internal/operators/distinctUntilChanged.ts", "node_modules/rxjs/src/internal/operators/distinctUntilKeyChanged.ts", "node_modules/rxjs/src/internal/operators/throwIfEmpty.ts", "node_modules/rxjs/src/internal/operators/endWith.ts", "node_modules/rxjs/src/internal/operators/finalize.ts", "node_modules/rxjs/src/internal/operators/first.ts", "node_modules/rxjs/src/internal/operators/takeLast.ts", "node_modules/rxjs/src/internal/operators/merge.ts", "node_modules/rxjs/src/internal/operators/mergeWith.ts", "node_modules/rxjs/src/internal/operators/repeat.ts", "node_modules/rxjs/src/internal/operators/scan.ts", "node_modules/rxjs/src/internal/operators/share.ts", "node_modules/rxjs/src/internal/operators/shareReplay.ts", "node_modules/rxjs/src/internal/operators/skip.ts", "node_modules/rxjs/src/internal/operators/skipUntil.ts", "node_modules/rxjs/src/internal/operators/startWith.ts", "node_modules/rxjs/src/internal/operators/switchMap.ts", "node_modules/rxjs/src/internal/operators/takeUntil.ts", "node_modules/rxjs/src/internal/operators/takeWhile.ts", "node_modules/rxjs/src/internal/operators/tap.ts", "node_modules/rxjs/src/internal/operators/throttle.ts", "node_modules/rxjs/src/internal/operators/throttleTime.ts", "node_modules/rxjs/src/internal/operators/withLatestFrom.ts", "node_modules/rxjs/src/internal/operators/zip.ts", "node_modules/rxjs/src/internal/operators/zipWith.ts", "src/templates/assets/javascripts/browser/document/index.ts", "src/templates/assets/javascripts/browser/element/_/index.ts", "src/templates/assets/javascripts/browser/element/focus/index.ts", "src/templates/assets/javascripts/browser/element/hover/index.ts", "src/templates/assets/javascripts/utilities/h/index.ts", "src/templates/assets/javascripts/utilities/round/index.ts", "src/templates/assets/javascripts/browser/script/index.ts", "src/templates/assets/javascripts/browser/element/size/_/index.ts", "src/templates/assets/javascripts/browser/element/size/content/index.ts", "src/templates/assets/javascripts/browser/element/offset/_/index.ts", "src/templates/assets/javascripts/browser/element/offset/content/index.ts", "src/templates/assets/javascripts/browser/element/visibility/index.ts", "src/templates/assets/javascripts/browser/toggle/index.ts", "src/templates/assets/javascripts/browser/keyboard/index.ts", "src/templates/assets/javascripts/browser/location/_/index.ts", "src/templates/assets/javascripts/browser/location/hash/index.ts", "src/templates/assets/javascripts/browser/media/index.ts", "src/templates/assets/javascripts/browser/request/index.ts", "src/templates/assets/javascripts/browser/viewport/offset/index.ts", "src/templates/assets/javascripts/browser/viewport/size/index.ts", "src/templates/assets/javascripts/browser/viewport/_/index.ts", "src/templates/assets/javascripts/browser/viewport/at/index.ts", "src/templates/assets/javascripts/browser/worker/index.ts", "src/templates/assets/javascripts/_/index.ts", "src/templates/assets/javascripts/components/_/index.ts", "src/templates/assets/javascripts/components/announce/index.ts", "src/templates/assets/javascripts/components/consent/index.ts", "src/templates/assets/javascripts/templates/tooltip/index.tsx", "src/templates/assets/javascripts/templates/annotation/index.tsx", "src/templates/assets/javascripts/templates/clipboard/index.tsx", "src/templates/assets/javascripts/templates/search/index.tsx", "src/templates/assets/javascripts/templates/source/index.tsx", "src/templates/assets/javascripts/templates/tabbed/index.tsx", "src/templates/assets/javascripts/templates/table/index.tsx", "src/templates/assets/javascripts/templates/version/index.tsx", "src/templates/assets/javascripts/components/tooltip2/index.ts", "src/templates/assets/javascripts/components/content/annotation/_/index.ts", "src/templates/assets/javascripts/components/content/annotation/list/index.ts", "src/templates/assets/javascripts/components/content/annotation/block/index.ts", "src/templates/assets/javascripts/components/content/code/_/index.ts", "src/templates/assets/javascripts/components/content/details/index.ts", "src/templates/assets/javascripts/components/content/mermaid/index.css", "src/templates/assets/javascripts/components/content/mermaid/index.ts", "src/templates/assets/javascripts/components/content/table/index.ts", "src/templates/assets/javascripts/components/content/tabs/index.ts", "src/templates/assets/javascripts/components/content/_/index.ts", "src/templates/assets/javascripts/components/dialog/index.ts", "src/templates/assets/javascripts/components/tooltip/index.ts", "src/templates/assets/javascripts/components/header/_/index.ts", "src/templates/assets/javascripts/components/header/title/index.ts", "src/templates/assets/javascripts/components/main/index.ts", "src/templates/assets/javascripts/components/palette/index.ts", "src/templates/assets/javascripts/components/progress/index.ts", "src/templates/assets/javascripts/integrations/clipboard/index.ts", "src/templates/assets/javascripts/integrations/sitemap/index.ts", "src/templates/assets/javascripts/integrations/instant/index.ts", "src/templates/assets/javascripts/integrations/search/highlighter/index.ts", "src/templates/assets/javascripts/integrations/search/worker/message/index.ts", "src/templates/assets/javascripts/integrations/search/worker/_/index.ts", "src/templates/assets/javascripts/integrations/version/index.ts", "src/templates/assets/javascripts/components/search/query/index.ts", "src/templates/assets/javascripts/components/search/result/index.ts", "src/templates/assets/javascripts/components/search/share/index.ts", "src/templates/assets/javascripts/components/search/suggest/index.ts", "src/templates/assets/javascripts/components/search/_/index.ts", "src/templates/assets/javascripts/components/search/highlight/index.ts", "src/templates/assets/javascripts/components/sidebar/index.ts", "src/templates/assets/javascripts/components/source/facts/github/index.ts", "src/templates/assets/javascripts/components/source/facts/gitlab/index.ts", "src/templates/assets/javascripts/components/source/facts/_/index.ts", "src/templates/assets/javascripts/components/source/_/index.ts", "src/templates/assets/javascripts/components/tabs/index.ts", "src/templates/assets/javascripts/components/toc/index.ts", "src/templates/assets/javascripts/components/top/index.ts", "src/templates/assets/javascripts/patches/ellipsis/index.ts", "src/templates/assets/javascripts/patches/indeterminate/index.ts", "src/templates/assets/javascripts/patches/scrollfix/index.ts", "src/templates/assets/javascripts/patches/scrolllock/index.ts", "src/templates/assets/javascripts/polyfills/index.ts"], + "sourcesContent": ["(function (global, factory) {\n typeof exports === 'object' && typeof module !== 'undefined' ? factory() :\n typeof define === 'function' && define.amd ? define(factory) :\n (factory());\n}(this, (function () { 'use strict';\n\n /**\n * Applies the :focus-visible polyfill at the given scope.\n * A scope in this case is either the top-level Document or a Shadow Root.\n *\n * @param {(Document|ShadowRoot)} scope\n * @see https://github.com/WICG/focus-visible\n */\n function applyFocusVisiblePolyfill(scope) {\n var hadKeyboardEvent = true;\n var hadFocusVisibleRecently = false;\n var hadFocusVisibleRecentlyTimeout = null;\n\n var inputTypesAllowlist = {\n text: true,\n search: true,\n url: true,\n tel: true,\n email: true,\n password: true,\n number: true,\n date: true,\n month: true,\n week: true,\n time: true,\n datetime: true,\n 'datetime-local': true\n };\n\n /**\n * Helper function for legacy browsers and iframes which sometimes focus\n * elements like document, body, and non-interactive SVG.\n * @param {Element} el\n */\n function isValidFocusTarget(el) {\n if (\n el &&\n el !== document &&\n el.nodeName !== 'HTML' &&\n el.nodeName !== 'BODY' &&\n 'classList' in el &&\n 'contains' in el.classList\n ) {\n return true;\n }\n return false;\n }\n\n /**\n * Computes whether the given element should automatically trigger the\n * `focus-visible` class being added, i.e. whether it should always match\n * `:focus-visible` when focused.\n * @param {Element} el\n * @return {boolean}\n */\n function focusTriggersKeyboardModality(el) {\n var type = el.type;\n var tagName = el.tagName;\n\n if (tagName === 'INPUT' && inputTypesAllowlist[type] && !el.readOnly) {\n return true;\n }\n\n if (tagName === 'TEXTAREA' && !el.readOnly) {\n return true;\n }\n\n if (el.isContentEditable) {\n return true;\n }\n\n return false;\n }\n\n /**\n * Add the `focus-visible` class to the given element if it was not added by\n * the author.\n * @param {Element} el\n */\n function addFocusVisibleClass(el) {\n if (el.classList.contains('focus-visible')) {\n return;\n }\n el.classList.add('focus-visible');\n el.setAttribute('data-focus-visible-added', '');\n }\n\n /**\n * Remove the `focus-visible` class from the given element if it was not\n * originally added by the author.\n * @param {Element} el\n */\n function removeFocusVisibleClass(el) {\n if (!el.hasAttribute('data-focus-visible-added')) {\n return;\n }\n el.classList.remove('focus-visible');\n el.removeAttribute('data-focus-visible-added');\n }\n\n /**\n * If the most recent user interaction was via the keyboard;\n * and the key press did not include a meta, alt/option, or control key;\n * then the modality is keyboard. Otherwise, the modality is not keyboard.\n * Apply `focus-visible` to any current active element and keep track\n * of our keyboard modality state with `hadKeyboardEvent`.\n * @param {KeyboardEvent} e\n */\n function onKeyDown(e) {\n if (e.metaKey || e.altKey || e.ctrlKey) {\n return;\n }\n\n if (isValidFocusTarget(scope.activeElement)) {\n addFocusVisibleClass(scope.activeElement);\n }\n\n hadKeyboardEvent = true;\n }\n\n /**\n * If at any point a user clicks with a pointing device, ensure that we change\n * the modality away from keyboard.\n * This avoids the situation where a user presses a key on an already focused\n * element, and then clicks on a different element, focusing it with a\n * pointing device, while we still think we're in keyboard modality.\n * @param {Event} e\n */\n function onPointerDown(e) {\n hadKeyboardEvent = false;\n }\n\n /**\n * On `focus`, add the `focus-visible` class to the target if:\n * - the target received focus as a result of keyboard navigation, or\n * - the event target is an element that will likely require interaction\n * via the keyboard (e.g. a text box)\n * @param {Event} e\n */\n function onFocus(e) {\n // Prevent IE from focusing the document or HTML element.\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (hadKeyboardEvent || focusTriggersKeyboardModality(e.target)) {\n addFocusVisibleClass(e.target);\n }\n }\n\n /**\n * On `blur`, remove the `focus-visible` class from the target.\n * @param {Event} e\n */\n function onBlur(e) {\n if (!isValidFocusTarget(e.target)) {\n return;\n }\n\n if (\n e.target.classList.contains('focus-visible') ||\n e.target.hasAttribute('data-focus-visible-added')\n ) {\n // To detect a tab/window switch, we look for a blur event followed\n // rapidly by a visibility change.\n // If we don't see a visibility change within 100ms, it's probably a\n // regular focus change.\n hadFocusVisibleRecently = true;\n window.clearTimeout(hadFocusVisibleRecentlyTimeout);\n hadFocusVisibleRecentlyTimeout = window.setTimeout(function() {\n hadFocusVisibleRecently = false;\n }, 100);\n removeFocusVisibleClass(e.target);\n }\n }\n\n /**\n * If the user changes tabs, keep track of whether or not the previously\n * focused element had .focus-visible.\n * @param {Event} e\n */\n function onVisibilityChange(e) {\n if (document.visibilityState === 'hidden') {\n // If the tab becomes active again, the browser will handle calling focus\n // on the element (Safari actually calls it twice).\n // If this tab change caused a blur on an element with focus-visible,\n // re-apply the class when the user switches back to the tab.\n if (hadFocusVisibleRecently) {\n hadKeyboardEvent = true;\n }\n addInitialPointerMoveListeners();\n }\n }\n\n /**\n * Add a group of listeners to detect usage of any pointing devices.\n * These listeners will be added when the polyfill first loads, and anytime\n * the window is blurred, so that they are active when the window regains\n * focus.\n */\n function addInitialPointerMoveListeners() {\n document.addEventListener('mousemove', onInitialPointerMove);\n document.addEventListener('mousedown', onInitialPointerMove);\n document.addEventListener('mouseup', onInitialPointerMove);\n document.addEventListener('pointermove', onInitialPointerMove);\n document.addEventListener('pointerdown', onInitialPointerMove);\n document.addEventListener('pointerup', onInitialPointerMove);\n document.addEventListener('touchmove', onInitialPointerMove);\n document.addEventListener('touchstart', onInitialPointerMove);\n document.addEventListener('touchend', onInitialPointerMove);\n }\n\n function removeInitialPointerMoveListeners() {\n document.removeEventListener('mousemove', onInitialPointerMove);\n document.removeEventListener('mousedown', onInitialPointerMove);\n document.removeEventListener('mouseup', onInitialPointerMove);\n document.removeEventListener('pointermove', onInitialPointerMove);\n document.removeEventListener('pointerdown', onInitialPointerMove);\n document.removeEventListener('pointerup', onInitialPointerMove);\n document.removeEventListener('touchmove', onInitialPointerMove);\n document.removeEventListener('touchstart', onInitialPointerMove);\n document.removeEventListener('touchend', onInitialPointerMove);\n }\n\n /**\n * When the polfyill first loads, assume the user is in keyboard modality.\n * If any event is received from a pointing device (e.g. mouse, pointer,\n * touch), turn off keyboard modality.\n * This accounts for situations where focus enters the page from the URL bar.\n * @param {Event} e\n */\n function onInitialPointerMove(e) {\n // Work around a Safari quirk that fires a mousemove on whenever the\n // window blurs, even if you're tabbing out of the page. \u00AF\\_(\u30C4)_/\u00AF\n if (e.target.nodeName && e.target.nodeName.toLowerCase() === 'html') {\n return;\n }\n\n hadKeyboardEvent = false;\n removeInitialPointerMoveListeners();\n }\n\n // For some kinds of state, we are interested in changes at the global scope\n // only. For example, global pointer input, global key presses and global\n // visibility change should affect the state at every scope:\n document.addEventListener('keydown', onKeyDown, true);\n document.addEventListener('mousedown', onPointerDown, true);\n document.addEventListener('pointerdown', onPointerDown, true);\n document.addEventListener('touchstart', onPointerDown, true);\n document.addEventListener('visibilitychange', onVisibilityChange, true);\n\n addInitialPointerMoveListeners();\n\n // For focus and blur, we specifically care about state changes in the local\n // scope. This is because focus / blur events that originate from within a\n // shadow root are not re-dispatched from the host element if it was already\n // the active element in its own scope:\n scope.addEventListener('focus', onFocus, true);\n scope.addEventListener('blur', onBlur, true);\n\n // We detect that a node is a ShadowRoot by ensuring that it is a\n // DocumentFragment and also has a host property. This check covers native\n // implementation and polyfill implementation transparently. If we only cared\n // about the native implementation, we could just check if the scope was\n // an instance of a ShadowRoot.\n if (scope.nodeType === Node.DOCUMENT_FRAGMENT_NODE && scope.host) {\n // Since a ShadowRoot is a special kind of DocumentFragment, it does not\n // have a root element to add a class to. So, we add this attribute to the\n // host element instead:\n scope.host.setAttribute('data-js-focus-visible', '');\n } else if (scope.nodeType === Node.DOCUMENT_NODE) {\n document.documentElement.classList.add('js-focus-visible');\n document.documentElement.setAttribute('data-js-focus-visible', '');\n }\n }\n\n // It is important to wrap all references to global window and document in\n // these checks to support server-side rendering use cases\n // @see https://github.com/WICG/focus-visible/issues/199\n if (typeof window !== 'undefined' && typeof document !== 'undefined') {\n // Make the polyfill helper globally available. This can be used as a signal\n // to interested libraries that wish to coordinate with the polyfill for e.g.,\n // applying the polyfill to a shadow root:\n window.applyFocusVisiblePolyfill = applyFocusVisiblePolyfill;\n\n // Notify interested libraries of the polyfill's presence, in case the\n // polyfill was loaded lazily:\n var event;\n\n try {\n event = new CustomEvent('focus-visible-polyfill-ready');\n } catch (error) {\n // IE11 does not support using CustomEvent as a constructor directly:\n event = document.createEvent('CustomEvent');\n event.initCustomEvent('focus-visible-polyfill-ready', false, false, {});\n }\n\n window.dispatchEvent(event);\n }\n\n if (typeof document !== 'undefined') {\n // Apply the polyfill to the global document, so that no JavaScript\n // coordination is required to use the polyfill in the top-level document:\n applyFocusVisiblePolyfill(document);\n }\n\n})));\n", "/*!\n * clipboard.js v2.0.11\n * https://clipboardjs.com/\n *\n * Licensed MIT \u00A9 Zeno Rocha\n */\n(function webpackUniversalModuleDefinition(root, factory) {\n\tif(typeof exports === 'object' && typeof module === 'object')\n\t\tmodule.exports = factory();\n\telse if(typeof define === 'function' && define.amd)\n\t\tdefine([], factory);\n\telse if(typeof exports === 'object')\n\t\texports[\"ClipboardJS\"] = factory();\n\telse\n\t\troot[\"ClipboardJS\"] = factory();\n})(this, function() {\nreturn /******/ (function() { // webpackBootstrap\n/******/ \tvar __webpack_modules__ = ({\n\n/***/ 686:\n/***/ (function(__unused_webpack_module, __webpack_exports__, __webpack_require__) {\n\n\"use strict\";\n\n// EXPORTS\n__webpack_require__.d(__webpack_exports__, {\n \"default\": function() { return /* binding */ clipboard; }\n});\n\n// EXTERNAL MODULE: ./node_modules/tiny-emitter/index.js\nvar tiny_emitter = __webpack_require__(279);\nvar tiny_emitter_default = /*#__PURE__*/__webpack_require__.n(tiny_emitter);\n// EXTERNAL MODULE: ./node_modules/good-listener/src/listen.js\nvar listen = __webpack_require__(370);\nvar listen_default = /*#__PURE__*/__webpack_require__.n(listen);\n// EXTERNAL MODULE: ./node_modules/select/src/select.js\nvar src_select = __webpack_require__(817);\nvar select_default = /*#__PURE__*/__webpack_require__.n(src_select);\n;// CONCATENATED MODULE: ./src/common/command.js\n/**\n * Executes a given operation type.\n * @param {String} type\n * @return {Boolean}\n */\nfunction command(type) {\n try {\n return document.execCommand(type);\n } catch (err) {\n return false;\n }\n}\n;// CONCATENATED MODULE: ./src/actions/cut.js\n\n\n/**\n * Cut action wrapper.\n * @param {String|HTMLElement} target\n * @return {String}\n */\n\nvar ClipboardActionCut = function ClipboardActionCut(target) {\n var selectedText = select_default()(target);\n command('cut');\n return selectedText;\n};\n\n/* harmony default export */ var actions_cut = (ClipboardActionCut);\n;// CONCATENATED MODULE: ./src/common/create-fake-element.js\n/**\n * Creates a fake textarea element with a value.\n * @param {String} value\n * @return {HTMLElement}\n */\nfunction createFakeElement(value) {\n var isRTL = document.documentElement.getAttribute('dir') === 'rtl';\n var fakeElement = document.createElement('textarea'); // Prevent zooming on iOS\n\n fakeElement.style.fontSize = '12pt'; // Reset box model\n\n fakeElement.style.border = '0';\n fakeElement.style.padding = '0';\n fakeElement.style.margin = '0'; // Move element out of screen horizontally\n\n fakeElement.style.position = 'absolute';\n fakeElement.style[isRTL ? 'right' : 'left'] = '-9999px'; // Move element to the same position vertically\n\n var yPosition = window.pageYOffset || document.documentElement.scrollTop;\n fakeElement.style.top = \"\".concat(yPosition, \"px\");\n fakeElement.setAttribute('readonly', '');\n fakeElement.value = value;\n return fakeElement;\n}\n;// CONCATENATED MODULE: ./src/actions/copy.js\n\n\n\n/**\n * Create fake copy action wrapper using a fake element.\n * @param {String} target\n * @param {Object} options\n * @return {String}\n */\n\nvar fakeCopyAction = function fakeCopyAction(value, options) {\n var fakeElement = createFakeElement(value);\n options.container.appendChild(fakeElement);\n var selectedText = select_default()(fakeElement);\n command('copy');\n fakeElement.remove();\n return selectedText;\n};\n/**\n * Copy action wrapper.\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @return {String}\n */\n\n\nvar ClipboardActionCopy = function ClipboardActionCopy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n var selectedText = '';\n\n if (typeof target === 'string') {\n selectedText = fakeCopyAction(target, options);\n } else if (target instanceof HTMLInputElement && !['text', 'search', 'url', 'tel', 'password'].includes(target === null || target === void 0 ? void 0 : target.type)) {\n // If input type doesn't support `setSelectionRange`. Simulate it. https://developer.mozilla.org/en-US/docs/Web/API/HTMLInputElement/setSelectionRange\n selectedText = fakeCopyAction(target.value, options);\n } else {\n selectedText = select_default()(target);\n command('copy');\n }\n\n return selectedText;\n};\n\n/* harmony default export */ var actions_copy = (ClipboardActionCopy);\n;// CONCATENATED MODULE: ./src/actions/default.js\nfunction _typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { _typeof = function _typeof(obj) { return typeof obj; }; } else { _typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return _typeof(obj); }\n\n\n\n/**\n * Inner function which performs selection from either `text` or `target`\n * properties and then executes copy or cut operations.\n * @param {Object} options\n */\n\nvar ClipboardActionDefault = function ClipboardActionDefault() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n // Defines base properties passed from constructor.\n var _options$action = options.action,\n action = _options$action === void 0 ? 'copy' : _options$action,\n container = options.container,\n target = options.target,\n text = options.text; // Sets the `action` to be performed which can be either 'copy' or 'cut'.\n\n if (action !== 'copy' && action !== 'cut') {\n throw new Error('Invalid \"action\" value, use either \"copy\" or \"cut\"');\n } // Sets the `target` property using an element that will be have its content copied.\n\n\n if (target !== undefined) {\n if (target && _typeof(target) === 'object' && target.nodeType === 1) {\n if (action === 'copy' && target.hasAttribute('disabled')) {\n throw new Error('Invalid \"target\" attribute. Please use \"readonly\" instead of \"disabled\" attribute');\n }\n\n if (action === 'cut' && (target.hasAttribute('readonly') || target.hasAttribute('disabled'))) {\n throw new Error('Invalid \"target\" attribute. You can\\'t cut text from elements with \"readonly\" or \"disabled\" attributes');\n }\n } else {\n throw new Error('Invalid \"target\" value, use a valid Element');\n }\n } // Define selection strategy based on `text` property.\n\n\n if (text) {\n return actions_copy(text, {\n container: container\n });\n } // Defines which selection strategy based on `target` property.\n\n\n if (target) {\n return action === 'cut' ? actions_cut(target) : actions_copy(target, {\n container: container\n });\n }\n};\n\n/* harmony default export */ var actions_default = (ClipboardActionDefault);\n;// CONCATENATED MODULE: ./src/clipboard.js\nfunction clipboard_typeof(obj) { \"@babel/helpers - typeof\"; if (typeof Symbol === \"function\" && typeof Symbol.iterator === \"symbol\") { clipboard_typeof = function _typeof(obj) { return typeof obj; }; } else { clipboard_typeof = function _typeof(obj) { return obj && typeof Symbol === \"function\" && obj.constructor === Symbol && obj !== Symbol.prototype ? \"symbol\" : typeof obj; }; } return clipboard_typeof(obj); }\n\nfunction _classCallCheck(instance, Constructor) { if (!(instance instanceof Constructor)) { throw new TypeError(\"Cannot call a class as a function\"); } }\n\nfunction _defineProperties(target, props) { for (var i = 0; i < props.length; i++) { var descriptor = props[i]; descriptor.enumerable = descriptor.enumerable || false; descriptor.configurable = true; if (\"value\" in descriptor) descriptor.writable = true; Object.defineProperty(target, descriptor.key, descriptor); } }\n\nfunction _createClass(Constructor, protoProps, staticProps) { if (protoProps) _defineProperties(Constructor.prototype, protoProps); if (staticProps) _defineProperties(Constructor, staticProps); return Constructor; }\n\nfunction _inherits(subClass, superClass) { if (typeof superClass !== \"function\" && superClass !== null) { throw new TypeError(\"Super expression must either be null or a function\"); } subClass.prototype = Object.create(superClass && superClass.prototype, { constructor: { value: subClass, writable: true, configurable: true } }); if (superClass) _setPrototypeOf(subClass, superClass); }\n\nfunction _setPrototypeOf(o, p) { _setPrototypeOf = Object.setPrototypeOf || function _setPrototypeOf(o, p) { o.__proto__ = p; return o; }; return _setPrototypeOf(o, p); }\n\nfunction _createSuper(Derived) { var hasNativeReflectConstruct = _isNativeReflectConstruct(); return function _createSuperInternal() { var Super = _getPrototypeOf(Derived), result; if (hasNativeReflectConstruct) { var NewTarget = _getPrototypeOf(this).constructor; result = Reflect.construct(Super, arguments, NewTarget); } else { result = Super.apply(this, arguments); } return _possibleConstructorReturn(this, result); }; }\n\nfunction _possibleConstructorReturn(self, call) { if (call && (clipboard_typeof(call) === \"object\" || typeof call === \"function\")) { return call; } return _assertThisInitialized(self); }\n\nfunction _assertThisInitialized(self) { if (self === void 0) { throw new ReferenceError(\"this hasn't been initialised - super() hasn't been called\"); } return self; }\n\nfunction _isNativeReflectConstruct() { if (typeof Reflect === \"undefined\" || !Reflect.construct) return false; if (Reflect.construct.sham) return false; if (typeof Proxy === \"function\") return true; try { Date.prototype.toString.call(Reflect.construct(Date, [], function () {})); return true; } catch (e) { return false; } }\n\nfunction _getPrototypeOf(o) { _getPrototypeOf = Object.setPrototypeOf ? Object.getPrototypeOf : function _getPrototypeOf(o) { return o.__proto__ || Object.getPrototypeOf(o); }; return _getPrototypeOf(o); }\n\n\n\n\n\n\n/**\n * Helper function to retrieve attribute value.\n * @param {String} suffix\n * @param {Element} element\n */\n\nfunction getAttributeValue(suffix, element) {\n var attribute = \"data-clipboard-\".concat(suffix);\n\n if (!element.hasAttribute(attribute)) {\n return;\n }\n\n return element.getAttribute(attribute);\n}\n/**\n * Base class which takes one or more elements, adds event listeners to them,\n * and instantiates a new `ClipboardAction` on each click.\n */\n\n\nvar Clipboard = /*#__PURE__*/function (_Emitter) {\n _inherits(Clipboard, _Emitter);\n\n var _super = _createSuper(Clipboard);\n\n /**\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n * @param {Object} options\n */\n function Clipboard(trigger, options) {\n var _this;\n\n _classCallCheck(this, Clipboard);\n\n _this = _super.call(this);\n\n _this.resolveOptions(options);\n\n _this.listenClick(trigger);\n\n return _this;\n }\n /**\n * Defines if attributes would be resolved using internal setter functions\n * or custom functions that were passed in the constructor.\n * @param {Object} options\n */\n\n\n _createClass(Clipboard, [{\n key: \"resolveOptions\",\n value: function resolveOptions() {\n var options = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : {};\n this.action = typeof options.action === 'function' ? options.action : this.defaultAction;\n this.target = typeof options.target === 'function' ? options.target : this.defaultTarget;\n this.text = typeof options.text === 'function' ? options.text : this.defaultText;\n this.container = clipboard_typeof(options.container) === 'object' ? options.container : document.body;\n }\n /**\n * Adds a click event listener to the passed trigger.\n * @param {String|HTMLElement|HTMLCollection|NodeList} trigger\n */\n\n }, {\n key: \"listenClick\",\n value: function listenClick(trigger) {\n var _this2 = this;\n\n this.listener = listen_default()(trigger, 'click', function (e) {\n return _this2.onClick(e);\n });\n }\n /**\n * Defines a new `ClipboardAction` on each click event.\n * @param {Event} e\n */\n\n }, {\n key: \"onClick\",\n value: function onClick(e) {\n var trigger = e.delegateTarget || e.currentTarget;\n var action = this.action(trigger) || 'copy';\n var text = actions_default({\n action: action,\n container: this.container,\n target: this.target(trigger),\n text: this.text(trigger)\n }); // Fires an event based on the copy operation result.\n\n this.emit(text ? 'success' : 'error', {\n action: action,\n text: text,\n trigger: trigger,\n clearSelection: function clearSelection() {\n if (trigger) {\n trigger.focus();\n }\n\n window.getSelection().removeAllRanges();\n }\n });\n }\n /**\n * Default `action` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultAction\",\n value: function defaultAction(trigger) {\n return getAttributeValue('action', trigger);\n }\n /**\n * Default `target` lookup function.\n * @param {Element} trigger\n */\n\n }, {\n key: \"defaultTarget\",\n value: function defaultTarget(trigger) {\n var selector = getAttributeValue('target', trigger);\n\n if (selector) {\n return document.querySelector(selector);\n }\n }\n /**\n * Allow fire programmatically a copy action\n * @param {String|HTMLElement} target\n * @param {Object} options\n * @returns Text copied.\n */\n\n }, {\n key: \"defaultText\",\n\n /**\n * Default `text` lookup function.\n * @param {Element} trigger\n */\n value: function defaultText(trigger) {\n return getAttributeValue('text', trigger);\n }\n /**\n * Destroy lifecycle.\n */\n\n }, {\n key: \"destroy\",\n value: function destroy() {\n this.listener.destroy();\n }\n }], [{\n key: \"copy\",\n value: function copy(target) {\n var options = arguments.length > 1 && arguments[1] !== undefined ? arguments[1] : {\n container: document.body\n };\n return actions_copy(target, options);\n }\n /**\n * Allow fire programmatically a cut action\n * @param {String|HTMLElement} target\n * @returns Text cutted.\n */\n\n }, {\n key: \"cut\",\n value: function cut(target) {\n return actions_cut(target);\n }\n /**\n * Returns the support of the given action, or all actions if no action is\n * given.\n * @param {String} [action]\n */\n\n }, {\n key: \"isSupported\",\n value: function isSupported() {\n var action = arguments.length > 0 && arguments[0] !== undefined ? arguments[0] : ['copy', 'cut'];\n var actions = typeof action === 'string' ? [action] : action;\n var support = !!document.queryCommandSupported;\n actions.forEach(function (action) {\n support = support && !!document.queryCommandSupported(action);\n });\n return support;\n }\n }]);\n\n return Clipboard;\n}((tiny_emitter_default()));\n\n/* harmony default export */ var clipboard = (Clipboard);\n\n/***/ }),\n\n/***/ 828:\n/***/ (function(module) {\n\nvar DOCUMENT_NODE_TYPE = 9;\n\n/**\n * A polyfill for Element.matches()\n */\nif (typeof Element !== 'undefined' && !Element.prototype.matches) {\n var proto = Element.prototype;\n\n proto.matches = proto.matchesSelector ||\n proto.mozMatchesSelector ||\n proto.msMatchesSelector ||\n proto.oMatchesSelector ||\n proto.webkitMatchesSelector;\n}\n\n/**\n * Finds the closest parent that matches a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @return {Function}\n */\nfunction closest (element, selector) {\n while (element && element.nodeType !== DOCUMENT_NODE_TYPE) {\n if (typeof element.matches === 'function' &&\n element.matches(selector)) {\n return element;\n }\n element = element.parentNode;\n }\n}\n\nmodule.exports = closest;\n\n\n/***/ }),\n\n/***/ 438:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar closest = __webpack_require__(828);\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction _delegate(element, selector, type, callback, useCapture) {\n var listenerFn = listener.apply(this, arguments);\n\n element.addEventListener(type, listenerFn, useCapture);\n\n return {\n destroy: function() {\n element.removeEventListener(type, listenerFn, useCapture);\n }\n }\n}\n\n/**\n * Delegates event to a selector.\n *\n * @param {Element|String|Array} [elements]\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @param {Boolean} useCapture\n * @return {Object}\n */\nfunction delegate(elements, selector, type, callback, useCapture) {\n // Handle the regular Element usage\n if (typeof elements.addEventListener === 'function') {\n return _delegate.apply(null, arguments);\n }\n\n // Handle Element-less usage, it defaults to global delegation\n if (typeof type === 'function') {\n // Use `document` as the first parameter, then apply arguments\n // This is a short way to .unshift `arguments` without running into deoptimizations\n return _delegate.bind(null, document).apply(null, arguments);\n }\n\n // Handle Selector-based usage\n if (typeof elements === 'string') {\n elements = document.querySelectorAll(elements);\n }\n\n // Handle Array-like based usage\n return Array.prototype.map.call(elements, function (element) {\n return _delegate(element, selector, type, callback, useCapture);\n });\n}\n\n/**\n * Finds closest match and invokes callback.\n *\n * @param {Element} element\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Function}\n */\nfunction listener(element, selector, type, callback) {\n return function(e) {\n e.delegateTarget = closest(e.target, selector);\n\n if (e.delegateTarget) {\n callback.call(element, e);\n }\n }\n}\n\nmodule.exports = delegate;\n\n\n/***/ }),\n\n/***/ 879:\n/***/ (function(__unused_webpack_module, exports) {\n\n/**\n * Check if argument is a HTML element.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.node = function(value) {\n return value !== undefined\n && value instanceof HTMLElement\n && value.nodeType === 1;\n};\n\n/**\n * Check if argument is a list of HTML elements.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.nodeList = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return value !== undefined\n && (type === '[object NodeList]' || type === '[object HTMLCollection]')\n && ('length' in value)\n && (value.length === 0 || exports.node(value[0]));\n};\n\n/**\n * Check if argument is a string.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.string = function(value) {\n return typeof value === 'string'\n || value instanceof String;\n};\n\n/**\n * Check if argument is a function.\n *\n * @param {Object} value\n * @return {Boolean}\n */\nexports.fn = function(value) {\n var type = Object.prototype.toString.call(value);\n\n return type === '[object Function]';\n};\n\n\n/***/ }),\n\n/***/ 370:\n/***/ (function(module, __unused_webpack_exports, __webpack_require__) {\n\nvar is = __webpack_require__(879);\nvar delegate = __webpack_require__(438);\n\n/**\n * Validates all params and calls the right\n * listener function based on its target type.\n *\n * @param {String|HTMLElement|HTMLCollection|NodeList} target\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listen(target, type, callback) {\n if (!target && !type && !callback) {\n throw new Error('Missing required arguments');\n }\n\n if (!is.string(type)) {\n throw new TypeError('Second argument must be a String');\n }\n\n if (!is.fn(callback)) {\n throw new TypeError('Third argument must be a Function');\n }\n\n if (is.node(target)) {\n return listenNode(target, type, callback);\n }\n else if (is.nodeList(target)) {\n return listenNodeList(target, type, callback);\n }\n else if (is.string(target)) {\n return listenSelector(target, type, callback);\n }\n else {\n throw new TypeError('First argument must be a String, HTMLElement, HTMLCollection, or NodeList');\n }\n}\n\n/**\n * Adds an event listener to a HTML element\n * and returns a remove listener function.\n *\n * @param {HTMLElement} node\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNode(node, type, callback) {\n node.addEventListener(type, callback);\n\n return {\n destroy: function() {\n node.removeEventListener(type, callback);\n }\n }\n}\n\n/**\n * Add an event listener to a list of HTML elements\n * and returns a remove listener function.\n *\n * @param {NodeList|HTMLCollection} nodeList\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenNodeList(nodeList, type, callback) {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.addEventListener(type, callback);\n });\n\n return {\n destroy: function() {\n Array.prototype.forEach.call(nodeList, function(node) {\n node.removeEventListener(type, callback);\n });\n }\n }\n}\n\n/**\n * Add an event listener to a selector\n * and returns a remove listener function.\n *\n * @param {String} selector\n * @param {String} type\n * @param {Function} callback\n * @return {Object}\n */\nfunction listenSelector(selector, type, callback) {\n return delegate(document.body, selector, type, callback);\n}\n\nmodule.exports = listen;\n\n\n/***/ }),\n\n/***/ 817:\n/***/ (function(module) {\n\nfunction select(element) {\n var selectedText;\n\n if (element.nodeName === 'SELECT') {\n element.focus();\n\n selectedText = element.value;\n }\n else if (element.nodeName === 'INPUT' || element.nodeName === 'TEXTAREA') {\n var isReadOnly = element.hasAttribute('readonly');\n\n if (!isReadOnly) {\n element.setAttribute('readonly', '');\n }\n\n element.select();\n element.setSelectionRange(0, element.value.length);\n\n if (!isReadOnly) {\n element.removeAttribute('readonly');\n }\n\n selectedText = element.value;\n }\n else {\n if (element.hasAttribute('contenteditable')) {\n element.focus();\n }\n\n var selection = window.getSelection();\n var range = document.createRange();\n\n range.selectNodeContents(element);\n selection.removeAllRanges();\n selection.addRange(range);\n\n selectedText = selection.toString();\n }\n\n return selectedText;\n}\n\nmodule.exports = select;\n\n\n/***/ }),\n\n/***/ 279:\n/***/ (function(module) {\n\nfunction E () {\n // Keep this empty so it's easier to inherit from\n // (via https://github.com/lipsmack from https://github.com/scottcorgan/tiny-emitter/issues/3)\n}\n\nE.prototype = {\n on: function (name, callback, ctx) {\n var e = this.e || (this.e = {});\n\n (e[name] || (e[name] = [])).push({\n fn: callback,\n ctx: ctx\n });\n\n return this;\n },\n\n once: function (name, callback, ctx) {\n var self = this;\n function listener () {\n self.off(name, listener);\n callback.apply(ctx, arguments);\n };\n\n listener._ = callback\n return this.on(name, listener, ctx);\n },\n\n emit: function (name) {\n var data = [].slice.call(arguments, 1);\n var evtArr = ((this.e || (this.e = {}))[name] || []).slice();\n var i = 0;\n var len = evtArr.length;\n\n for (i; i < len; i++) {\n evtArr[i].fn.apply(evtArr[i].ctx, data);\n }\n\n return this;\n },\n\n off: function (name, callback) {\n var e = this.e || (this.e = {});\n var evts = e[name];\n var liveEvents = [];\n\n if (evts && callback) {\n for (var i = 0, len = evts.length; i < len; i++) {\n if (evts[i].fn !== callback && evts[i].fn._ !== callback)\n liveEvents.push(evts[i]);\n }\n }\n\n // Remove event from queue to prevent memory leak\n // Suggested by https://github.com/lazd\n // Ref: https://github.com/scottcorgan/tiny-emitter/commit/c6ebfaa9bc973b33d110a84a307742b7cf94c953#commitcomment-5024910\n\n (liveEvents.length)\n ? e[name] = liveEvents\n : delete e[name];\n\n return this;\n }\n};\n\nmodule.exports = E;\nmodule.exports.TinyEmitter = E;\n\n\n/***/ })\n\n/******/ \t});\n/************************************************************************/\n/******/ \t// The module cache\n/******/ \tvar __webpack_module_cache__ = {};\n/******/ \t\n/******/ \t// The require function\n/******/ \tfunction __webpack_require__(moduleId) {\n/******/ \t\t// Check if module is in cache\n/******/ \t\tif(__webpack_module_cache__[moduleId]) {\n/******/ \t\t\treturn __webpack_module_cache__[moduleId].exports;\n/******/ \t\t}\n/******/ \t\t// Create a new module (and put it into the cache)\n/******/ \t\tvar module = __webpack_module_cache__[moduleId] = {\n/******/ \t\t\t// no module.id needed\n/******/ \t\t\t// no module.loaded needed\n/******/ \t\t\texports: {}\n/******/ \t\t};\n/******/ \t\n/******/ \t\t// Execute the module function\n/******/ \t\t__webpack_modules__[moduleId](module, module.exports, __webpack_require__);\n/******/ \t\n/******/ \t\t// Return the exports of the module\n/******/ \t\treturn module.exports;\n/******/ \t}\n/******/ \t\n/************************************************************************/\n/******/ \t/* webpack/runtime/compat get default export */\n/******/ \t!function() {\n/******/ \t\t// getDefaultExport function for compatibility with non-harmony modules\n/******/ \t\t__webpack_require__.n = function(module) {\n/******/ \t\t\tvar getter = module && module.__esModule ?\n/******/ \t\t\t\tfunction() { return module['default']; } :\n/******/ \t\t\t\tfunction() { return module; };\n/******/ \t\t\t__webpack_require__.d(getter, { a: getter });\n/******/ \t\t\treturn getter;\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/define property getters */\n/******/ \t!function() {\n/******/ \t\t// define getter functions for harmony exports\n/******/ \t\t__webpack_require__.d = function(exports, definition) {\n/******/ \t\t\tfor(var key in definition) {\n/******/ \t\t\t\tif(__webpack_require__.o(definition, key) && !__webpack_require__.o(exports, key)) {\n/******/ \t\t\t\t\tObject.defineProperty(exports, key, { enumerable: true, get: definition[key] });\n/******/ \t\t\t\t}\n/******/ \t\t\t}\n/******/ \t\t};\n/******/ \t}();\n/******/ \t\n/******/ \t/* webpack/runtime/hasOwnProperty shorthand */\n/******/ \t!function() {\n/******/ \t\t__webpack_require__.o = function(obj, prop) { return Object.prototype.hasOwnProperty.call(obj, prop); }\n/******/ \t}();\n/******/ \t\n/************************************************************************/\n/******/ \t// module exports must be returned from runtime so entry inlining is disabled\n/******/ \t// startup\n/******/ \t// Load entry module and return exports\n/******/ \treturn __webpack_require__(686);\n/******/ })()\n.default;\n});", "/*!\n * escape-html\n * Copyright(c) 2012-2013 TJ Holowaychuk\n * Copyright(c) 2015 Andreas Lubbe\n * Copyright(c) 2015 Tiancheng \"Timothy\" Gu\n * MIT Licensed\n */\n\n'use strict';\n\n/**\n * Module variables.\n * @private\n */\n\nvar matchHtmlRegExp = /[\"'&<>]/;\n\n/**\n * Module exports.\n * @public\n */\n\nmodule.exports = escapeHtml;\n\n/**\n * Escape special characters in the given string of html.\n *\n * @param {string} string The string to escape for inserting into HTML\n * @return {string}\n * @public\n */\n\nfunction escapeHtml(string) {\n var str = '' + string;\n var match = matchHtmlRegExp.exec(str);\n\n if (!match) {\n return str;\n }\n\n var escape;\n var html = '';\n var index = 0;\n var lastIndex = 0;\n\n for (index = match.index; index < str.length; index++) {\n switch (str.charCodeAt(index)) {\n case 34: // \"\n escape = '"';\n break;\n case 38: // &\n escape = '&';\n break;\n case 39: // '\n escape = ''';\n break;\n case 60: // <\n escape = '<';\n break;\n case 62: // >\n escape = '>';\n break;\n default:\n continue;\n }\n\n if (lastIndex !== index) {\n html += str.substring(lastIndex, index);\n }\n\n lastIndex = index + 1;\n html += escape;\n }\n\n return lastIndex !== index\n ? html + str.substring(lastIndex, index)\n : html;\n}\n", "/*\n * Copyright (c) 2016-2024 Martin Donath \n *\n * Permission is hereby granted, free of charge, to any person obtaining a copy\n * of this software and associated documentation files (the \"Software\"), to\n * deal in the Software without restriction, including without limitation the\n * rights to use, copy, modify, merge, publish, distribute, sublicense, and/or\n * sell copies of the Software, and to permit persons to whom the Software is\n * furnished to do so, subject to the following conditions:\n *\n * The above copyright notice and this permission notice shall be included in\n * all copies or substantial portions of the Software.\n *\n * THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\n * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\n * FITNESS FOR A PARTICULAR PURPOSE AND NON-INFRINGEMENT. IN NO EVENT SHALL THE\n * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\n * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING\n * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS\n * IN THE SOFTWARE.\n */\n\nimport \"focus-visible\"\n\nimport {\n EMPTY,\n NEVER,\n Observable,\n Subject,\n defer,\n delay,\n filter,\n map,\n merge,\n mergeWith,\n shareReplay,\n switchMap\n} from \"rxjs\"\n\nimport { configuration, feature } from \"./_\"\nimport {\n at,\n getActiveElement,\n getOptionalElement,\n requestJSON,\n setLocation,\n setToggle,\n watchDocument,\n watchKeyboard,\n watchLocation,\n watchLocationTarget,\n watchMedia,\n watchPrint,\n watchScript,\n watchViewport\n} from \"./browser\"\nimport {\n getComponentElement,\n getComponentElements,\n mountAnnounce,\n mountBackToTop,\n mountConsent,\n mountContent,\n mountDialog,\n mountHeader,\n mountHeaderTitle,\n mountPalette,\n mountProgress,\n mountSearch,\n mountSearchHiglight,\n mountSidebar,\n mountSource,\n mountTableOfContents,\n mountTabs,\n watchHeader,\n watchMain\n} from \"./components\"\nimport {\n SearchIndex,\n setupClipboardJS,\n setupInstantNavigation,\n setupVersionSelector\n} from \"./integrations\"\nimport {\n patchEllipsis,\n patchIndeterminate,\n patchScrollfix,\n patchScrolllock\n} from \"./patches\"\nimport \"./polyfills\"\n\n/* ----------------------------------------------------------------------------\n * Functions - @todo refactor\n * ------------------------------------------------------------------------- */\n\n/**\n * Fetch search index\n *\n * @returns Search index observable\n */\nfunction fetchSearchIndex(): Observable {\n if (location.protocol === \"file:\") {\n return watchScript(\n `${new URL(\"search/search_index.js\", config.base)}`\n )\n .pipe(\n // @ts-ignore - @todo fix typings\n map(() => __index),\n shareReplay(1)\n )\n } else {\n return requestJSON(\n new URL(\"search/search_index.json\", config.base)\n )\n }\n}\n\n/* ----------------------------------------------------------------------------\n * Application\n * ------------------------------------------------------------------------- */\n\n/* Yay, JavaScript is available */\ndocument.documentElement.classList.remove(\"no-js\")\ndocument.documentElement.classList.add(\"js\")\n\n/* Set up navigation observables and subjects */\nconst document$ = watchDocument()\nconst location$ = watchLocation()\nconst target$ = watchLocationTarget(location$)\nconst keyboard$ = watchKeyboard()\n\n/* Set up media observables */\nconst viewport$ = watchViewport()\nconst tablet$ = watchMedia(\"(min-width: 960px)\")\nconst screen$ = watchMedia(\"(min-width: 1220px)\")\nconst print$ = watchPrint()\n\n/* Retrieve search index, if search is enabled */\nconst config = configuration()\nconst index$ = document.forms.namedItem(\"search\")\n ? fetchSearchIndex()\n : NEVER\n\n/* Set up Clipboard.js integration */\nconst alert$ = new Subject()\nsetupClipboardJS({ alert$ })\n\n/* Set up progress indicator */\nconst progress$ = new Subject()\n\n/* Set up instant navigation, if enabled */\nif (feature(\"navigation.instant\"))\n setupInstantNavigation({ location$, viewport$, progress$ })\n .subscribe(document$)\n\n/* Set up version selector */\nif (config.version?.provider === \"mike\")\n setupVersionSelector({ document$ })\n\n/* Always close drawer and search on navigation */\nmerge(location$, target$)\n .pipe(\n delay(125)\n )\n .subscribe(() => {\n setToggle(\"drawer\", false)\n setToggle(\"search\", false)\n })\n\n/* Set up global keyboard handlers */\nkeyboard$\n .pipe(\n filter(({ mode }) => mode === \"global\")\n )\n .subscribe(key => {\n switch (key.type) {\n\n /* Go to previous page */\n case \"p\":\n case \",\":\n const prev = getOptionalElement(\"link[rel=prev]\")\n if (typeof prev !== \"undefined\")\n setLocation(prev)\n break\n\n /* Go to next page */\n case \"n\":\n case \".\":\n const next = getOptionalElement(\"link[rel=next]\")\n if (typeof next !== \"undefined\")\n setLocation(next)\n break\n\n /* Expand navigation, see https://bit.ly/3ZjG5io */\n case \"Enter\":\n const active = getActiveElement()\n if (active instanceof HTMLLabelElement)\n active.click()\n }\n })\n\n/* Set up patches */\npatchEllipsis({ viewport$, document$ })\npatchIndeterminate({ document$, tablet$ })\npatchScrollfix({ document$ })\npatchScrolllock({ viewport$, tablet$ })\n\n/* Set up header and main area observable */\nconst header$ = watchHeader(getComponentElement(\"header\"), { viewport$ })\nconst main$ = document$\n .pipe(\n map(() => getComponentElement(\"main\")),\n switchMap(el => watchMain(el, { viewport$, header$ })),\n shareReplay(1)\n )\n\n/* Set up control component observables */\nconst control$ = merge(\n\n /* Consent */\n ...getComponentElements(\"consent\")\n .map(el => mountConsent(el, { target$ })),\n\n /* Dialog */\n ...getComponentElements(\"dialog\")\n .map(el => mountDialog(el, { alert$ })),\n\n /* Header */\n ...getComponentElements(\"header\")\n .map(el => mountHeader(el, { viewport$, header$, main$ })),\n\n /* Color palette */\n ...getComponentElements(\"palette\")\n .map(el => mountPalette(el)),\n\n /* Progress bar */\n ...getComponentElements(\"progress\")\n .map(el => mountProgress(el, { progress$ })),\n\n /* Search */\n ...getComponentElements(\"search\")\n .map(el => mountSearch(el, { index$, keyboard$ })),\n\n /* Repository information */\n ...getComponentElements(\"source\")\n .map(el => mountSource(el))\n)\n\n/* Set up content component observables */\nconst content$ = defer(() => merge(\n\n /* Announcement bar */\n ...getComponentElements(\"announce\")\n .map(el => mountAnnounce(el)),\n\n /* Content */\n ...getComponentElements(\"content\")\n .map(el => mountContent(el, { viewport$, target$, print$ })),\n\n /* Search highlighting */\n ...getComponentElements(\"content\")\n .map(el => feature(\"search.highlight\")\n ? mountSearchHiglight(el, { index$, location$ })\n : EMPTY\n ),\n\n /* Header title */\n ...getComponentElements(\"header-title\")\n .map(el => mountHeaderTitle(el, { viewport$, header$ })),\n\n /* Sidebar */\n ...getComponentElements(\"sidebar\")\n .map(el => el.getAttribute(\"data-md-type\") === \"navigation\"\n ? at(screen$, () => mountSidebar(el, { viewport$, header$, main$ }))\n : at(tablet$, () => mountSidebar(el, { viewport$, header$, main$ }))\n ),\n\n /* Navigation tabs */\n ...getComponentElements(\"tabs\")\n .map(el => mountTabs(el, { viewport$, header$ })),\n\n /* Table of contents */\n ...getComponentElements(\"toc\")\n .map(el => mountTableOfContents(el, {\n viewport$, header$, main$, target$\n })),\n\n /* Back-to-top button */\n ...getComponentElements(\"top\")\n .map(el => mountBackToTop(el, { viewport$, header$, main$, target$ }))\n))\n\n/* Set up component observables */\nconst component$ = document$\n .pipe(\n switchMap(() => content$),\n mergeWith(control$),\n shareReplay(1)\n )\n\n/* Subscribe to all components */\ncomponent$.subscribe()\n\n/* ----------------------------------------------------------------------------\n * Exports\n * ------------------------------------------------------------------------- */\n\nwindow.document$ = document$ /* Document observable */\nwindow.location$ = location$ /* Location subject */\nwindow.target$ = target$ /* Location target observable */\nwindow.keyboard$ = keyboard$ /* Keyboard observable */\nwindow.viewport$ = viewport$ /* Viewport observable */\nwindow.tablet$ = tablet$ /* Media tablet observable */\nwindow.screen$ = screen$ /* Media screen observable */\nwindow.print$ = print$ /* Media print observable */\nwindow.alert$ = alert$ /* Alert subject */\nwindow.progress$ = progress$ /* Progress indicator subject */\nwindow.component$ = component$ /* Component observable */\n", "/*! *****************************************************************************\r\nCopyright (c) Microsoft Corporation.\r\n\r\nPermission to use, copy, modify, and/or distribute this software for any\r\npurpose with or without fee is hereby granted.\r\n\r\nTHE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH\r\nREGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY\r\nAND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT,\r\nINDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM\r\nLOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR\r\nOTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR\r\nPERFORMANCE OF THIS SOFTWARE.\r\n***************************************************************************** */\r\n/* global Reflect, Promise */\r\n\r\nvar extendStatics = function(d, b) {\r\n extendStatics = Object.setPrototypeOf ||\r\n ({ __proto__: [] } instanceof Array && function (d, b) { d.__proto__ = b; }) ||\r\n function (d, b) { for (var p in b) if (Object.prototype.hasOwnProperty.call(b, p)) d[p] = b[p]; };\r\n return extendStatics(d, b);\r\n};\r\n\r\nexport function __extends(d, b) {\r\n if (typeof b !== \"function\" && b !== null)\r\n throw new TypeError(\"Class extends value \" + String(b) + \" is not a constructor or null\");\r\n extendStatics(d, b);\r\n function __() { this.constructor = d; }\r\n d.prototype = b === null ? Object.create(b) : (__.prototype = b.prototype, new __());\r\n}\r\n\r\nexport var __assign = function() {\r\n __assign = Object.assign || function __assign(t) {\r\n for (var s, i = 1, n = arguments.length; i < n; i++) {\r\n s = arguments[i];\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p)) t[p] = s[p];\r\n }\r\n return t;\r\n }\r\n return __assign.apply(this, arguments);\r\n}\r\n\r\nexport function __rest(s, e) {\r\n var t = {};\r\n for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p) && e.indexOf(p) < 0)\r\n t[p] = s[p];\r\n if (s != null && typeof Object.getOwnPropertySymbols === \"function\")\r\n for (var i = 0, p = Object.getOwnPropertySymbols(s); i < p.length; i++) {\r\n if (e.indexOf(p[i]) < 0 && Object.prototype.propertyIsEnumerable.call(s, p[i]))\r\n t[p[i]] = s[p[i]];\r\n }\r\n return t;\r\n}\r\n\r\nexport function __decorate(decorators, target, key, desc) {\r\n var c = arguments.length, r = c < 3 ? target : desc === null ? desc = Object.getOwnPropertyDescriptor(target, key) : desc, d;\r\n if (typeof Reflect === \"object\" && typeof Reflect.decorate === \"function\") r = Reflect.decorate(decorators, target, key, desc);\r\n else for (var i = decorators.length - 1; i >= 0; i--) if (d = decorators[i]) r = (c < 3 ? d(r) : c > 3 ? d(target, key, r) : d(target, key)) || r;\r\n return c > 3 && r && Object.defineProperty(target, key, r), r;\r\n}\r\n\r\nexport function __param(paramIndex, decorator) {\r\n return function (target, key) { decorator(target, key, paramIndex); }\r\n}\r\n\r\nexport function __metadata(metadataKey, metadataValue) {\r\n if (typeof Reflect === \"object\" && typeof Reflect.metadata === \"function\") return Reflect.metadata(metadataKey, metadataValue);\r\n}\r\n\r\nexport function __awaiter(thisArg, _arguments, P, generator) {\r\n function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }\r\n return new (P || (P = Promise))(function (resolve, reject) {\r\n function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }\r\n function rejected(value) { try { step(generator[\"throw\"](value)); } catch (e) { reject(e); } }\r\n function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }\r\n step((generator = generator.apply(thisArg, _arguments || [])).next());\r\n });\r\n}\r\n\r\nexport function __generator(thisArg, body) {\r\n var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;\r\n return g = { next: verb(0), \"throw\": verb(1), \"return\": verb(2) }, typeof Symbol === \"function\" && (g[Symbol.iterator] = function() { return this; }), g;\r\n function verb(n) { return function (v) { return step([n, v]); }; }\r\n function step(op) {\r\n if (f) throw new TypeError(\"Generator is already executing.\");\r\n while (_) try {\r\n if (f = 1, y && (t = op[0] & 2 ? y[\"return\"] : op[0] ? y[\"throw\"] || ((t = y[\"return\"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;\r\n if (y = 0, t) op = [op[0] & 2, t.value];\r\n switch (op[0]) {\r\n case 0: case 1: t = op; break;\r\n case 4: _.label++; return { value: op[1], done: false };\r\n case 5: _.label++; y = op[1]; op = [0]; continue;\r\n case 7: op = _.ops.pop(); _.trys.pop(); continue;\r\n default:\r\n if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }\r\n if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }\r\n if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }\r\n if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }\r\n if (t[2]) _.ops.pop();\r\n _.trys.pop(); continue;\r\n }\r\n op = body.call(thisArg, _);\r\n } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }\r\n if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };\r\n }\r\n}\r\n\r\nexport var __createBinding = Object.create ? (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });\r\n}) : (function(o, m, k, k2) {\r\n if (k2 === undefined) k2 = k;\r\n o[k2] = m[k];\r\n});\r\n\r\nexport function __exportStar(m, o) {\r\n for (var p in m) if (p !== \"default\" && !Object.prototype.hasOwnProperty.call(o, p)) __createBinding(o, m, p);\r\n}\r\n\r\nexport function __values(o) {\r\n var s = typeof Symbol === \"function\" && Symbol.iterator, m = s && o[s], i = 0;\r\n if (m) return m.call(o);\r\n if (o && typeof o.length === \"number\") return {\r\n next: function () {\r\n if (o && i >= o.length) o = void 0;\r\n return { value: o && o[i++], done: !o };\r\n }\r\n };\r\n throw new TypeError(s ? \"Object is not iterable.\" : \"Symbol.iterator is not defined.\");\r\n}\r\n\r\nexport function __read(o, n) {\r\n var m = typeof Symbol === \"function\" && o[Symbol.iterator];\r\n if (!m) return o;\r\n var i = m.call(o), r, ar = [], e;\r\n try {\r\n while ((n === void 0 || n-- > 0) && !(r = i.next()).done) ar.push(r.value);\r\n }\r\n catch (error) { e = { error: error }; }\r\n finally {\r\n try {\r\n if (r && !r.done && (m = i[\"return\"])) m.call(i);\r\n }\r\n finally { if (e) throw e.error; }\r\n }\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spread() {\r\n for (var ar = [], i = 0; i < arguments.length; i++)\r\n ar = ar.concat(__read(arguments[i]));\r\n return ar;\r\n}\r\n\r\n/** @deprecated */\r\nexport function __spreadArrays() {\r\n for (var s = 0, i = 0, il = arguments.length; i < il; i++) s += arguments[i].length;\r\n for (var r = Array(s), k = 0, i = 0; i < il; i++)\r\n for (var a = arguments[i], j = 0, jl = a.length; j < jl; j++, k++)\r\n r[k] = a[j];\r\n return r;\r\n}\r\n\r\nexport function __spreadArray(to, from, pack) {\r\n if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {\r\n if (ar || !(i in from)) {\r\n if (!ar) ar = Array.prototype.slice.call(from, 0, i);\r\n ar[i] = from[i];\r\n }\r\n }\r\n return to.concat(ar || Array.prototype.slice.call(from));\r\n}\r\n\r\nexport function __await(v) {\r\n return this instanceof __await ? (this.v = v, this) : new __await(v);\r\n}\r\n\r\nexport function __asyncGenerator(thisArg, _arguments, generator) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var g = generator.apply(thisArg, _arguments || []), i, q = [];\r\n return i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i;\r\n function verb(n) { if (g[n]) i[n] = function (v) { return new Promise(function (a, b) { q.push([n, v, a, b]) > 1 || resume(n, v); }); }; }\r\n function resume(n, v) { try { step(g[n](v)); } catch (e) { settle(q[0][3], e); } }\r\n function step(r) { r.value instanceof __await ? Promise.resolve(r.value.v).then(fulfill, reject) : settle(q[0][2], r); }\r\n function fulfill(value) { resume(\"next\", value); }\r\n function reject(value) { resume(\"throw\", value); }\r\n function settle(f, v) { if (f(v), q.shift(), q.length) resume(q[0][0], q[0][1]); }\r\n}\r\n\r\nexport function __asyncDelegator(o) {\r\n var i, p;\r\n return i = {}, verb(\"next\"), verb(\"throw\", function (e) { throw e; }), verb(\"return\"), i[Symbol.iterator] = function () { return this; }, i;\r\n function verb(n, f) { i[n] = o[n] ? function (v) { return (p = !p) ? { value: __await(o[n](v)), done: n === \"return\" } : f ? f(v) : v; } : f; }\r\n}\r\n\r\nexport function __asyncValues(o) {\r\n if (!Symbol.asyncIterator) throw new TypeError(\"Symbol.asyncIterator is not defined.\");\r\n var m = o[Symbol.asyncIterator], i;\r\n return m ? m.call(o) : (o = typeof __values === \"function\" ? __values(o) : o[Symbol.iterator](), i = {}, verb(\"next\"), verb(\"throw\"), verb(\"return\"), i[Symbol.asyncIterator] = function () { return this; }, i);\r\n function verb(n) { i[n] = o[n] && function (v) { return new Promise(function (resolve, reject) { v = o[n](v), settle(resolve, reject, v.done, v.value); }); }; }\r\n function settle(resolve, reject, d, v) { Promise.resolve(v).then(function(v) { resolve({ value: v, done: d }); }, reject); }\r\n}\r\n\r\nexport function __makeTemplateObject(cooked, raw) {\r\n if (Object.defineProperty) { Object.defineProperty(cooked, \"raw\", { value: raw }); } else { cooked.raw = raw; }\r\n return cooked;\r\n};\r\n\r\nvar __setModuleDefault = Object.create ? (function(o, v) {\r\n Object.defineProperty(o, \"default\", { enumerable: true, value: v });\r\n}) : function(o, v) {\r\n o[\"default\"] = v;\r\n};\r\n\r\nexport function __importStar(mod) {\r\n if (mod && mod.__esModule) return mod;\r\n var result = {};\r\n if (mod != null) for (var k in mod) if (k !== \"default\" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);\r\n __setModuleDefault(result, mod);\r\n return result;\r\n}\r\n\r\nexport function __importDefault(mod) {\r\n return (mod && mod.__esModule) ? mod : { default: mod };\r\n}\r\n\r\nexport function __classPrivateFieldGet(receiver, state, kind, f) {\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a getter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot read private member from an object whose class did not declare it\");\r\n return kind === \"m\" ? f : kind === \"a\" ? f.call(receiver) : f ? f.value : state.get(receiver);\r\n}\r\n\r\nexport function __classPrivateFieldSet(receiver, state, value, kind, f) {\r\n if (kind === \"m\") throw new TypeError(\"Private method is not writable\");\r\n if (kind === \"a\" && !f) throw new TypeError(\"Private accessor was defined without a setter\");\r\n if (typeof state === \"function\" ? receiver !== state || !f : !state.has(receiver)) throw new TypeError(\"Cannot write private member to an object whose class did not declare it\");\r\n return (kind === \"a\" ? f.call(receiver, value) : f ? f.value = value : state.set(receiver, value)), value;\r\n}\r\n", "/**\n * Returns true if the object is a function.\n * @param value The value to check\n */\nexport function isFunction(value: any): value is (...args: any[]) => any {\n return typeof value === 'function';\n}\n", "/**\n * Used to create Error subclasses until the community moves away from ES5.\n *\n * This is because compiling from TypeScript down to ES5 has issues with subclassing Errors\n * as well as other built-in types: https://github.com/Microsoft/TypeScript/issues/12123\n *\n * @param createImpl A factory function to create the actual constructor implementation. The returned\n * function should be a named function that calls `_super` internally.\n */\nexport function createErrorClass(createImpl: (_super: any) => any): T {\n const _super = (instance: any) => {\n Error.call(instance);\n instance.stack = new Error().stack;\n };\n\n const ctorFunc = createImpl(_super);\n ctorFunc.prototype = Object.create(Error.prototype);\n ctorFunc.prototype.constructor = ctorFunc;\n return ctorFunc;\n}\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface UnsubscriptionError extends Error {\n readonly errors: any[];\n}\n\nexport interface UnsubscriptionErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (errors: any[]): UnsubscriptionError;\n}\n\n/**\n * An error thrown when one or more errors have occurred during the\n * `unsubscribe` of a {@link Subscription}.\n */\nexport const UnsubscriptionError: UnsubscriptionErrorCtor = createErrorClass(\n (_super) =>\n function UnsubscriptionErrorImpl(this: any, errors: (Error | string)[]) {\n _super(this);\n this.message = errors\n ? `${errors.length} errors occurred during unsubscription:\n${errors.map((err, i) => `${i + 1}) ${err.toString()}`).join('\\n ')}`\n : '';\n this.name = 'UnsubscriptionError';\n this.errors = errors;\n }\n);\n", "/**\n * Removes an item from an array, mutating it.\n * @param arr The array to remove the item from\n * @param item The item to remove\n */\nexport function arrRemove(arr: T[] | undefined | null, item: T) {\n if (arr) {\n const index = arr.indexOf(item);\n 0 <= index && arr.splice(index, 1);\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { UnsubscriptionError } from './util/UnsubscriptionError';\nimport { SubscriptionLike, TeardownLogic, Unsubscribable } from './types';\nimport { arrRemove } from './util/arrRemove';\n\n/**\n * Represents a disposable resource, such as the execution of an Observable. A\n * Subscription has one important method, `unsubscribe`, that takes no argument\n * and just disposes the resource held by the subscription.\n *\n * Additionally, subscriptions may be grouped together through the `add()`\n * method, which will attach a child Subscription to the current Subscription.\n * When a Subscription is unsubscribed, all its children (and its grandchildren)\n * will be unsubscribed as well.\n *\n * @class Subscription\n */\nexport class Subscription implements SubscriptionLike {\n /** @nocollapse */\n public static EMPTY = (() => {\n const empty = new Subscription();\n empty.closed = true;\n return empty;\n })();\n\n /**\n * A flag to indicate whether this Subscription has already been unsubscribed.\n */\n public closed = false;\n\n private _parentage: Subscription[] | Subscription | null = null;\n\n /**\n * The list of registered finalizers to execute upon unsubscription. Adding and removing from this\n * list occurs in the {@link #add} and {@link #remove} methods.\n */\n private _finalizers: Exclude[] | null = null;\n\n /**\n * @param initialTeardown A function executed first as part of the finalization\n * process that is kicked off when {@link #unsubscribe} is called.\n */\n constructor(private initialTeardown?: () => void) {}\n\n /**\n * Disposes the resources held by the subscription. May, for instance, cancel\n * an ongoing Observable execution or cancel any other type of work that\n * started when the Subscription was created.\n * @return {void}\n */\n unsubscribe(): void {\n let errors: any[] | undefined;\n\n if (!this.closed) {\n this.closed = true;\n\n // Remove this from it's parents.\n const { _parentage } = this;\n if (_parentage) {\n this._parentage = null;\n if (Array.isArray(_parentage)) {\n for (const parent of _parentage) {\n parent.remove(this);\n }\n } else {\n _parentage.remove(this);\n }\n }\n\n const { initialTeardown: initialFinalizer } = this;\n if (isFunction(initialFinalizer)) {\n try {\n initialFinalizer();\n } catch (e) {\n errors = e instanceof UnsubscriptionError ? e.errors : [e];\n }\n }\n\n const { _finalizers } = this;\n if (_finalizers) {\n this._finalizers = null;\n for (const finalizer of _finalizers) {\n try {\n execFinalizer(finalizer);\n } catch (err) {\n errors = errors ?? [];\n if (err instanceof UnsubscriptionError) {\n errors = [...errors, ...err.errors];\n } else {\n errors.push(err);\n }\n }\n }\n }\n\n if (errors) {\n throw new UnsubscriptionError(errors);\n }\n }\n }\n\n /**\n * Adds a finalizer to this subscription, so that finalization will be unsubscribed/called\n * when this subscription is unsubscribed. If this subscription is already {@link #closed},\n * because it has already been unsubscribed, then whatever finalizer is passed to it\n * will automatically be executed (unless the finalizer itself is also a closed subscription).\n *\n * Closed Subscriptions cannot be added as finalizers to any subscription. Adding a closed\n * subscription to a any subscription will result in no operation. (A noop).\n *\n * Adding a subscription to itself, or adding `null` or `undefined` will not perform any\n * operation at all. (A noop).\n *\n * `Subscription` instances that are added to this instance will automatically remove themselves\n * if they are unsubscribed. Functions and {@link Unsubscribable} objects that you wish to remove\n * will need to be removed manually with {@link #remove}\n *\n * @param teardown The finalization logic to add to this subscription.\n */\n add(teardown: TeardownLogic): void {\n // Only add the finalizer if it's not undefined\n // and don't add a subscription to itself.\n if (teardown && teardown !== this) {\n if (this.closed) {\n // If this subscription is already closed,\n // execute whatever finalizer is handed to it automatically.\n execFinalizer(teardown);\n } else {\n if (teardown instanceof Subscription) {\n // We don't add closed subscriptions, and we don't add the same subscription\n // twice. Subscription unsubscribe is idempotent.\n if (teardown.closed || teardown._hasParent(this)) {\n return;\n }\n teardown._addParent(this);\n }\n (this._finalizers = this._finalizers ?? []).push(teardown);\n }\n }\n }\n\n /**\n * Checks to see if a this subscription already has a particular parent.\n * This will signal that this subscription has already been added to the parent in question.\n * @param parent the parent to check for\n */\n private _hasParent(parent: Subscription) {\n const { _parentage } = this;\n return _parentage === parent || (Array.isArray(_parentage) && _parentage.includes(parent));\n }\n\n /**\n * Adds a parent to this subscription so it can be removed from the parent if it\n * unsubscribes on it's own.\n *\n * NOTE: THIS ASSUMES THAT {@link _hasParent} HAS ALREADY BEEN CHECKED.\n * @param parent The parent subscription to add\n */\n private _addParent(parent: Subscription) {\n const { _parentage } = this;\n this._parentage = Array.isArray(_parentage) ? (_parentage.push(parent), _parentage) : _parentage ? [_parentage, parent] : parent;\n }\n\n /**\n * Called on a child when it is removed via {@link #remove}.\n * @param parent The parent to remove\n */\n private _removeParent(parent: Subscription) {\n const { _parentage } = this;\n if (_parentage === parent) {\n this._parentage = null;\n } else if (Array.isArray(_parentage)) {\n arrRemove(_parentage, parent);\n }\n }\n\n /**\n * Removes a finalizer from this subscription that was previously added with the {@link #add} method.\n *\n * Note that `Subscription` instances, when unsubscribed, will automatically remove themselves\n * from every other `Subscription` they have been added to. This means that using the `remove` method\n * is not a common thing and should be used thoughtfully.\n *\n * If you add the same finalizer instance of a function or an unsubscribable object to a `Subscription` instance\n * more than once, you will need to call `remove` the same number of times to remove all instances.\n *\n * All finalizer instances are removed to free up memory upon unsubscription.\n *\n * @param teardown The finalizer to remove from this subscription\n */\n remove(teardown: Exclude): void {\n const { _finalizers } = this;\n _finalizers && arrRemove(_finalizers, teardown);\n\n if (teardown instanceof Subscription) {\n teardown._removeParent(this);\n }\n }\n}\n\nexport const EMPTY_SUBSCRIPTION = Subscription.EMPTY;\n\nexport function isSubscription(value: any): value is Subscription {\n return (\n value instanceof Subscription ||\n (value && 'closed' in value && isFunction(value.remove) && isFunction(value.add) && isFunction(value.unsubscribe))\n );\n}\n\nfunction execFinalizer(finalizer: Unsubscribable | (() => void)) {\n if (isFunction(finalizer)) {\n finalizer();\n } else {\n finalizer.unsubscribe();\n }\n}\n", "import { Subscriber } from './Subscriber';\nimport { ObservableNotification } from './types';\n\n/**\n * The {@link GlobalConfig} object for RxJS. It is used to configure things\n * like how to react on unhandled errors.\n */\nexport const config: GlobalConfig = {\n onUnhandledError: null,\n onStoppedNotification: null,\n Promise: undefined,\n useDeprecatedSynchronousErrorHandling: false,\n useDeprecatedNextContext: false,\n};\n\n/**\n * The global configuration object for RxJS, used to configure things\n * like how to react on unhandled errors. Accessible via {@link config}\n * object.\n */\nexport interface GlobalConfig {\n /**\n * A registration point for unhandled errors from RxJS. These are errors that\n * cannot were not handled by consuming code in the usual subscription path. For\n * example, if you have this configured, and you subscribe to an observable without\n * providing an error handler, errors from that subscription will end up here. This\n * will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onUnhandledError: ((err: any) => void) | null;\n\n /**\n * A registration point for notifications that cannot be sent to subscribers because they\n * have completed, errored or have been explicitly unsubscribed. By default, next, complete\n * and error notifications sent to stopped subscribers are noops. However, sometimes callers\n * might want a different behavior. For example, with sources that attempt to report errors\n * to stopped subscribers, a caller can configure RxJS to throw an unhandled error instead.\n * This will _always_ be called asynchronously on another job in the runtime. This is because\n * we do not want errors thrown in this user-configured handler to interfere with the\n * behavior of the library.\n */\n onStoppedNotification: ((notification: ObservableNotification, subscriber: Subscriber) => void) | null;\n\n /**\n * The promise constructor used by default for {@link Observable#toPromise toPromise} and {@link Observable#forEach forEach}\n * methods.\n *\n * @deprecated As of version 8, RxJS will no longer support this sort of injection of a\n * Promise constructor. If you need a Promise implementation other than native promises,\n * please polyfill/patch Promise as you see appropriate. Will be removed in v8.\n */\n Promise?: PromiseConstructorLike;\n\n /**\n * If true, turns on synchronous error rethrowing, which is a deprecated behavior\n * in v6 and higher. This behavior enables bad patterns like wrapping a subscribe\n * call in a try/catch block. It also enables producer interference, a nasty bug\n * where a multicast can be broken for all observers by a downstream consumer with\n * an unhandled error. DO NOT USE THIS FLAG UNLESS IT'S NEEDED TO BUY TIME\n * FOR MIGRATION REASONS.\n *\n * @deprecated As of version 8, RxJS will no longer support synchronous throwing\n * of unhandled errors. All errors will be thrown on a separate call stack to prevent bad\n * behaviors described above. Will be removed in v8.\n */\n useDeprecatedSynchronousErrorHandling: boolean;\n\n /**\n * If true, enables an as-of-yet undocumented feature from v5: The ability to access\n * `unsubscribe()` via `this` context in `next` functions created in observers passed\n * to `subscribe`.\n *\n * This is being removed because the performance was severely problematic, and it could also cause\n * issues when types other than POJOs are passed to subscribe as subscribers, as they will likely have\n * their `this` context overwritten.\n *\n * @deprecated As of version 8, RxJS will no longer support altering the\n * context of next functions provided as part of an observer to Subscribe. Instead,\n * you will have access to a subscription or a signal or token that will allow you to do things like\n * unsubscribe and test closed status. Will be removed in v8.\n */\n useDeprecatedNextContext: boolean;\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetTimeoutFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearTimeoutFunction = (handle: TimerHandle) => void;\n\ninterface TimeoutProvider {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n delegate:\n | {\n setTimeout: SetTimeoutFunction;\n clearTimeout: ClearTimeoutFunction;\n }\n | undefined;\n}\n\nexport const timeoutProvider: TimeoutProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setTimeout(handler: () => void, timeout?: number, ...args) {\n const { delegate } = timeoutProvider;\n if (delegate?.setTimeout) {\n return delegate.setTimeout(handler, timeout, ...args);\n }\n return setTimeout(handler, timeout, ...args);\n },\n clearTimeout(handle) {\n const { delegate } = timeoutProvider;\n return (delegate?.clearTimeout || clearTimeout)(handle as any);\n },\n delegate: undefined,\n};\n", "import { config } from '../config';\nimport { timeoutProvider } from '../scheduler/timeoutProvider';\n\n/**\n * Handles an error on another job either with the user-configured {@link onUnhandledError},\n * or by throwing it on that new job so it can be picked up by `window.onerror`, `process.on('error')`, etc.\n *\n * This should be called whenever there is an error that is out-of-band with the subscription\n * or when an error hits a terminal boundary of the subscription and no error handler was provided.\n *\n * @param err the error to report\n */\nexport function reportUnhandledError(err: any) {\n timeoutProvider.setTimeout(() => {\n const { onUnhandledError } = config;\n if (onUnhandledError) {\n // Execute the user-configured error handler.\n onUnhandledError(err);\n } else {\n // Throw so it is picked up by the runtime's uncaught error mechanism.\n throw err;\n }\n });\n}\n", "/* tslint:disable:no-empty */\nexport function noop() { }\n", "import { CompleteNotification, NextNotification, ErrorNotification } from './types';\n\n/**\n * A completion object optimized for memory use and created to be the\n * same \"shape\" as other notifications in v8.\n * @internal\n */\nexport const COMPLETE_NOTIFICATION = (() => createNotification('C', undefined, undefined) as CompleteNotification)();\n\n/**\n * Internal use only. Creates an optimized error notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function errorNotification(error: any): ErrorNotification {\n return createNotification('E', undefined, error) as any;\n}\n\n/**\n * Internal use only. Creates an optimized next notification that is the same \"shape\"\n * as other notifications.\n * @internal\n */\nexport function nextNotification(value: T) {\n return createNotification('N', value, undefined) as NextNotification;\n}\n\n/**\n * Ensures that all notifications created internally have the same \"shape\" in v8.\n *\n * TODO: This is only exported to support a crazy legacy test in `groupBy`.\n * @internal\n */\nexport function createNotification(kind: 'N' | 'E' | 'C', value: any, error: any) {\n return {\n kind,\n value,\n error,\n };\n}\n", "import { config } from '../config';\n\nlet context: { errorThrown: boolean; error: any } | null = null;\n\n/**\n * Handles dealing with errors for super-gross mode. Creates a context, in which\n * any synchronously thrown errors will be passed to {@link captureError}. Which\n * will record the error such that it will be rethrown after the call back is complete.\n * TODO: Remove in v8\n * @param cb An immediately executed function.\n */\nexport function errorContext(cb: () => void) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n const isRoot = !context;\n if (isRoot) {\n context = { errorThrown: false, error: null };\n }\n cb();\n if (isRoot) {\n const { errorThrown, error } = context!;\n context = null;\n if (errorThrown) {\n throw error;\n }\n }\n } else {\n // This is the general non-deprecated path for everyone that\n // isn't crazy enough to use super-gross mode (useDeprecatedSynchronousErrorHandling)\n cb();\n }\n}\n\n/**\n * Captures errors only in super-gross mode.\n * @param err the error to capture\n */\nexport function captureError(err: any) {\n if (config.useDeprecatedSynchronousErrorHandling && context) {\n context.errorThrown = true;\n context.error = err;\n }\n}\n", "import { isFunction } from './util/isFunction';\nimport { Observer, ObservableNotification } from './types';\nimport { isSubscription, Subscription } from './Subscription';\nimport { config } from './config';\nimport { reportUnhandledError } from './util/reportUnhandledError';\nimport { noop } from './util/noop';\nimport { nextNotification, errorNotification, COMPLETE_NOTIFICATION } from './NotificationFactories';\nimport { timeoutProvider } from './scheduler/timeoutProvider';\nimport { captureError } from './util/errorContext';\n\n/**\n * Implements the {@link Observer} interface and extends the\n * {@link Subscription} class. While the {@link Observer} is the public API for\n * consuming the values of an {@link Observable}, all Observers get converted to\n * a Subscriber, in order to provide Subscription-like capabilities such as\n * `unsubscribe`. Subscriber is a common type in RxJS, and crucial for\n * implementing operators, but it is rarely used as a public API.\n *\n * @class Subscriber\n */\nexport class Subscriber extends Subscription implements Observer {\n /**\n * A static factory for a Subscriber, given a (potentially partial) definition\n * of an Observer.\n * @param next The `next` callback of an Observer.\n * @param error The `error` callback of an\n * Observer.\n * @param complete The `complete` callback of an\n * Observer.\n * @return A Subscriber wrapping the (partially defined)\n * Observer represented by the given arguments.\n * @nocollapse\n * @deprecated Do not use. Will be removed in v8. There is no replacement for this\n * method, and there is no reason to be creating instances of `Subscriber` directly.\n * If you have a specific use case, please file an issue.\n */\n static create(next?: (x?: T) => void, error?: (e?: any) => void, complete?: () => void): Subscriber {\n return new SafeSubscriber(next, error, complete);\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected isStopped: boolean = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n protected destination: Subscriber | Observer; // this `any` is the escape hatch to erase extra type param (e.g. R)\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * There is no reason to directly create an instance of Subscriber. This type is exported for typings reasons.\n */\n constructor(destination?: Subscriber | Observer) {\n super();\n if (destination) {\n this.destination = destination;\n // Automatically chain subscriptions together here.\n // if destination is a Subscription, then it is a Subscriber.\n if (isSubscription(destination)) {\n destination.add(this);\n }\n } else {\n this.destination = EMPTY_OBSERVER;\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `next` from\n * the Observable, with a value. The Observable may call this method 0 or more\n * times.\n * @param {T} [value] The `next` value.\n * @return {void}\n */\n next(value?: T): void {\n if (this.isStopped) {\n handleStoppedNotification(nextNotification(value), this);\n } else {\n this._next(value!);\n }\n }\n\n /**\n * The {@link Observer} callback to receive notifications of type `error` from\n * the Observable, with an attached `Error`. Notifies the Observer that\n * the Observable has experienced an error condition.\n * @param {any} [err] The `error` exception.\n * @return {void}\n */\n error(err?: any): void {\n if (this.isStopped) {\n handleStoppedNotification(errorNotification(err), this);\n } else {\n this.isStopped = true;\n this._error(err);\n }\n }\n\n /**\n * The {@link Observer} callback to receive a valueless notification of type\n * `complete` from the Observable. Notifies the Observer that the Observable\n * has finished sending push-based notifications.\n * @return {void}\n */\n complete(): void {\n if (this.isStopped) {\n handleStoppedNotification(COMPLETE_NOTIFICATION, this);\n } else {\n this.isStopped = true;\n this._complete();\n }\n }\n\n unsubscribe(): void {\n if (!this.closed) {\n this.isStopped = true;\n super.unsubscribe();\n this.destination = null!;\n }\n }\n\n protected _next(value: T): void {\n this.destination.next(value);\n }\n\n protected _error(err: any): void {\n try {\n this.destination.error(err);\n } finally {\n this.unsubscribe();\n }\n }\n\n protected _complete(): void {\n try {\n this.destination.complete();\n } finally {\n this.unsubscribe();\n }\n }\n}\n\n/**\n * This bind is captured here because we want to be able to have\n * compatibility with monoid libraries that tend to use a method named\n * `bind`. In particular, a library called Monio requires this.\n */\nconst _bind = Function.prototype.bind;\n\nfunction bind any>(fn: Fn, thisArg: any): Fn {\n return _bind.call(fn, thisArg);\n}\n\n/**\n * Internal optimization only, DO NOT EXPOSE.\n * @internal\n */\nclass ConsumerObserver implements Observer {\n constructor(private partialObserver: Partial>) {}\n\n next(value: T): void {\n const { partialObserver } = this;\n if (partialObserver.next) {\n try {\n partialObserver.next(value);\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n\n error(err: any): void {\n const { partialObserver } = this;\n if (partialObserver.error) {\n try {\n partialObserver.error(err);\n } catch (error) {\n handleUnhandledError(error);\n }\n } else {\n handleUnhandledError(err);\n }\n }\n\n complete(): void {\n const { partialObserver } = this;\n if (partialObserver.complete) {\n try {\n partialObserver.complete();\n } catch (error) {\n handleUnhandledError(error);\n }\n }\n }\n}\n\nexport class SafeSubscriber extends Subscriber {\n constructor(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((e?: any) => void) | null,\n complete?: (() => void) | null\n ) {\n super();\n\n let partialObserver: Partial>;\n if (isFunction(observerOrNext) || !observerOrNext) {\n // The first argument is a function, not an observer. The next\n // two arguments *could* be observers, or they could be empty.\n partialObserver = {\n next: (observerOrNext ?? undefined) as (((value: T) => void) | undefined),\n error: error ?? undefined,\n complete: complete ?? undefined,\n };\n } else {\n // The first argument is a partial observer.\n let context: any;\n if (this && config.useDeprecatedNextContext) {\n // This is a deprecated path that made `this.unsubscribe()` available in\n // next handler functions passed to subscribe. This only exists behind a flag\n // now, as it is *very* slow.\n context = Object.create(observerOrNext);\n context.unsubscribe = () => this.unsubscribe();\n partialObserver = {\n next: observerOrNext.next && bind(observerOrNext.next, context),\n error: observerOrNext.error && bind(observerOrNext.error, context),\n complete: observerOrNext.complete && bind(observerOrNext.complete, context),\n };\n } else {\n // The \"normal\" path. Just use the partial observer directly.\n partialObserver = observerOrNext;\n }\n }\n\n // Wrap the partial observer to ensure it's a full observer, and\n // make sure proper error handling is accounted for.\n this.destination = new ConsumerObserver(partialObserver);\n }\n}\n\nfunction handleUnhandledError(error: any) {\n if (config.useDeprecatedSynchronousErrorHandling) {\n captureError(error);\n } else {\n // Ideal path, we report this as an unhandled error,\n // which is thrown on a new call stack.\n reportUnhandledError(error);\n }\n}\n\n/**\n * An error handler used when no error handler was supplied\n * to the SafeSubscriber -- meaning no error handler was supplied\n * do the `subscribe` call on our observable.\n * @param err The error to handle\n */\nfunction defaultErrorHandler(err: any) {\n throw err;\n}\n\n/**\n * A handler for notifications that cannot be sent to a stopped subscriber.\n * @param notification The notification being sent\n * @param subscriber The stopped subscriber\n */\nfunction handleStoppedNotification(notification: ObservableNotification, subscriber: Subscriber) {\n const { onStoppedNotification } = config;\n onStoppedNotification && timeoutProvider.setTimeout(() => onStoppedNotification(notification, subscriber));\n}\n\n/**\n * The observer used as a stub for subscriptions where the user did not\n * pass any arguments to `subscribe`. Comes with the default error handling\n * behavior.\n */\nexport const EMPTY_OBSERVER: Readonly> & { closed: true } = {\n closed: true,\n next: noop,\n error: defaultErrorHandler,\n complete: noop,\n};\n", "/**\n * Symbol.observable or a string \"@@observable\". Used for interop\n *\n * @deprecated We will no longer be exporting this symbol in upcoming versions of RxJS.\n * Instead polyfill and use Symbol.observable directly *or* use https://www.npmjs.com/package/symbol-observable\n */\nexport const observable: string | symbol = (() => (typeof Symbol === 'function' && Symbol.observable) || '@@observable')();\n", "/**\n * This function takes one parameter and just returns it. Simply put,\n * this is like `(x: T): T => x`.\n *\n * ## Examples\n *\n * This is useful in some cases when using things like `mergeMap`\n *\n * ```ts\n * import { interval, take, map, range, mergeMap, identity } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(5));\n *\n * const result$ = source$.pipe(\n * map(i => range(i)),\n * mergeMap(identity) // same as mergeMap(x => x)\n * );\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * Or when you want to selectively apply an operator\n *\n * ```ts\n * import { interval, take, identity } from 'rxjs';\n *\n * const shouldLimit = () => Math.random() < 0.5;\n *\n * const source$ = interval(1000);\n *\n * const result$ = source$.pipe(shouldLimit() ? take(5) : identity);\n *\n * result$.subscribe({\n * next: console.log\n * });\n * ```\n *\n * @param x Any value that is returned by this function\n * @returns The value passed as the first parameter to this function\n */\nexport function identity(x: T): T {\n return x;\n}\n", "import { identity } from './identity';\nimport { UnaryFunction } from '../types';\n\nexport function pipe(): typeof identity;\nexport function pipe(fn1: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction): UnaryFunction;\nexport function pipe(fn1: UnaryFunction, fn2: UnaryFunction, fn3: UnaryFunction): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction\n): UnaryFunction;\nexport function pipe(\n fn1: UnaryFunction,\n fn2: UnaryFunction,\n fn3: UnaryFunction,\n fn4: UnaryFunction,\n fn5: UnaryFunction,\n fn6: UnaryFunction,\n fn7: UnaryFunction,\n fn8: UnaryFunction,\n fn9: UnaryFunction,\n ...fns: UnaryFunction[]\n): UnaryFunction;\n\n/**\n * pipe() can be called on one or more functions, each of which can take one argument (\"UnaryFunction\")\n * and uses it to return a value.\n * It returns a function that takes one argument, passes it to the first UnaryFunction, and then\n * passes the result to the next one, passes that result to the next one, and so on. \n */\nexport function pipe(...fns: Array>): UnaryFunction {\n return pipeFromArray(fns);\n}\n\n/** @internal */\nexport function pipeFromArray(fns: Array>): UnaryFunction {\n if (fns.length === 0) {\n return identity as UnaryFunction;\n }\n\n if (fns.length === 1) {\n return fns[0];\n }\n\n return function piped(input: T): R {\n return fns.reduce((prev: any, fn: UnaryFunction) => fn(prev), input as any);\n };\n}\n", "import { Operator } from './Operator';\nimport { SafeSubscriber, Subscriber } from './Subscriber';\nimport { isSubscription, Subscription } from './Subscription';\nimport { TeardownLogic, OperatorFunction, Subscribable, Observer } from './types';\nimport { observable as Symbol_observable } from './symbol/observable';\nimport { pipeFromArray } from './util/pipe';\nimport { config } from './config';\nimport { isFunction } from './util/isFunction';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A representation of any set of values over any amount of time. This is the most basic building block\n * of RxJS.\n *\n * @class Observable\n */\nexport class Observable implements Subscribable {\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n source: Observable | undefined;\n\n /**\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n */\n operator: Operator | undefined;\n\n /**\n * @constructor\n * @param {Function} subscribe the function that is called when the Observable is\n * initially subscribed to. This function is given a Subscriber, to which new values\n * can be `next`ed, or an `error` method can be called to raise an error, or\n * `complete` can be called to notify of a successful completion.\n */\n constructor(subscribe?: (this: Observable, subscriber: Subscriber) => TeardownLogic) {\n if (subscribe) {\n this._subscribe = subscribe;\n }\n }\n\n // HACK: Since TypeScript inherits static properties too, we have to\n // fight against TypeScript here so Subject can have a different static create signature\n /**\n * Creates a new Observable by calling the Observable constructor\n * @owner Observable\n * @method create\n * @param {Function} subscribe? the subscriber function to be passed to the Observable constructor\n * @return {Observable} a new observable\n * @nocollapse\n * @deprecated Use `new Observable()` instead. Will be removed in v8.\n */\n static create: (...args: any[]) => any = (subscribe?: (subscriber: Subscriber) => TeardownLogic) => {\n return new Observable(subscribe);\n };\n\n /**\n * Creates a new Observable, with this Observable instance as the source, and the passed\n * operator defined as the new observable's operator.\n * @method lift\n * @param operator the operator defining the operation to take on the observable\n * @return a new observable with the Operator applied\n * @deprecated Internal implementation detail, do not use directly. Will be made internal in v8.\n * If you have implemented an operator using `lift`, it is recommended that you create an\n * operator by simply returning `new Observable()` directly. See \"Creating new operators from\n * scratch\" section here: https://rxjs.dev/guide/operators\n */\n lift(operator?: Operator): Observable {\n const observable = new Observable();\n observable.source = this;\n observable.operator = operator;\n return observable;\n }\n\n subscribe(observerOrNext?: Partial> | ((value: T) => void)): Subscription;\n /** @deprecated Instead of passing separate callback arguments, use an observer argument. Signatures taking separate callback arguments will be removed in v8. Details: https://rxjs.dev/deprecations/subscribe-arguments */\n subscribe(next?: ((value: T) => void) | null, error?: ((error: any) => void) | null, complete?: (() => void) | null): Subscription;\n /**\n * Invokes an execution of an Observable and registers Observer handlers for notifications it will emit.\n *\n * Use it when you have all these Observables, but still nothing is happening.\n *\n * `subscribe` is not a regular operator, but a method that calls Observable's internal `subscribe` function. It\n * might be for example a function that you passed to Observable's constructor, but most of the time it is\n * a library implementation, which defines what will be emitted by an Observable, and when it be will emitted. This means\n * that calling `subscribe` is actually the moment when Observable starts its work, not when it is created, as it is often\n * the thought.\n *\n * Apart from starting the execution of an Observable, this method allows you to listen for values\n * that an Observable emits, as well as for when it completes or errors. You can achieve this in two\n * of the following ways.\n *\n * The first way is creating an object that implements {@link Observer} interface. It should have methods\n * defined by that interface, but note that it should be just a regular JavaScript object, which you can create\n * yourself in any way you want (ES6 class, classic function constructor, object literal etc.). In particular, do\n * not attempt to use any RxJS implementation details to create Observers - you don't need them. Remember also\n * that your object does not have to implement all methods. If you find yourself creating a method that doesn't\n * do anything, you can simply omit it. Note however, if the `error` method is not provided and an error happens,\n * it will be thrown asynchronously. Errors thrown asynchronously cannot be caught using `try`/`catch`. Instead,\n * use the {@link onUnhandledError} configuration option or use a runtime handler (like `window.onerror` or\n * `process.on('error)`) to be notified of unhandled errors. Because of this, it's recommended that you provide\n * an `error` method to avoid missing thrown errors.\n *\n * The second way is to give up on Observer object altogether and simply provide callback functions in place of its methods.\n * This means you can provide three functions as arguments to `subscribe`, where the first function is equivalent\n * of a `next` method, the second of an `error` method and the third of a `complete` method. Just as in case of an Observer,\n * if you do not need to listen for something, you can omit a function by passing `undefined` or `null`,\n * since `subscribe` recognizes these functions by where they were placed in function call. When it comes\n * to the `error` function, as with an Observer, if not provided, errors emitted by an Observable will be thrown asynchronously.\n *\n * You can, however, subscribe with no parameters at all. This may be the case where you're not interested in terminal events\n * and you also handled emissions internally by using operators (e.g. using `tap`).\n *\n * Whichever style of calling `subscribe` you use, in both cases it returns a Subscription object.\n * This object allows you to call `unsubscribe` on it, which in turn will stop the work that an Observable does and will clean\n * up all resources that an Observable used. Note that cancelling a subscription will not call `complete` callback\n * provided to `subscribe` function, which is reserved for a regular completion signal that comes from an Observable.\n *\n * Remember that callbacks provided to `subscribe` are not guaranteed to be called asynchronously.\n * It is an Observable itself that decides when these functions will be called. For example {@link of}\n * by default emits all its values synchronously. Always check documentation for how given Observable\n * will behave when subscribed and if its default behavior can be modified with a `scheduler`.\n *\n * #### Examples\n *\n * Subscribe with an {@link guide/observer Observer}\n *\n * ```ts\n * import { of } from 'rxjs';\n *\n * const sumObserver = {\n * sum: 0,\n * next(value) {\n * console.log('Adding: ' + value);\n * this.sum = this.sum + value;\n * },\n * error() {\n * // We actually could just remove this method,\n * // since we do not really care about errors right now.\n * },\n * complete() {\n * console.log('Sum equals: ' + this.sum);\n * }\n * };\n *\n * of(1, 2, 3) // Synchronously emits 1, 2, 3 and then completes.\n * .subscribe(sumObserver);\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Subscribe with functions ({@link deprecations/subscribe-arguments deprecated})\n *\n * ```ts\n * import { of } from 'rxjs'\n *\n * let sum = 0;\n *\n * of(1, 2, 3).subscribe(\n * value => {\n * console.log('Adding: ' + value);\n * sum = sum + value;\n * },\n * undefined,\n * () => console.log('Sum equals: ' + sum)\n * );\n *\n * // Logs:\n * // 'Adding: 1'\n * // 'Adding: 2'\n * // 'Adding: 3'\n * // 'Sum equals: 6'\n * ```\n *\n * Cancel a subscription\n *\n * ```ts\n * import { interval } from 'rxjs';\n *\n * const subscription = interval(1000).subscribe({\n * next(num) {\n * console.log(num)\n * },\n * complete() {\n * // Will not be called, even when cancelling subscription.\n * console.log('completed!');\n * }\n * });\n *\n * setTimeout(() => {\n * subscription.unsubscribe();\n * console.log('unsubscribed!');\n * }, 2500);\n *\n * // Logs:\n * // 0 after 1s\n * // 1 after 2s\n * // 'unsubscribed!' after 2.5s\n * ```\n *\n * @param {Observer|Function} observerOrNext (optional) Either an observer with methods to be called,\n * or the first of three possible handlers, which is the handler for each value emitted from the subscribed\n * Observable.\n * @param {Function} error (optional) A handler for a terminal event resulting from an error. If no error handler is provided,\n * the error will be thrown asynchronously as unhandled.\n * @param {Function} complete (optional) A handler for a terminal event resulting from successful completion.\n * @return {Subscription} a subscription reference to the registered handlers\n * @method subscribe\n */\n subscribe(\n observerOrNext?: Partial> | ((value: T) => void) | null,\n error?: ((error: any) => void) | null,\n complete?: (() => void) | null\n ): Subscription {\n const subscriber = isSubscriber(observerOrNext) ? observerOrNext : new SafeSubscriber(observerOrNext, error, complete);\n\n errorContext(() => {\n const { operator, source } = this;\n subscriber.add(\n operator\n ? // We're dealing with a subscription in the\n // operator chain to one of our lifted operators.\n operator.call(subscriber, source)\n : source\n ? // If `source` has a value, but `operator` does not, something that\n // had intimate knowledge of our API, like our `Subject`, must have\n // set it. We're going to just call `_subscribe` directly.\n this._subscribe(subscriber)\n : // In all other cases, we're likely wrapping a user-provided initializer\n // function, so we need to catch errors and handle them appropriately.\n this._trySubscribe(subscriber)\n );\n });\n\n return subscriber;\n }\n\n /** @internal */\n protected _trySubscribe(sink: Subscriber): TeardownLogic {\n try {\n return this._subscribe(sink);\n } catch (err) {\n // We don't need to return anything in this case,\n // because it's just going to try to `add()` to a subscription\n // above.\n sink.error(err);\n }\n }\n\n /**\n * Used as a NON-CANCELLABLE means of subscribing to an observable, for use with\n * APIs that expect promises, like `async/await`. You cannot unsubscribe from this.\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * #### Example\n *\n * ```ts\n * import { interval, take } from 'rxjs';\n *\n * const source$ = interval(1000).pipe(take(4));\n *\n * async function getTotal() {\n * let total = 0;\n *\n * await source$.forEach(value => {\n * total += value;\n * console.log('observable -> ' + value);\n * });\n *\n * return total;\n * }\n *\n * getTotal().then(\n * total => console.log('Total: ' + total)\n * );\n *\n * // Expected:\n * // 'observable -> 0'\n * // 'observable -> 1'\n * // 'observable -> 2'\n * // 'observable -> 3'\n * // 'Total: 6'\n * ```\n *\n * @param next a handler for each value emitted by the observable\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n */\n forEach(next: (value: T) => void): Promise;\n\n /**\n * @param next a handler for each value emitted by the observable\n * @param promiseCtor a constructor function used to instantiate the Promise\n * @return a promise that either resolves on observable completion or\n * rejects with the handled error\n * @deprecated Passing a Promise constructor will no longer be available\n * in upcoming versions of RxJS. This is because it adds weight to the library, for very\n * little benefit. If you need this functionality, it is recommended that you either\n * polyfill Promise, or you create an adapter to convert the returned native promise\n * to whatever promise implementation you wanted. Will be removed in v8.\n */\n forEach(next: (value: T) => void, promiseCtor: PromiseConstructorLike): Promise;\n\n forEach(next: (value: T) => void, promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n const subscriber = new SafeSubscriber({\n next: (value) => {\n try {\n next(value);\n } catch (err) {\n reject(err);\n subscriber.unsubscribe();\n }\n },\n error: reject,\n complete: resolve,\n });\n this.subscribe(subscriber);\n }) as Promise;\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): TeardownLogic {\n return this.source?.subscribe(subscriber);\n }\n\n /**\n * An interop point defined by the es7-observable spec https://github.com/zenparsing/es-observable\n * @method Symbol.observable\n * @return {Observable} this instance of the observable\n */\n [Symbol_observable]() {\n return this;\n }\n\n /* tslint:disable:max-line-length */\n pipe(): Observable;\n pipe(op1: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction): Observable;\n pipe(op1: OperatorFunction, op2: OperatorFunction, op3: OperatorFunction): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction\n ): Observable;\n pipe(\n op1: OperatorFunction,\n op2: OperatorFunction,\n op3: OperatorFunction,\n op4: OperatorFunction,\n op5: OperatorFunction,\n op6: OperatorFunction,\n op7: OperatorFunction,\n op8: OperatorFunction,\n op9: OperatorFunction,\n ...operations: OperatorFunction[]\n ): Observable;\n /* tslint:enable:max-line-length */\n\n /**\n * Used to stitch together functional operators into a chain.\n * @method pipe\n * @return {Observable} the Observable result of all of the operators having\n * been called in the order they were passed in.\n *\n * ## Example\n *\n * ```ts\n * import { interval, filter, map, scan } from 'rxjs';\n *\n * interval(1000)\n * .pipe(\n * filter(x => x % 2 === 0),\n * map(x => x + x),\n * scan((acc, x) => acc + x)\n * )\n * .subscribe(x => console.log(x));\n * ```\n */\n pipe(...operations: OperatorFunction[]): Observable {\n return pipeFromArray(operations)(this);\n }\n\n /* tslint:disable:max-line-length */\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: typeof Promise): Promise;\n /** @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise */\n toPromise(PromiseCtor: PromiseConstructorLike): Promise;\n /* tslint:enable:max-line-length */\n\n /**\n * Subscribe to this Observable and get a Promise resolving on\n * `complete` with the last emission (if any).\n *\n * **WARNING**: Only use this with observables you *know* will complete. If the source\n * observable does not complete, you will end up with a promise that is hung up, and\n * potentially all of the state of an async function hanging out in memory. To avoid\n * this situation, look into adding something like {@link timeout}, {@link take},\n * {@link takeWhile}, or {@link takeUntil} amongst others.\n *\n * @method toPromise\n * @param [promiseCtor] a constructor function used to instantiate\n * the Promise\n * @return A Promise that resolves with the last value emit, or\n * rejects on an error. If there were no emissions, Promise\n * resolves with undefined.\n * @deprecated Replaced with {@link firstValueFrom} and {@link lastValueFrom}. Will be removed in v8. Details: https://rxjs.dev/deprecations/to-promise\n */\n toPromise(promiseCtor?: PromiseConstructorLike): Promise {\n promiseCtor = getPromiseCtor(promiseCtor);\n\n return new promiseCtor((resolve, reject) => {\n let value: T | undefined;\n this.subscribe(\n (x: T) => (value = x),\n (err: any) => reject(err),\n () => resolve(value)\n );\n }) as Promise;\n }\n}\n\n/**\n * Decides between a passed promise constructor from consuming code,\n * A default configured promise constructor, and the native promise\n * constructor and returns it. If nothing can be found, it will throw\n * an error.\n * @param promiseCtor The optional promise constructor to passed by consuming code\n */\nfunction getPromiseCtor(promiseCtor: PromiseConstructorLike | undefined) {\n return promiseCtor ?? config.Promise ?? Promise;\n}\n\nfunction isObserver(value: any): value is Observer {\n return value && isFunction(value.next) && isFunction(value.error) && isFunction(value.complete);\n}\n\nfunction isSubscriber(value: any): value is Subscriber {\n return (value && value instanceof Subscriber) || (isObserver(value) && isSubscription(value));\n}\n", "import { Observable } from '../Observable';\nimport { Subscriber } from '../Subscriber';\nimport { OperatorFunction } from '../types';\nimport { isFunction } from './isFunction';\n\n/**\n * Used to determine if an object is an Observable with a lift function.\n */\nexport function hasLift(source: any): source is { lift: InstanceType['lift'] } {\n return isFunction(source?.lift);\n}\n\n/**\n * Creates an `OperatorFunction`. Used to define operators throughout the library in a concise way.\n * @param init The logic to connect the liftedSource to the subscriber at the moment of subscription.\n */\nexport function operate(\n init: (liftedSource: Observable, subscriber: Subscriber) => (() => void) | void\n): OperatorFunction {\n return (source: Observable) => {\n if (hasLift(source)) {\n return source.lift(function (this: Subscriber, liftedSource: Observable) {\n try {\n return init(liftedSource, this);\n } catch (err) {\n this.error(err);\n }\n });\n }\n throw new TypeError('Unable to lift unknown Observable type');\n };\n}\n", "import { Subscriber } from '../Subscriber';\n\n/**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional teardown logic here. This will only be called on teardown if the\n * subscriber itself is not already closed. This is called after all other teardown logic is executed.\n */\nexport function createOperatorSubscriber(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n onFinalize?: () => void\n): Subscriber {\n return new OperatorSubscriber(destination, onNext, onComplete, onError, onFinalize);\n}\n\n/**\n * A generic helper for allowing operators to be created with a Subscriber and\n * use closures to capture necessary state from the operator function itself.\n */\nexport class OperatorSubscriber extends Subscriber {\n /**\n * Creates an instance of an `OperatorSubscriber`.\n * @param destination The downstream subscriber.\n * @param onNext Handles next values, only called if this subscriber is not stopped or closed. Any\n * error that occurs in this function is caught and sent to the `error` method of this subscriber.\n * @param onError Handles errors from the subscription, any errors that occur in this handler are caught\n * and send to the `destination` error handler.\n * @param onComplete Handles completion notification from the subscription. Any errors that occur in\n * this handler are sent to the `destination` error handler.\n * @param onFinalize Additional finalization logic here. This will only be called on finalization if the\n * subscriber itself is not already closed. This is called after all other finalization logic is executed.\n * @param shouldUnsubscribe An optional check to see if an unsubscribe call should truly unsubscribe.\n * NOTE: This currently **ONLY** exists to support the strange behavior of {@link groupBy}, where unsubscription\n * to the resulting observable does not actually disconnect from the source if there are active subscriptions\n * to any grouped observable. (DO NOT EXPOSE OR USE EXTERNALLY!!!)\n */\n constructor(\n destination: Subscriber,\n onNext?: (value: T) => void,\n onComplete?: () => void,\n onError?: (err: any) => void,\n private onFinalize?: () => void,\n private shouldUnsubscribe?: () => boolean\n ) {\n // It's important - for performance reasons - that all of this class's\n // members are initialized and that they are always initialized in the same\n // order. This will ensure that all OperatorSubscriber instances have the\n // same hidden class in V8. This, in turn, will help keep the number of\n // hidden classes involved in property accesses within the base class as\n // low as possible. If the number of hidden classes involved exceeds four,\n // the property accesses will become megamorphic and performance penalties\n // will be incurred - i.e. inline caches won't be used.\n //\n // The reasons for ensuring all instances have the same hidden class are\n // further discussed in this blog post from Benedikt Meurer:\n // https://benediktmeurer.de/2018/03/23/impact-of-polymorphism-on-component-based-frameworks-like-react/\n super(destination);\n this._next = onNext\n ? function (this: OperatorSubscriber, value: T) {\n try {\n onNext(value);\n } catch (err) {\n destination.error(err);\n }\n }\n : super._next;\n this._error = onError\n ? function (this: OperatorSubscriber, err: any) {\n try {\n onError(err);\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._error;\n this._complete = onComplete\n ? function (this: OperatorSubscriber) {\n try {\n onComplete();\n } catch (err) {\n // Send any errors that occur down stream.\n destination.error(err);\n } finally {\n // Ensure finalization.\n this.unsubscribe();\n }\n }\n : super._complete;\n }\n\n unsubscribe() {\n if (!this.shouldUnsubscribe || this.shouldUnsubscribe()) {\n const { closed } = this;\n super.unsubscribe();\n // Execute additional teardown if we have any and we didn't already do so.\n !closed && this.onFinalize?.();\n }\n }\n}\n", "import { Subscription } from '../Subscription';\n\ninterface AnimationFrameProvider {\n schedule(callback: FrameRequestCallback): Subscription;\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n delegate:\n | {\n requestAnimationFrame: typeof requestAnimationFrame;\n cancelAnimationFrame: typeof cancelAnimationFrame;\n }\n | undefined;\n}\n\nexport const animationFrameProvider: AnimationFrameProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n schedule(callback) {\n let request = requestAnimationFrame;\n let cancel: typeof cancelAnimationFrame | undefined = cancelAnimationFrame;\n const { delegate } = animationFrameProvider;\n if (delegate) {\n request = delegate.requestAnimationFrame;\n cancel = delegate.cancelAnimationFrame;\n }\n const handle = request((timestamp) => {\n // Clear the cancel function. The request has been fulfilled, so\n // attempting to cancel the request upon unsubscription would be\n // pointless.\n cancel = undefined;\n callback(timestamp);\n });\n return new Subscription(() => cancel?.(handle));\n },\n requestAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.requestAnimationFrame || requestAnimationFrame)(...args);\n },\n cancelAnimationFrame(...args) {\n const { delegate } = animationFrameProvider;\n return (delegate?.cancelAnimationFrame || cancelAnimationFrame)(...args);\n },\n delegate: undefined,\n};\n", "import { createErrorClass } from './createErrorClass';\n\nexport interface ObjectUnsubscribedError extends Error {}\n\nexport interface ObjectUnsubscribedErrorCtor {\n /**\n * @deprecated Internal implementation detail. Do not construct error instances.\n * Cannot be tagged as internal: https://github.com/ReactiveX/rxjs/issues/6269\n */\n new (): ObjectUnsubscribedError;\n}\n\n/**\n * An error thrown when an action is invalid because the object has been\n * unsubscribed.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n *\n * @class ObjectUnsubscribedError\n */\nexport const ObjectUnsubscribedError: ObjectUnsubscribedErrorCtor = createErrorClass(\n (_super) =>\n function ObjectUnsubscribedErrorImpl(this: any) {\n _super(this);\n this.name = 'ObjectUnsubscribedError';\n this.message = 'object unsubscribed';\n }\n);\n", "import { Operator } from './Operator';\nimport { Observable } from './Observable';\nimport { Subscriber } from './Subscriber';\nimport { Subscription, EMPTY_SUBSCRIPTION } from './Subscription';\nimport { Observer, SubscriptionLike, TeardownLogic } from './types';\nimport { ObjectUnsubscribedError } from './util/ObjectUnsubscribedError';\nimport { arrRemove } from './util/arrRemove';\nimport { errorContext } from './util/errorContext';\n\n/**\n * A Subject is a special type of Observable that allows values to be\n * multicasted to many Observers. Subjects are like EventEmitters.\n *\n * Every Subject is an Observable and an Observer. You can subscribe to a\n * Subject, and you can call next to feed values as well as error and complete.\n */\nexport class Subject extends Observable implements SubscriptionLike {\n closed = false;\n\n private currentObservers: Observer[] | null = null;\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n observers: Observer[] = [];\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n isStopped = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n hasError = false;\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n thrownError: any = null;\n\n /**\n * Creates a \"subject\" by basically gluing an observer to an observable.\n *\n * @nocollapse\n * @deprecated Recommended you do not use. Will be removed at some point in the future. Plans for replacement still under discussion.\n */\n static create: (...args: any[]) => any = (destination: Observer, source: Observable): AnonymousSubject => {\n return new AnonymousSubject(destination, source);\n };\n\n constructor() {\n // NOTE: This must be here to obscure Observable's constructor.\n super();\n }\n\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n lift(operator: Operator): Observable {\n const subject = new AnonymousSubject(this, this);\n subject.operator = operator as any;\n return subject as any;\n }\n\n /** @internal */\n protected _throwIfClosed() {\n if (this.closed) {\n throw new ObjectUnsubscribedError();\n }\n }\n\n next(value: T) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n if (!this.currentObservers) {\n this.currentObservers = Array.from(this.observers);\n }\n for (const observer of this.currentObservers) {\n observer.next(value);\n }\n }\n });\n }\n\n error(err: any) {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.hasError = this.isStopped = true;\n this.thrownError = err;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.error(err);\n }\n }\n });\n }\n\n complete() {\n errorContext(() => {\n this._throwIfClosed();\n if (!this.isStopped) {\n this.isStopped = true;\n const { observers } = this;\n while (observers.length) {\n observers.shift()!.complete();\n }\n }\n });\n }\n\n unsubscribe() {\n this.isStopped = this.closed = true;\n this.observers = this.currentObservers = null!;\n }\n\n get observed() {\n return this.observers?.length > 0;\n }\n\n /** @internal */\n protected _trySubscribe(subscriber: Subscriber): TeardownLogic {\n this._throwIfClosed();\n return super._trySubscribe(subscriber);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._checkFinalizedStatuses(subscriber);\n return this._innerSubscribe(subscriber);\n }\n\n /** @internal */\n protected _innerSubscribe(subscriber: Subscriber) {\n const { hasError, isStopped, observers } = this;\n if (hasError || isStopped) {\n return EMPTY_SUBSCRIPTION;\n }\n this.currentObservers = null;\n observers.push(subscriber);\n return new Subscription(() => {\n this.currentObservers = null;\n arrRemove(observers, subscriber);\n });\n }\n\n /** @internal */\n protected _checkFinalizedStatuses(subscriber: Subscriber) {\n const { hasError, thrownError, isStopped } = this;\n if (hasError) {\n subscriber.error(thrownError);\n } else if (isStopped) {\n subscriber.complete();\n }\n }\n\n /**\n * Creates a new Observable with this Subject as the source. You can do this\n * to create custom Observer-side logic of the Subject and conceal it from\n * code that uses the Observable.\n * @return {Observable} Observable that the Subject casts to\n */\n asObservable(): Observable {\n const observable: any = new Observable();\n observable.source = this;\n return observable;\n }\n}\n\n/**\n * @class AnonymousSubject\n */\nexport class AnonymousSubject extends Subject {\n constructor(\n /** @deprecated Internal implementation detail, do not use directly. Will be made internal in v8. */\n public destination?: Observer,\n source?: Observable\n ) {\n super();\n this.source = source;\n }\n\n next(value: T) {\n this.destination?.next?.(value);\n }\n\n error(err: any) {\n this.destination?.error?.(err);\n }\n\n complete() {\n this.destination?.complete?.();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n return this.source?.subscribe(subscriber) ?? EMPTY_SUBSCRIPTION;\n }\n}\n", "import { Subject } from './Subject';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\n\n/**\n * A variant of Subject that requires an initial value and emits its current\n * value whenever it is subscribed to.\n *\n * @class BehaviorSubject\n */\nexport class BehaviorSubject extends Subject {\n constructor(private _value: T) {\n super();\n }\n\n get value(): T {\n return this.getValue();\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n const subscription = super._subscribe(subscriber);\n !subscription.closed && subscriber.next(this._value);\n return subscription;\n }\n\n getValue(): T {\n const { hasError, thrownError, _value } = this;\n if (hasError) {\n throw thrownError;\n }\n this._throwIfClosed();\n return _value;\n }\n\n next(value: T): void {\n super.next((this._value = value));\n }\n}\n", "import { TimestampProvider } from '../types';\n\ninterface DateTimestampProvider extends TimestampProvider {\n delegate: TimestampProvider | undefined;\n}\n\nexport const dateTimestampProvider: DateTimestampProvider = {\n now() {\n // Use the variable rather than `this` so that the function can be called\n // without being bound to the provider.\n return (dateTimestampProvider.delegate || Date).now();\n },\n delegate: undefined,\n};\n", "import { Subject } from './Subject';\nimport { TimestampProvider } from './types';\nimport { Subscriber } from './Subscriber';\nimport { Subscription } from './Subscription';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * A variant of {@link Subject} that \"replays\" old values to new subscribers by emitting them when they first subscribe.\n *\n * `ReplaySubject` has an internal buffer that will store a specified number of values that it has observed. Like `Subject`,\n * `ReplaySubject` \"observes\" values by having them passed to its `next` method. When it observes a value, it will store that\n * value for a time determined by the configuration of the `ReplaySubject`, as passed to its constructor.\n *\n * When a new subscriber subscribes to the `ReplaySubject` instance, it will synchronously emit all values in its buffer in\n * a First-In-First-Out (FIFO) manner. The `ReplaySubject` will also complete, if it has observed completion; and it will\n * error if it has observed an error.\n *\n * There are two main configuration items to be concerned with:\n *\n * 1. `bufferSize` - This will determine how many items are stored in the buffer, defaults to infinite.\n * 2. `windowTime` - The amount of time to hold a value in the buffer before removing it from the buffer.\n *\n * Both configurations may exist simultaneously. So if you would like to buffer a maximum of 3 values, as long as the values\n * are less than 2 seconds old, you could do so with a `new ReplaySubject(3, 2000)`.\n *\n * ### Differences with BehaviorSubject\n *\n * `BehaviorSubject` is similar to `new ReplaySubject(1)`, with a couple of exceptions:\n *\n * 1. `BehaviorSubject` comes \"primed\" with a single value upon construction.\n * 2. `ReplaySubject` will replay values, even after observing an error, where `BehaviorSubject` will not.\n *\n * @see {@link Subject}\n * @see {@link BehaviorSubject}\n * @see {@link shareReplay}\n */\nexport class ReplaySubject extends Subject {\n private _buffer: (T | number)[] = [];\n private _infiniteTimeWindow = true;\n\n /**\n * @param bufferSize The size of the buffer to replay on subscription\n * @param windowTime The amount of time the buffered items will stay buffered\n * @param timestampProvider An object with a `now()` method that provides the current timestamp. This is used to\n * calculate the amount of time something has been buffered.\n */\n constructor(\n private _bufferSize = Infinity,\n private _windowTime = Infinity,\n private _timestampProvider: TimestampProvider = dateTimestampProvider\n ) {\n super();\n this._infiniteTimeWindow = _windowTime === Infinity;\n this._bufferSize = Math.max(1, _bufferSize);\n this._windowTime = Math.max(1, _windowTime);\n }\n\n next(value: T): void {\n const { isStopped, _buffer, _infiniteTimeWindow, _timestampProvider, _windowTime } = this;\n if (!isStopped) {\n _buffer.push(value);\n !_infiniteTimeWindow && _buffer.push(_timestampProvider.now() + _windowTime);\n }\n this._trimBuffer();\n super.next(value);\n }\n\n /** @internal */\n protected _subscribe(subscriber: Subscriber): Subscription {\n this._throwIfClosed();\n this._trimBuffer();\n\n const subscription = this._innerSubscribe(subscriber);\n\n const { _infiniteTimeWindow, _buffer } = this;\n // We use a copy here, so reentrant code does not mutate our array while we're\n // emitting it to a new subscriber.\n const copy = _buffer.slice();\n for (let i = 0; i < copy.length && !subscriber.closed; i += _infiniteTimeWindow ? 1 : 2) {\n subscriber.next(copy[i] as T);\n }\n\n this._checkFinalizedStatuses(subscriber);\n\n return subscription;\n }\n\n private _trimBuffer() {\n const { _bufferSize, _timestampProvider, _buffer, _infiniteTimeWindow } = this;\n // If we don't have an infinite buffer size, and we're over the length,\n // use splice to truncate the old buffer values off. Note that we have to\n // double the size for instances where we're not using an infinite time window\n // because we're storing the values and the timestamps in the same array.\n const adjustedBufferSize = (_infiniteTimeWindow ? 1 : 2) * _bufferSize;\n _bufferSize < Infinity && adjustedBufferSize < _buffer.length && _buffer.splice(0, _buffer.length - adjustedBufferSize);\n\n // Now, if we're not in an infinite time window, remove all values where the time is\n // older than what is allowed.\n if (!_infiniteTimeWindow) {\n const now = _timestampProvider.now();\n let last = 0;\n // Search the array for the first timestamp that isn't expired and\n // truncate the buffer up to that point.\n for (let i = 1; i < _buffer.length && (_buffer[i] as number) <= now; i += 2) {\n last = i;\n }\n last && _buffer.splice(0, last + 1);\n }\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Subscription } from '../Subscription';\nimport { SchedulerAction } from '../types';\n\n/**\n * A unit of work to be executed in a `scheduler`. An action is typically\n * created from within a {@link SchedulerLike} and an RxJS user does not need to concern\n * themselves about creating and manipulating an Action.\n *\n * ```ts\n * class Action extends Subscription {\n * new (scheduler: Scheduler, work: (state?: T) => void);\n * schedule(state?: T, delay: number = 0): Subscription;\n * }\n * ```\n *\n * @class Action\n */\nexport class Action extends Subscription {\n constructor(scheduler: Scheduler, work: (this: SchedulerAction, state?: T) => void) {\n super();\n }\n /**\n * Schedules this action on its parent {@link SchedulerLike} for execution. May be passed\n * some context object, `state`. May happen at some point in the future,\n * according to the `delay` parameter, if specified.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler.\n * @return {void}\n */\n public schedule(state?: T, delay: number = 0): Subscription {\n return this;\n }\n}\n", "import type { TimerHandle } from './timerHandle';\ntype SetIntervalFunction = (handler: () => void, timeout?: number, ...args: any[]) => TimerHandle;\ntype ClearIntervalFunction = (handle: TimerHandle) => void;\n\ninterface IntervalProvider {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n delegate:\n | {\n setInterval: SetIntervalFunction;\n clearInterval: ClearIntervalFunction;\n }\n | undefined;\n}\n\nexport const intervalProvider: IntervalProvider = {\n // When accessing the delegate, use the variable rather than `this` so that\n // the functions can be called without being bound to the provider.\n setInterval(handler: () => void, timeout?: number, ...args) {\n const { delegate } = intervalProvider;\n if (delegate?.setInterval) {\n return delegate.setInterval(handler, timeout, ...args);\n }\n return setInterval(handler, timeout, ...args);\n },\n clearInterval(handle) {\n const { delegate } = intervalProvider;\n return (delegate?.clearInterval || clearInterval)(handle as any);\n },\n delegate: undefined,\n};\n", "import { Action } from './Action';\nimport { SchedulerAction } from '../types';\nimport { Subscription } from '../Subscription';\nimport { AsyncScheduler } from './AsyncScheduler';\nimport { intervalProvider } from './intervalProvider';\nimport { arrRemove } from '../util/arrRemove';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncAction extends Action {\n public id: TimerHandle | undefined;\n public state?: T;\n // @ts-ignore: Property has no initializer and is not definitely assigned\n public delay: number;\n protected pending: boolean = false;\n\n constructor(protected scheduler: AsyncScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (this.closed) {\n return this;\n }\n\n // Always replace the current state with the new state.\n this.state = state;\n\n const id = this.id;\n const scheduler = this.scheduler;\n\n //\n // Important implementation note:\n //\n // Actions only execute once by default, unless rescheduled from within the\n // scheduled callback. This allows us to implement single and repeat\n // actions via the same code path, without adding API surface area, as well\n // as mimic traditional recursion but across asynchronous boundaries.\n //\n // However, JS runtimes and timers distinguish between intervals achieved by\n // serial `setTimeout` calls vs. a single `setInterval` call. An interval of\n // serial `setTimeout` calls can be individually delayed, which delays\n // scheduling the next `setTimeout`, and so on. `setInterval` attempts to\n // guarantee the interval callback will be invoked more precisely to the\n // interval period, regardless of load.\n //\n // Therefore, we use `setInterval` to schedule single and repeat actions.\n // If the action reschedules itself with the same delay, the interval is not\n // canceled. If the action doesn't reschedule, or reschedules with a\n // different delay, the interval will be canceled after scheduled callback\n // execution.\n //\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, delay);\n }\n\n // Set the pending flag indicating that this action has been scheduled, or\n // has recursively rescheduled itself.\n this.pending = true;\n\n this.delay = delay;\n // If this action has already an async Id, don't request a new one.\n this.id = this.id ?? this.requestAsyncId(scheduler, this.id, delay);\n\n return this;\n }\n\n protected requestAsyncId(scheduler: AsyncScheduler, _id?: TimerHandle, delay: number = 0): TimerHandle {\n return intervalProvider.setInterval(scheduler.flush.bind(scheduler, this), delay);\n }\n\n protected recycleAsyncId(_scheduler: AsyncScheduler, id?: TimerHandle, delay: number | null = 0): TimerHandle | undefined {\n // If this action is rescheduled with the same delay time, don't clear the interval id.\n if (delay != null && this.delay === delay && this.pending === false) {\n return id;\n }\n // Otherwise, if the action's delay time is different from the current delay,\n // or the action has been rescheduled before it's executed, clear the interval id\n if (id != null) {\n intervalProvider.clearInterval(id);\n }\n\n return undefined;\n }\n\n /**\n * Immediately executes this action and the `work` it contains.\n * @return {any}\n */\n public execute(state: T, delay: number): any {\n if (this.closed) {\n return new Error('executing a cancelled action');\n }\n\n this.pending = false;\n const error = this._execute(state, delay);\n if (error) {\n return error;\n } else if (this.pending === false && this.id != null) {\n // Dequeue if the action didn't reschedule itself. Don't call\n // unsubscribe(), because the action could reschedule later.\n // For example:\n // ```\n // scheduler.schedule(function doWork(counter) {\n // /* ... I'm a busy worker bee ... */\n // var originalAction = this;\n // /* wait 100ms before rescheduling the action */\n // setTimeout(function () {\n // originalAction.schedule(counter + 1);\n // }, 100);\n // }, 1000);\n // ```\n this.id = this.recycleAsyncId(this.scheduler, this.id, null);\n }\n }\n\n protected _execute(state: T, _delay: number): any {\n let errored: boolean = false;\n let errorValue: any;\n try {\n this.work(state);\n } catch (e) {\n errored = true;\n // HACK: Since code elsewhere is relying on the \"truthiness\" of the\n // return here, we can't have it return \"\" or 0 or false.\n // TODO: Clean this up when we refactor schedulers mid-version-8 or so.\n errorValue = e ? e : new Error('Scheduled action threw falsy error');\n }\n if (errored) {\n this.unsubscribe();\n return errorValue;\n }\n }\n\n unsubscribe() {\n if (!this.closed) {\n const { id, scheduler } = this;\n const { actions } = scheduler;\n\n this.work = this.state = this.scheduler = null!;\n this.pending = false;\n\n arrRemove(actions, this);\n if (id != null) {\n this.id = this.recycleAsyncId(scheduler, id, null);\n }\n\n this.delay = null!;\n super.unsubscribe();\n }\n }\n}\n", "import { Action } from './scheduler/Action';\nimport { Subscription } from './Subscription';\nimport { SchedulerLike, SchedulerAction } from './types';\nimport { dateTimestampProvider } from './scheduler/dateTimestampProvider';\n\n/**\n * An execution context and a data structure to order tasks and schedule their\n * execution. Provides a notion of (potentially virtual) time, through the\n * `now()` getter method.\n *\n * Each unit of work in a Scheduler is called an `Action`.\n *\n * ```ts\n * class Scheduler {\n * now(): number;\n * schedule(work, delay?, state?): Subscription;\n * }\n * ```\n *\n * @class Scheduler\n * @deprecated Scheduler is an internal implementation detail of RxJS, and\n * should not be used directly. Rather, create your own class and implement\n * {@link SchedulerLike}. Will be made internal in v8.\n */\nexport class Scheduler implements SchedulerLike {\n public static now: () => number = dateTimestampProvider.now;\n\n constructor(private schedulerActionCtor: typeof Action, now: () => number = Scheduler.now) {\n this.now = now;\n }\n\n /**\n * A getter method that returns a number representing the current time\n * (at the time this function was called) according to the scheduler's own\n * internal clock.\n * @return {number} A number that represents the current time. May or may not\n * have a relation to wall-clock time. May or may not refer to a time unit\n * (e.g. milliseconds).\n */\n public now: () => number;\n\n /**\n * Schedules a function, `work`, for execution. May happen at some point in\n * the future, according to the `delay` parameter, if specified. May be passed\n * some context object, `state`, which will be passed to the `work` function.\n *\n * The given arguments will be processed an stored as an Action object in a\n * queue of actions.\n *\n * @param {function(state: ?T): ?Subscription} work A function representing a\n * task, or some unit of work to be executed by the Scheduler.\n * @param {number} [delay] Time to wait before executing the work, where the\n * time unit is implicit and defined by the Scheduler itself.\n * @param {T} [state] Some contextual data that the `work` function uses when\n * called by the Scheduler.\n * @return {Subscription} A subscription in order to be able to unsubscribe\n * the scheduled work.\n */\n public schedule(work: (this: SchedulerAction, state?: T) => void, delay: number = 0, state?: T): Subscription {\n return new this.schedulerActionCtor(this, work).schedule(state, delay);\n }\n}\n", "import { Scheduler } from '../Scheduler';\nimport { Action } from './Action';\nimport { AsyncAction } from './AsyncAction';\nimport { TimerHandle } from './timerHandle';\n\nexport class AsyncScheduler extends Scheduler {\n public actions: Array> = [];\n /**\n * A flag to indicate whether the Scheduler is currently executing a batch of\n * queued actions.\n * @type {boolean}\n * @internal\n */\n public _active: boolean = false;\n /**\n * An internal ID used to track the latest asynchronous task such as those\n * coming from `setTimeout`, `setInterval`, `requestAnimationFrame`, and\n * others.\n * @type {any}\n * @internal\n */\n public _scheduled: TimerHandle | undefined;\n\n constructor(SchedulerAction: typeof Action, now: () => number = Scheduler.now) {\n super(SchedulerAction, now);\n }\n\n public flush(action: AsyncAction): void {\n const { actions } = this;\n\n if (this._active) {\n actions.push(action);\n return;\n }\n\n let error: any;\n this._active = true;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions.shift()!)); // exhaust the scheduler queue\n\n this._active = false;\n\n if (error) {\n while ((action = actions.shift()!)) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\n/**\n *\n * Async Scheduler\n *\n * Schedule task as if you used setTimeout(task, duration)\n *\n * `async` scheduler schedules tasks asynchronously, by putting them on the JavaScript\n * event loop queue. It is best used to delay tasks in time or to schedule tasks repeating\n * in intervals.\n *\n * If you just want to \"defer\" task, that is to perform it right after currently\n * executing synchronous code ends (commonly achieved by `setTimeout(deferredTask, 0)`),\n * better choice will be the {@link asapScheduler} scheduler.\n *\n * ## Examples\n * Use async scheduler to delay task\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * const task = () => console.log('it works!');\n *\n * asyncScheduler.schedule(task, 2000);\n *\n * // After 2 seconds logs:\n * // \"it works!\"\n * ```\n *\n * Use async scheduler to repeat task in intervals\n * ```ts\n * import { asyncScheduler } from 'rxjs';\n *\n * function task(state) {\n * console.log(state);\n * this.schedule(state + 1, 1000); // `this` references currently executing Action,\n * // which we reschedule with new state and delay\n * }\n *\n * asyncScheduler.schedule(task, 3000, 0);\n *\n * // Logs:\n * // 0 after 3s\n * // 1 after 4s\n * // 2 after 5s\n * // 3 after 6s\n * ```\n */\n\nexport const asyncScheduler = new AsyncScheduler(AsyncAction);\n\n/**\n * @deprecated Renamed to {@link asyncScheduler}. Will be removed in v8.\n */\nexport const async = asyncScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { Subscription } from '../Subscription';\nimport { QueueScheduler } from './QueueScheduler';\nimport { SchedulerAction } from '../types';\nimport { TimerHandle } from './timerHandle';\n\nexport class QueueAction extends AsyncAction {\n constructor(protected scheduler: QueueScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n public schedule(state?: T, delay: number = 0): Subscription {\n if (delay > 0) {\n return super.schedule(state, delay);\n }\n this.delay = delay;\n this.state = state;\n this.scheduler.flush(this);\n return this;\n }\n\n public execute(state: T, delay: number): any {\n return delay > 0 || this.closed ? super.execute(state, delay) : this._execute(state, delay);\n }\n\n protected requestAsyncId(scheduler: QueueScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n\n if ((delay != null && delay > 0) || (delay == null && this.delay > 0)) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n\n // Otherwise flush the scheduler starting with this action.\n scheduler.flush(this);\n\n // HACK: In the past, this was returning `void`. However, `void` isn't a valid\n // `TimerHandle`, and generally the return value here isn't really used. So the\n // compromise is to return `0` which is both \"falsy\" and a valid `TimerHandle`,\n // as opposed to refactoring every other instanceo of `requestAsyncId`.\n return 0;\n }\n}\n", "import { AsyncScheduler } from './AsyncScheduler';\n\nexport class QueueScheduler extends AsyncScheduler {\n}\n", "import { QueueAction } from './QueueAction';\nimport { QueueScheduler } from './QueueScheduler';\n\n/**\n *\n * Queue Scheduler\n *\n * Put every next task on a queue, instead of executing it immediately\n *\n * `queue` scheduler, when used with delay, behaves the same as {@link asyncScheduler} scheduler.\n *\n * When used without delay, it schedules given task synchronously - executes it right when\n * it is scheduled. However when called recursively, that is when inside the scheduled task,\n * another task is scheduled with queue scheduler, instead of executing immediately as well,\n * that task will be put on a queue and wait for current one to finish.\n *\n * This means that when you execute task with `queue` scheduler, you are sure it will end\n * before any other task scheduled with that scheduler will start.\n *\n * ## Examples\n * Schedule recursively first, then do something\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(() => {\n * queueScheduler.schedule(() => console.log('second')); // will not happen now, but will be put on a queue\n *\n * console.log('first');\n * });\n *\n * // Logs:\n * // \"first\"\n * // \"second\"\n * ```\n *\n * Reschedule itself recursively\n * ```ts\n * import { queueScheduler } from 'rxjs';\n *\n * queueScheduler.schedule(function(state) {\n * if (state !== 0) {\n * console.log('before', state);\n * this.schedule(state - 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * console.log('after', state);\n * }\n * }, 0, 3);\n *\n * // In scheduler that runs recursively, you would expect:\n * // \"before\", 3\n * // \"before\", 2\n * // \"before\", 1\n * // \"after\", 1\n * // \"after\", 2\n * // \"after\", 3\n *\n * // But with queue it logs:\n * // \"before\", 3\n * // \"after\", 3\n * // \"before\", 2\n * // \"after\", 2\n * // \"before\", 1\n * // \"after\", 1\n * ```\n */\n\nexport const queueScheduler = new QueueScheduler(QueueAction);\n\n/**\n * @deprecated Renamed to {@link queueScheduler}. Will be removed in v8.\n */\nexport const queue = queueScheduler;\n", "import { AsyncAction } from './AsyncAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\nimport { SchedulerAction } from '../types';\nimport { animationFrameProvider } from './animationFrameProvider';\nimport { TimerHandle } from './timerHandle';\n\nexport class AnimationFrameAction extends AsyncAction {\n constructor(protected scheduler: AnimationFrameScheduler, protected work: (this: SchedulerAction, state?: T) => void) {\n super(scheduler, work);\n }\n\n protected requestAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle {\n // If delay is greater than 0, request as an async action.\n if (delay !== null && delay > 0) {\n return super.requestAsyncId(scheduler, id, delay);\n }\n // Push the action to the end of the scheduler queue.\n scheduler.actions.push(this);\n // If an animation frame has already been requested, don't request another\n // one. If an animation frame hasn't been requested yet, request one. Return\n // the current animation frame request id.\n return scheduler._scheduled || (scheduler._scheduled = animationFrameProvider.requestAnimationFrame(() => scheduler.flush(undefined)));\n }\n\n protected recycleAsyncId(scheduler: AnimationFrameScheduler, id?: TimerHandle, delay: number = 0): TimerHandle | undefined {\n // If delay exists and is greater than 0, or if the delay is null (the\n // action wasn't rescheduled) but was originally scheduled as an async\n // action, then recycle as an async action.\n if (delay != null ? delay > 0 : this.delay > 0) {\n return super.recycleAsyncId(scheduler, id, delay);\n }\n // If the scheduler queue has no remaining actions with the same async id,\n // cancel the requested animation frame and set the scheduled flag to\n // undefined so the next AnimationFrameAction will request its own.\n const { actions } = scheduler;\n if (id != null && actions[actions.length - 1]?.id !== id) {\n animationFrameProvider.cancelAnimationFrame(id as number);\n scheduler._scheduled = undefined;\n }\n // Return undefined so the action knows to request a new async id if it's rescheduled.\n return undefined;\n }\n}\n", "import { AsyncAction } from './AsyncAction';\nimport { AsyncScheduler } from './AsyncScheduler';\n\nexport class AnimationFrameScheduler extends AsyncScheduler {\n public flush(action?: AsyncAction): void {\n this._active = true;\n // The async id that effects a call to flush is stored in _scheduled.\n // Before executing an action, it's necessary to check the action's async\n // id to determine whether it's supposed to be executed in the current\n // flush.\n // Previous implementations of this method used a count to determine this,\n // but that was unsound, as actions that are unsubscribed - i.e. cancelled -\n // are removed from the actions array and that can shift actions that are\n // scheduled to be executed in a subsequent flush into positions at which\n // they are executed within the current flush.\n const flushId = this._scheduled;\n this._scheduled = undefined;\n\n const { actions } = this;\n let error: any;\n action = action || actions.shift()!;\n\n do {\n if ((error = action.execute(action.state, action.delay))) {\n break;\n }\n } while ((action = actions[0]) && action.id === flushId && actions.shift());\n\n this._active = false;\n\n if (error) {\n while ((action = actions[0]) && action.id === flushId && actions.shift()) {\n action.unsubscribe();\n }\n throw error;\n }\n }\n}\n", "import { AnimationFrameAction } from './AnimationFrameAction';\nimport { AnimationFrameScheduler } from './AnimationFrameScheduler';\n\n/**\n *\n * Animation Frame Scheduler\n *\n * Perform task when `window.requestAnimationFrame` would fire\n *\n * When `animationFrame` scheduler is used with delay, it will fall back to {@link asyncScheduler} scheduler\n * behaviour.\n *\n * Without delay, `animationFrame` scheduler can be used to create smooth browser animations.\n * It makes sure scheduled task will happen just before next browser content repaint,\n * thus performing animations as efficiently as possible.\n *\n * ## Example\n * Schedule div height animation\n * ```ts\n * // html:
\n * import { animationFrameScheduler } from 'rxjs';\n *\n * const div = document.querySelector('div');\n *\n * animationFrameScheduler.schedule(function(height) {\n * div.style.height = height + \"px\";\n *\n * this.schedule(height + 1); // `this` references currently executing Action,\n * // which we reschedule with new state\n * }, 0, 0);\n *\n * // You will see a div element growing in height\n * ```\n */\n\nexport const animationFrameScheduler = new AnimationFrameScheduler(AnimationFrameAction);\n\n/**\n * @deprecated Renamed to {@link animationFrameScheduler}. Will be removed in v8.\n */\nexport const animationFrame = animationFrameScheduler;\n", "import { Observable } from '../Observable';\nimport { SchedulerLike } from '../types';\n\n/**\n * A simple Observable that emits no items to the Observer and immediately\n * emits a complete notification.\n *\n * Just emits 'complete', and nothing else.\n *\n * ![](empty.png)\n *\n * A simple Observable that only emits the complete notification. It can be used\n * for composing with other Observables, such as in a {@link mergeMap}.\n *\n * ## Examples\n *\n * Log complete notification\n *\n * ```ts\n * import { EMPTY } from 'rxjs';\n *\n * EMPTY.subscribe({\n * next: () => console.log('Next'),\n * complete: () => console.log('Complete!')\n * });\n *\n * // Outputs\n * // Complete!\n * ```\n *\n * Emit the number 7, then complete\n *\n * ```ts\n * import { EMPTY, startWith } from 'rxjs';\n *\n * const result = EMPTY.pipe(startWith(7));\n * result.subscribe(x => console.log(x));\n *\n * // Outputs\n * // 7\n * ```\n *\n * Map and flatten only odd numbers to the sequence `'a'`, `'b'`, `'c'`\n *\n * ```ts\n * import { interval, mergeMap, of, EMPTY } from 'rxjs';\n *\n * const interval$ = interval(1000);\n * const result = interval$.pipe(\n * mergeMap(x => x % 2 === 1 ? of('a', 'b', 'c') : EMPTY),\n * );\n * result.subscribe(x => console.log(x));\n *\n * // Results in the following to the console:\n * // x is equal to the count on the interval, e.g. (0, 1, 2, 3, ...)\n * // x will occur every 1000ms\n * // if x % 2 is equal to 1, print a, b, c (each on its own)\n * // if x % 2 is not equal to 1, nothing will be output\n * ```\n *\n * @see {@link Observable}\n * @see {@link NEVER}\n * @see {@link of}\n * @see {@link throwError}\n */\nexport const EMPTY = new Observable((subscriber) => subscriber.complete());\n\n/**\n * @param scheduler A {@link SchedulerLike} to use for scheduling\n * the emission of the complete notification.\n * @deprecated Replaced with the {@link EMPTY} constant or {@link scheduled} (e.g. `scheduled([], scheduler)`). Will be removed in v8.\n */\nexport function empty(scheduler?: SchedulerLike) {\n return scheduler ? emptyScheduled(scheduler) : EMPTY;\n}\n\nfunction emptyScheduled(scheduler: SchedulerLike) {\n return new Observable((subscriber) => scheduler.schedule(() => subscriber.complete()));\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport function isScheduler(value: any): value is SchedulerLike {\n return value && isFunction(value.schedule);\n}\n", "import { SchedulerLike } from '../types';\nimport { isFunction } from './isFunction';\nimport { isScheduler } from './isScheduler';\n\nfunction last(arr: T[]): T | undefined {\n return arr[arr.length - 1];\n}\n\nexport function popResultSelector(args: any[]): ((...args: unknown[]) => unknown) | undefined {\n return isFunction(last(args)) ? args.pop() : undefined;\n}\n\nexport function popScheduler(args: any[]): SchedulerLike | undefined {\n return isScheduler(last(args)) ? args.pop() : undefined;\n}\n\nexport function popNumber(args: any[], defaultValue: number): number {\n return typeof last(args) === 'number' ? args.pop()! : defaultValue;\n}\n", "export const isArrayLike = ((x: any): x is ArrayLike => x && typeof x.length === 'number' && typeof x !== 'function');", "import { isFunction } from \"./isFunction\";\n\n/**\n * Tests to see if the object is \"thennable\".\n * @param value the object to test\n */\nexport function isPromise(value: any): value is PromiseLike {\n return isFunction(value?.then);\n}\n", "import { InteropObservable } from '../types';\nimport { observable as Symbol_observable } from '../symbol/observable';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being Observable (but not necessary an Rx Observable) */\nexport function isInteropObservable(input: any): input is InteropObservable {\n return isFunction(input[Symbol_observable]);\n}\n", "import { isFunction } from './isFunction';\n\nexport function isAsyncIterable(obj: any): obj is AsyncIterable {\n return Symbol.asyncIterator && isFunction(obj?.[Symbol.asyncIterator]);\n}\n", "/**\n * Creates the TypeError to throw if an invalid object is passed to `from` or `scheduled`.\n * @param input The object that was passed.\n */\nexport function createInvalidObservableTypeError(input: any) {\n // TODO: We should create error codes that can be looked up, so this can be less verbose.\n return new TypeError(\n `You provided ${\n input !== null && typeof input === 'object' ? 'an invalid object' : `'${input}'`\n } where a stream was expected. You can provide an Observable, Promise, ReadableStream, Array, AsyncIterable, or Iterable.`\n );\n}\n", "export function getSymbolIterator(): symbol {\n if (typeof Symbol !== 'function' || !Symbol.iterator) {\n return '@@iterator' as any;\n }\n\n return Symbol.iterator;\n}\n\nexport const iterator = getSymbolIterator();\n", "import { iterator as Symbol_iterator } from '../symbol/iterator';\nimport { isFunction } from './isFunction';\n\n/** Identifies an input as being an Iterable */\nexport function isIterable(input: any): input is Iterable {\n return isFunction(input?.[Symbol_iterator]);\n}\n", "import { ReadableStreamLike } from '../types';\nimport { isFunction } from './isFunction';\n\nexport async function* readableStreamLikeToAsyncGenerator(readableStream: ReadableStreamLike): AsyncGenerator {\n const reader = readableStream.getReader();\n try {\n while (true) {\n const { value, done } = await reader.read();\n if (done) {\n return;\n }\n yield value!;\n }\n } finally {\n reader.releaseLock();\n }\n}\n\nexport function isReadableStreamLike(obj: any): obj is ReadableStreamLike {\n // We don't want to use instanceof checks because they would return\n // false for instances from another Realm, like an + + +
+

✨✨ Thanks for your support! ✨✨

+ + + + + + + + + + + + + + + + + + + + + + + + + + + +
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/community/users/index.html b/community/users/index.html new file mode 100644 index 00000000..33883ae3 --- /dev/null +++ b/community/users/index.html @@ -0,0 +1,2822 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Users - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Users

+ +

Who uses cxcli?

+

As the cxcli community grows, we'd like to keep a list of our users.

+

Here's a running list of some organizations using cxcli1:

+
    +
  1. Empty list, become the first one!
    2. +
+

Feel free to add yours!

+ + +
+
+
    +
  1. +

    Entries were either added by the companies themselves or by the maintainers after seeing it in the wild. ↩

    +
    2. +
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/conversationprofiler/examples/contains/index.html b/conversationprofiler/examples/contains/index.html new file mode 100644 index 00000000..92e9abbf --- /dev/null +++ b/conversationprofiler/examples/contains/index.html @@ -0,0 +1,2855 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Contains - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Audio input

+

Suite file

+
# suite.yaml
+
+name: Example Suite
+description: Suite used as an example
+projectId: test-cx-346408
+locationId: us-central1
+agentName: test-agent
+tests:
+  - id: test_id
+    file: ./test.yaml
+
+

Test file

+
# test.yaml
+
+name: Example test
+description: These are some tests
+localeId: en
+interactions:
+  - id: test_1
+    user: 
+      type: text
+      text: hi
+    agent:
+      validate:
+        - type: contains
+          value: hello
+
+

You can download the audio file used in this example here

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/conversationprofiler/examples/index.html b/conversationprofiler/examples/index.html new file mode 100644 index 00000000..d6a802f2 --- /dev/null +++ b/conversationprofiler/examples/index.html @@ -0,0 +1,2773 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Examples - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Examples

+

Contains

+

Simple example that demonstrates the Conversational Profiler in action using the contains validator. Find it here

+

Prompt

+

Example that shows how to use a prompt as an user input Dialogflow CX. Find it here

+

String Similarity Algorithm

+

Full example using a string similarity algorithm to validate the agent's response. Find it here

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/conversationprofiler/examples/prompt/index.html b/conversationprofiler/examples/prompt/index.html new file mode 100644 index 00000000..264b6714 --- /dev/null +++ b/conversationprofiler/examples/prompt/index.html @@ -0,0 +1,2854 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Prompt - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Prompt example

+

Suite file

+
# suite.yaml
+
+name: Example Suite
+description: Suite used as an example
+projectId: test-cx-346408
+locationId: us-central1
+agentName: test-agent
+tests:
+  - id: test_id
+    file: ./test.yaml
+
+

Test file

+
# test.yaml
+
+name: Example test
+description: These are some tests
+localeId: en
+interactions:
+  - id: test_1_1
+    user: 
+      type: prompt
+      prompt: give me a one line hello
+    agent:
+      validate:
+        - type: equals
+          value: hello
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/conversationprofiler/examples/similarity/index.html b/conversationprofiler/examples/similarity/index.html new file mode 100644 index 00000000..f5de271b --- /dev/null +++ b/conversationprofiler/examples/similarity/index.html @@ -0,0 +1,2858 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + String Similarity Algorithm - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

System entity detection example

+

Suite file

+
# suite.yaml
+
+name: Example Suite
+description: Suite used as an example
+projectId: test-cx-346408
+locationId: us-central1
+agentName: test-agent
+tests:
+  - id: test_id
+    file: ./test.yaml
+
+

Test file

+
# test.yaml
+
+name: Example test
+description: These are some tests
+localeId: en
+interactions:
+  - id: test_1_4
+    user: 
+      type: text
+      text: hi
+    agent:
+      validate:
+        - type: similarity
+          algorithm: levenshtein
+          value: hello
+          threshold: 0.4
+          configuration-levenshtein:
+            casesensitive: false
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/conversationprofiler/introduction/index.html b/conversationprofiler/introduction/index.html new file mode 100644 index 00000000..9e2c353b --- /dev/null +++ b/conversationprofiler/introduction/index.html @@ -0,0 +1,2900 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Introduction - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Conversation profiler

+

What is this?

+

+ Flow +

+ +

Use the Conversation Profiler to test user utterances and improve your agent's interaction model.

+

With the Conversation Profiler, you can test the conversation flow of your agent. This means that you can send user's utterances to your agent and check if the agent is responding as expected (interactions). This feature is also useful when you have generative AI models in your agent, and you want to test if the agent is responding as expected. It is similar to the Dialogflow CX console's Test Agent feature, but with the Conversation Profiler, you can run your tests in your CI/CD pipelines and also it has additional features. Every suite is executed in the same Dialogflow CX session.

+

All of the commands that are available in cxcli to execute the Conversation profiler are located within the cxcli profile-conversation subcommand.

+

Reference

+

It is important to know which suites and tests you can build. Because of that, you can find the entire reference on the Reference page. Suites and test are defined as yaml files.

+

The cxcli has a command that allows you to run these suites from your terminal or from your CI pipelines.

+

To execute a suite, you can run the cxcli profile-conversation execute command. For the usage, please refer to this page.

+

Examples

+

You can find some useful examples on our GitHub repo and the Examples page.

+

Execution Example

+

Here is a simple example of the cxcli profile-conversation execute command:

+
cxcli profile-conversation execute examples/profileconversation/suite.yaml
+
+

The above command will give you output similar to the following:

+
$ cxcli profile-conversation execute suite.yaml
+[INFO] Running suite: Example Conversation Profiler Suite
+[INFO][test-file:test_1][interaction:test_1_1][input:prompt] User> Hello! (auto-generated from prompt: "give me a one line hello")
+[INFO][test-file:test_1][interaction:test_1_1][input:prompt] Agent> Hi! How are you doing?
+[INFO][test-file:test_1][interaction:test_1_1][validation:equals] Validation with value "hi" 
+[INFO][test-file:test_1][interaction:test_1_1][validation:equals] Validation configuration: {CaseSensitive:false}
+[INFO][test-file:test_1][interaction:test_1_2][input:text] User> hi
+[INFO][test-file:test_1][interaction:test_1_2][input:text] Agent> Hi! How are you doing?
+[INFO][test-file:test_1][interaction:test_1_2][validation:contains] Validation with value "hi" 
+[INFO][test-file:test_1][interaction:test_1_2][validation:contains] Validation configuration: {CaseSensitive:false}
+[INFO][test-file:test_1][interaction:test_1_3][input:text] User> hello
+[INFO][test-file:test_1][interaction:test_1_3][input:text] Agent> Hi! How are you doing?
+[INFO][test-file:test_1][interaction:test_1_3][validation:equals] Validation with value "hello" 
+[INFO][test-file:test_1][interaction:test_1_3][validation:equals] Validation configuration: {CaseSensitive:false}
+[INFO][test-file:test_1][interaction:test_1_4][input:text] User> hi
+[INFO][test-file:test_1][interaction:test_1_4][input:text] Agent> Hi! How are you doing?
+[INFO][test-file:test_1][interaction:test_1_4][validation:similarity] Validation with value "hello" 
+[INFO][test-file:test_1][interaction:test_1_4][validation:similarity] Validation configuration: {CaseSensitive:false InsertCost:0 DeleteCost:0 ReplaceCost:0}
+
+
+

Are you running this command in a CI/CD pipeline?

+

If this is the case, we recommend that you set the --output-format parameter to json.

+
+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/conversationprofiler/suites/index.html b/conversationprofiler/suites/index.html new file mode 100644 index 00000000..ce189a65 --- /dev/null +++ b/conversationprofiler/suites/index.html @@ -0,0 +1,2857 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Suites - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Suites

+

Reference

+

A suite is a yaml file with the following structure:

+
# suite.yaml
+
+# Name of the suite.
+name: Example Suite
+# Brief description of the suite.
+description: Suite used as an example
+# Project ID on Google Cloud where is located your Dialogflow CX agent.
+projectId: test-cx-346408
+# Location where your Dialogflow CX agent is running. 
+# More info here: https://cloud.google.com/dialogflow/cx/docs/concept/region
+locationId: us-central1
+# Agent name of your Dialogflow CX agent.
+# Notice: it is the agent name, not the agent ID.
+agentName: test-agent
+# You can have multiple tests defined in separated files
+tests:
+  # ID of the test.
+  - id: test_id
+    # File where the test specification is located
+    file: ./test.yaml
+
+

It has the same structure as the NLU Profiler suite.

+

JSON Schema

+

cxcli also has a jsonschema file, which you can use to have better +editor support:

+
https://cxcli.xavidop.me/static/conversationsuite.json
+
+

You can also specify it in your yml config files by adding a +comment like the following: +

# yaml-language-server: $schema=https://cxcli.xavidop.me/static/conversationsuite.json
+

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/conversationprofiler/tests/index.html b/conversationprofiler/tests/index.html new file mode 100644 index 00000000..8a7280c0 --- /dev/null +++ b/conversationprofiler/tests/index.html @@ -0,0 +1,3491 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tests - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Tests

+

Reference

+

A test is a yaml file with the following structure:

+
# test.yaml
+
+# Name of the test.
+name: Example test
+# Brief description of the test.
+description: These are some tests
+# Locale of the interaction model that is gonna be tested.
+# You can find the locales here: https://cloud.google.com/dialogflow/cx/docs/reference/language
+localeId: en
+# A interactions is the test itself: given an input, you will validate the agent response returned by Dialogflow CX
+# You can have multiple interactions defined
+interactions:
+  # The ID of the interactions
+  - id: test_1
+    user:
+      # the input type
+      # it could be text, audio or prompt
+      type: text
+      # The input itself in text format. For type: audio, you have to specify the audio file.
+      text: I want 3 pizzas
+    agent:
+      validate:
+        # String validation to check if the response returned by Dialogflow CX is correct
+        - type: contains
+          value: pizza
+
+  - id: test_2
+    user: 
+      type: text
+      text: hi
+    agent:
+      # example with a string similarity validation
+      validate:
+        - type: similarity
+          algorithm: levenshtein
+          threshold: 0.4
+          value: hello
+          configuration-levenshtein:
+            casesensitive: false
+
+  - id: test_3
+    user: 
+      type: audio
+      audio: ./audio/hi.mp3
+    agent:
+      # example with a regexp validation
+      validate:
+        - type: regexp
+          value: '/my-regex/'
+
+

Input types

+

Text input

+

The input text is the simplest one. You just have to specify the text you want to send to Dialogflow CX. Make sure that the text is in the language you specified in the localeId field. to use this type you have to set the type field to text and the text field to the text you want to send.

+

Audio input

+

The audio input is a little bit more complex. You have to specify the path to the audio file you want to send to Dialogflow CX. Make sure that the audio file is in the language you specified in the localeId field. To use this type you have to set the type field to audio and the file field to the path to the audio file.

+

It is important to know that the input audio needs to have the following format:

+
    +
  1. A sample rate of 16000 Hertz
    2. +
  2. The audio encoding has to be Linear16. Linear16 is a 16-bit linear pulse-code modulation (PCM) encoding.
    3. +
+

If you don't have a file with this format, you can create it by yourself using the cxcli tts command! All the information is located here

+

Prompt input

+

The prompt input is the most complex one. You have to specify the input prompt you want to send to Dialogflow CX. To use this type you have to set the type field to prompt and the prompt field to the prompt you want to send.

+

It is important to know that the input prompt needs Vertex AI API to be enabled in your project and the proper permissions granted. You can find more information on the Authentication page.

+

Validation types

+

Contains

+

The contains validation type is the simplest one. It just checks if the response returned by the Dialogflow CX agent contains the value specified in the value field. To use this type you have to set the type field to contains and the value field to the value you want to check:

+
validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: contains
+    value: pizza
+
+

The contains validation has its own options:

+
validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: contains
+    value: pizza
+    configuration-contains:
+      casesensitive: true
+
+

If you set the casesensitive field to true, the validation will be case sensitive. By default, it is set to false.

+

Equals

+

The equals validation type is a little bit more complex. It checks if the response returned by the Dialogflow CX agent is equal to the value specified in the value field. To use this type you have to set the type field to equals and the value field to the value you want to check:

+
validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: equals
+    value: Here you have 3 pizzas
+
+

The equals validation has its own options:

+
validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: equals
+    value: Here you have 3 pizzas
+    configuration-equals:
+      casesensitive: true
+
+

If you set the casesensitive field to true, the validation will be case sensitive. By default, it is set to false.

+

Regexp

+

The regexp validation type is the most complex one. It checks if the response returned by the Dialogflow CX agent matches the regexp specified in the value field. To use this type you have to set the type field to regexp and the value field to the regular expression you want to check:

+
validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: regexp
+    value: '/Here you have \d pizzas/'
+
+

The regexp validation has its own options:

+
validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: regexp
+    value: '/Here you have \d pizzas/'
+    configuration-regexp:
+      findinsubmatches: true
+
+

If you set the findinsubmatches field to true, the validation will check if the regexp matches any of the submatches. By default, it is set to false.

+

String Similarity Algorithms

+

The string similarity validation type is the most complex one. It checks if the response returned by the Dialogflow CX agent is similar to the value specified in the value field using a threshold to check if the similarity is enough. To use this type you have to set the type field to similarity and the algorithm field to the algorithm you want to use and the value field to the value you want to check and the threshold field to the threshold you want to use. The available algorithms are:

+
    +
  1. levenshtein: The Levenshtein distance is a string metric for measuring the difference between two sequences. Informally, the Levenshtein distance between two words is the minimum number of single-character edits (insertions, deletions or substitutions) required to change one word into the other.
    2. +
  2. jaro: The Jaro distance is a measure of similarity between two strings. The higher the Jaro distance for two strings is, the more similar the strings are. The score is normalized such that 0 equates to no similarity and 1 is an exact match.
    3. +
  3. jaro-winkler: The Jaro–Winkler distance is a string metric for measuring the edit distance between two sequences. Informally, the Jaro–Winkler distance is the edit distance between two strings with the twist that higher scores are returned for strings that match from the beginning for a set prefix length.
    4. +
  4. smith-waterman-gotoh: The Smith–Waterman algorithm performs local sequence alignment; that is, for determining similar regions between two strings of nucleic acid sequences or protein sequences. Instead of looking at the entire sequence, the Smith–Waterman algorithm compares segments of all possible lengths and optimizes the similarity measure.
    5. +
  5. sorensen-dice: The Dice distance is a measure of similarity between two strings. The higher the Dice distance for two strings is, the more similar the strings are. The score is normalized such that 0 equates to no similarity and 1 is an exact match.
    6. +
  6. jaccard: The Jaccard distance is a measure of similarity between two strings. The higher the Jaccard distance for two strings is, the more similar the strings are. The score is normalized such that 0 equates to no similarity and 1 is an exact match.
    7. +
  7. overlap-coefficient: The Overlap distance (or Szymkiewicz-Simpson distance) is a measure of similarity between two strings. The higher the Overlap distance for two strings is, the more similar the strings are. The score is normalized such that 0 equates to no similarity and 1 is an exact match.
    8. +
  8. hamming: The Hamming measures the minimum number of substitutions required to change one string into the other, or equivalently, the minimum number of errors that could have transformed one string into the other. The higher the Hamming distance for two strings is, the more similar the strings are. The score is normalized such that 0 equates to no similarity and 1 is an exact match.
    9. +
+

Levenshtein

+

The levenshtein algorithm has the following configuration:

+
validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: levenshtein
+    value: hello
+    threshold: 0.4
+
+

The options are: +

validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: levenshtein
+    value: hello
+    threshold: 0.4
+    configuration-levenshtein:
+      casesensitive: true
+      insertcost: 1
+      deletecost: 1
+      replacecost: 1
+
+Let's explain each one of them:

+
    +
  1. The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.
    2. +
  2. the insertcost field is used to set the cost of an insert operation. By default, it is set to 1.
    3. +
  3. the deletecost field is used to set the cost of a delete operation. By default, it is set to 1.
    4. +
  4. the replacecost field is used to set the cost of a replace operation. By default, it is set to 1.
    5. +
+

Jaro

+

The Jaro algorithm has the following configuration:

+
validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: jaro
+    value: hello
+    threshold: 0.4
+
+

The options are: +

validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: jaro
+    value: hello
+    threshold: 0.4
+    configuration-jaro:
+      casesensitive: true
+

+

The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.

+

Jaro-Winkler

+

The Jaro-Winkler algorithm has the following configuration:

+
validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: jaro-winkler
+    value: hello
+    threshold: 0.4
+
+

The options are: +

validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: jaro-winkler
+    value: hello
+    threshold: 0.4
+    configuration-jaro-winkler:
+      casesensitive: true
+

+

The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.

+

Smith-Waterman-Gotoh

+

The Smith-Waterman-Gotoh algorithm has the following configuration:

+
validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: smith-waterman-gotoh
+    value: hello
+    threshold: 0.4
+
+

The options are: +

validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: smith-waterman-gotoh
+    value: hello
+    threshold: 0.4
+    configuration-smith-waterman-gotoh:
+      casesensitive: true
+      gappenalty: -0.5
+

+

Let's explain each one of them:

+
    +
  1. The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.
    2. +
  2. the gappenalty defines a score penalty for character insertions or deletions. For relevant results, the gap penalty should be a non-positive number. By default, it is set to -0.5.
    3. +
+

Sorensen-Dice

+

The Sorensen-Dice algorithm has the following configuration:

+
validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: sorensen-dice
+    value: hello
+    threshold: 0.4
+
+

The options are: +

validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: sorensen-dice
+    value: hello
+    threshold: 0.4
+    configuration-sorensen-dice:
+      casesensitive: true
+      NgramSize: 2
+

+

Let's explain each one of them:

+
    +
  1. The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.
    2. +
  2. The NgramSize represents the size (in characters) of the tokens generated when comparing the input sequences. By default, it is set to 2.
    3. +
+

Jaccard

+

The Jaccard algorithm has the following configuration:

+
validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: jaccard
+    value: hello
+    threshold: 0.4
+
+

The options are: +

validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: jaccard
+    value: hello
+    threshold: 0.4
+    configuration-jaccard:
+      casesensitive: true
+      NgramSize: 2
+

+

Let's explain each one of them:

+
    +
  1. The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.
    2. +
  2. The NgramSize represents the size (in characters) of the tokens generated when comparing the input sequences. By default, it is set to 2.
    3. +
+

Overlap Coefficient

+

The Overlap Coefficient algorithm has the following configuration:

+
validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: overlap-coefficient
+    value: hello
+    threshold: 0.4
+
+

The options are: +

validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: overlap-coefficient
+    value: hello
+    threshold: 0.4
+    configuration-overlap-coefficient:
+      casesensitive: true
+      NgramSize: 2
+

+

Let's explain each one of them:

+
    +
  1. The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.
    2. +
  2. The NgramSize represents the size (in characters) of the tokens generated when comparing the input sequences. By default, it is set to 2.
    3. +
+

Hamming

+

The Hamming algorithm has the following configuration:

+
validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: hamming
+    value: hello
+    threshold: 0.4
+
+

The options are: +

validate:
+  # String validation to check if the response returned by Dialogflow CX is correct
+  - type: similarity
+    algorithm: hamming
+    value: hello
+    threshold: 0.4
+    configuration-hamming:
+      casesensitive: true
+

+

The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.

+

JSON Schema

+

cxcli also has a jsonschema file, which you can use to have better +editor support:

+
https://cxcli.xavidop.me/static/conversationtest.json
+
+

You can also specify it in your yml config files by adding a +comment like the following: +

# yaml-language-server: $schema=https://cxcli.xavidop.me/static/conversationtest.json
+

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/dialog/index.html b/dialog/index.html new file mode 100644 index 00000000..748ef9ff --- /dev/null +++ b/dialog/index.html @@ -0,0 +1,2882 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Dialog - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Interactive Dialog

+

+ +

+ +

The cxcli tool has command that allows you to interactively play with your agent from your terminal!

+

Usage

+

You can find the dialog functionality within the cxcli dialog subcommand. You can read the documentation about this command here.

+

Parameters

+

These are the relevant parameters that you can use to interact with your agent interactively from your terminal:

+
    +
  1. locale: this parameter accepts all of the locales that are available in Dialogflow CX.
    2. +
+

Example

+

Here is a simple example of the cxcli dialog command:

+
cxcli dialog --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+
+

The above command will give you output similar to the following:

+
$ cxcli dialog --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+INFO Please press Ctrl+C whenever you want to stop the interaction. 
+User> hi
+Agent> Hi, this is Information Finder. Which product information do you need?
+User> sorry, can you repeat
+Agent> I didn't get that.
+Agent> Hi, I am a chatbot that can help you find information about CorpX products: Intelligent Customer Insight, Order Fulfillment, Order Handling, Order Management Suite, Sales Engine, or Supercharge.
+Agent> Do you want to continue looking up information for one of these products? Say yes or no.
+User> no
+Agent> Goodbye
+
+
+

Important

+

Once the session is finished, you will get the terminal prompt again.

+
+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/entitytypes/create/index.html b/entitytypes/create/index.html new file mode 100644 index 00000000..78ca6cb0 --- /dev/null +++ b/entitytypes/create/index.html @@ -0,0 +1,2856 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Create

+

Usage

+

You can find the create functionality within the cxcli entity-type create subcommand. You can read the documentation about this command here.

+

The argument to --entities is a list of the entities with their synonyms, comma separated. This parameter has the following format: +

entity1@synonym1|synonym2,entity2@synonym1|synonym2
+

+

An example entity type with synonyms: pikachu@25|pika,charmander@3

+

Example

+

Here is a simple example of the cxcli entity-type create command:

+
cxcli entity-type create pokemon --entities "pikachu@25|pika,charmander@3" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+
+

The above command will give you output similar to the following:

+
$ cxcli entity-type create pokemon --entities "pikachu@25|pika,charmander@3" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+INFO Entity Type created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/entityTypes/457a451d-f5ce-47da-b8dc-16b17d874a5d
+
+ +

If you want to learn more about Dialogflow CX entity types creation, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/entitytypes/delete/index.html b/entitytypes/delete/index.html new file mode 100644 index 00000000..2773718c --- /dev/null +++ b/entitytypes/delete/index.html @@ -0,0 +1,2852 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Delete

+

Usage

+

You can find the delete functionality within the cxcli entity-type delete subcommand. You can read the documentation about this command here.

+

Example

+

Here is a simple example of the cxcli entity-type delete command:

+
cxcli entity-type delete pokemon2  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+
+

The above command will give you output similar to the following:

+
$ cxcli entity-type delete pokemon2  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+INFO Entity Type deleted
+
+ +

If you want to learn more about Dialogflow CX entity types deletion, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/entitytypes/introduction/index.html b/entitytypes/introduction/index.html new file mode 100644 index 00000000..083d5476 --- /dev/null +++ b/entitytypes/introduction/index.html @@ -0,0 +1,2900 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Introduction - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Entity types

+

What is this?

+

One of the most important aspects of natural language understanding is entity types or entities. Entities contain the important factors within a message such as names, dates, products, organizations, places, or anything that we want to extract from the message. We call this concept “entities”. For example, let's take a look at the order_intent intent:

+
    +
  1. I want a pizza
    2. +
  2. I want 3 cokes
    3. +
  3. Give me two burgers
    4. +
+

As you can see in the example above, we can extract two entity Types: quantity and order_type. We can represent the entities within the above utterances as:

+
    +
  1. I want {quantity} {order_type}
    2. +
  2. Give me {quantity} {order_type}
    3. +
+

We can also think of entity types as variables.

+

With cxcli, you can easily interact with your Dialogflow CX entity types.

+

All of the commands that you have available in cxcli to interact with your entity types are located within the cxcli entity-type subcommand.

+

Create

+

The cxcli has a command that allows you to create an entity type. You can find a more detailed information here.

+

Update

+

The cxcli has a command that allows you to update an entity type. You can find a more detailed information here.

+

Delete

+

The cxcli has a command that allows you to delete your entity type. You can find a more detailed explanation here.

+ +

If you want to see the full usage of the cxcli entity-type command, please refer to this page.

+

If you want to learn more about Dialogflow CX entity types, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/entitytypes/update/index.html b/entitytypes/update/index.html new file mode 100644 index 00000000..2d909702 --- /dev/null +++ b/entitytypes/update/index.html @@ -0,0 +1,2856 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Update - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Update

+

Usage

+

You can find the update functionality within the cxcli entity-type update subcommand. You can read the documentation about this command here.

+

The argument to --entities is a list of the entities with their synonyms, comma separated. This parameter has the following format: +

entity1@synonym1|synonym2,entity2@synonym1|synonym2
+

+

An example entity type with synonyms: pikachu@25|pika,charmander@3

+

Example

+

Here is a simple example of the cxcli entity-type update command:

+
cxcli entity-type update pokemon --entities "pikachu@25|pika,charmander@3" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+
+

The above command will give you output similar to the following:

+
$ cxcli entity-type update pokemon --entities "pikachu@25|pika,charmander@3" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+INFO Entity Type updated
+
+ +

If you want to learn more about Dialogflow CX entity types update, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/environments/cicd/index.html b/environments/cicd/index.html new file mode 100644 index 00000000..6cff6d97 --- /dev/null +++ b/environments/cicd/index.html @@ -0,0 +1,2857 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + CI/CD - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Environments CI/CD

+

Usage

+

You can find the CI/CD functionality within the cxcli environment execute-cicd subcommand. You can read the documentation about this command here.

+

Example

+

Here is a simple example of the cxcli environment execute-cicd command:

+
cxcli environment execute-cicd cicd-env --project-id test-cx-346408 --location-id us-central1 --agent-name test-agent
+
+

The above command will give you output similar to the following:

+
$ cxcli environment execute-cicd cicd-env --project-id test-cx-346408 --location-id us-central1 --agent-name test-agent
+INFO Executing cicd for environment cicd-env
+INFO PASSED
+
+
+

Are you running this command in a CI/CD pipeline?

+

If this is the case, we recommend that you set the --output-format parameter to json.

+
+ +

If you want to learn more about Dialogflow CX CI/CD execution, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/environments/create/index.html b/environments/create/index.html new file mode 100644 index 00000000..31225585 --- /dev/null +++ b/environments/create/index.html @@ -0,0 +1,2858 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Create

+

Usage

+

You can find the create functionality within the cxcli environment create subcommand. You can read the documentation about this command here.

+

The --flow-versions parameter is a list of flows and their versions to include in the environment, comma separated. For each flow used in this environment, it is required to add the version with this format: @flow-version. This is the full format:

+
flow@flow-version
+
+

An example of flows with their versions:

+
Default Start Flow@production_v2,Test Flow@v1.0.0
+
+

Example

+

Here is a simple example of using the cxcli environment create command:

+
cxcli environment create my-env --flow-versions "Default Start Flow@production_v2,Test Flow@v1.0.0"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+
+

The above command will give you output similar to the following:

+
$ cxcli environment create my-env --flow-versions "Default Start Flow@production_v2,Test Flow@v1.0.0"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+INFO Environment created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/environments/9f9cf42a-9033-4d73-9407-613d041c9403
+
+ +

If you want to learn more about Dialogflow CX environment creation, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/environments/delete/index.html b/environments/delete/index.html new file mode 100644 index 00000000..311aaaa8 --- /dev/null +++ b/environments/delete/index.html @@ -0,0 +1,2852 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Delete

+

Usage

+

You can find the delete functionality within the cxcli environment delete subcommand. You can read the documentation about this command here.

+

Example

+

Here is a simple example of the cxcli environment delete command:

+
cxcli environment delete my-env --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+
+

The above command will give you output similar to the following:

+
$ cxcli environment delete my-env --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+INFO Environment deleted
+
+ +

If you want to learn more about Dialogflow CX environment deletion, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/environments/introduction/index.html b/environments/introduction/index.html new file mode 100644 index 00000000..594f8bda --- /dev/null +++ b/environments/introduction/index.html @@ -0,0 +1,2911 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Introduction - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Environments

+

What is this?

+

In software, it is a common pattern (and a best practice) to have different environments where developers can deploy different versions of their software. Each environment has its own configuration.

+

Dialogflow CX follows the same concept in that you can create a version of your agent and then deploy it to a specific environment. This is also similar to a webhook in that you can deploy a specific webhook version and use that version within an environment.

+

With cxcli, you can easily interact with the environments of your Dialogflow CX agents.

+

All of the commands that you have available in cxcli to interact with your environments are located within the cxcli environment subcommand.

+

Create

+

The cxcli has a command that allows you to create an environment. You can find a more detailed information here.

+

Update

+

The cxcli has a command that allows you to update an environment. You can find a more detailed information here.

+

Delete

+

The cxcli has a command that allows you to delete your environment. You can find a more detailed explanation here.

+

CI/CD

+

In Dialogflow CX, when you are testing your agents, you can save those tests and associate them with a specific environment.

+

The cxcli tool has a command that allows you to run these CI/CD pipelines from your terminal or from your CI processes. You can find a more detailed explanation here.

+ +

If you want to see the full usage of the cxcli environment command, please refer to this page.

+

If you want to learn more about Dialogflow CX environments, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/environments/update/index.html b/environments/update/index.html new file mode 100644 index 00000000..bc97d908 --- /dev/null +++ b/environments/update/index.html @@ -0,0 +1,2858 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Update - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Update

+

Usage

+

You can find the update functionality within the cxcli environment update subcommand. You can read the documentation about this command here.

+

The --flow-versions parameter is a list of flows and their versions to include in the environment, comma separated. For each flow used in this environment, it is required to add the version with this format: @flow-version. This is the full format:

+
flow@flow-version
+
+

An example of flows with their versions:

+
Default Start Flow@production_v2,Test Flow@v1.0.0
+
+

Example

+

Here is a simple example of the cxcli entity-type update command:

+
cxcli environment update my-env --flow-versions "Default Start Flow@production_v3,Test Flow@v1.1.0"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description "This is a test environment"
+
+

The above command will give you output similar to the following:

+
$ cxcli environment update my-env --flow-versions "Default Start Flow@production_v3,Test Flow@v1.1.0"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description "This is a test environment"
+INFO Environment updated
+
+ +

If you want to learn more about Dialogflow CX environment update, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/flows/create/index.html b/flows/create/index.html new file mode 100644 index 00000000..4f9c758b --- /dev/null +++ b/flows/create/index.html @@ -0,0 +1,2852 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Create

+

Usage

+

You can find the create functionality within the cxcli flow create subcommand. You can read the documentation about this command here.

+

Example

+

Here is a simple example of using the cxcli flow create command:

+
cxcli flow create my-flow --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description "My test flow"
+
+

The above command will give you output similar to the following:

+
$ cxcli flow create my-flow --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description "My test flow"
+INFO Flow created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/flows/49a38c72-2a63-4d71-a266-2d722eb8360e
+
+ +

If you want to learn more about Dialogflow CX flow creation, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/flows/delete/index.html b/flows/delete/index.html new file mode 100644 index 00000000..b0123d63 --- /dev/null +++ b/flows/delete/index.html @@ -0,0 +1,2852 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Delete

+

Usage

+

You can find the delete functionality within the cxcli flow delete subcommand. You can read the documentation about this command here.

+

Example

+

Here is a simple example of the cxcli flow delete command:

+
cxcli flow delete my-flow --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+
+

The above command will give you output similar to the following:

+
$ cxcli flow delete my-flow --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+INFO Flow deleted
+
+ +

If you want to learn more about Dialogflow CX flow deletion, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/flows/introduction/index.html b/flows/introduction/index.html new file mode 100644 index 00000000..e49b0b3c --- /dev/null +++ b/flows/introduction/index.html @@ -0,0 +1,2911 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Introduction - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Flows

+

What is this?

+

In intricate conversations, various topics come into play. Take, for example, a flight book service, where a dialogue may cover areas like seat booking a meal reservation, obtaining customer information, and confirming the booking. Each of these topics requires multiple interactions between the agent and the end-user to gather the necessary information.

+

Flows are employed to delineate these topics and their respective conversational paths. Each agent is equipped with a default start flow, which serves as a foundation for simple agents.

+

With cxcli, you can easily interact with the flows of your Dialogflow CX agents.

+

All of the commands that you have available in cxcli to interact with your flows are located within the cxcli flow subcommand.

+

Create

+

The cxcli has a command that allows you to create a flow. You can find a more detailed information here.

+

Update

+

The cxcli has a command that allows you to update a flow. You can find a more detailed information here.

+

Delete

+

The cxcli has a command that allows you to delete your flow. You can find a more detailed explanation here.

+

Train

+

In Dialogflow CX, when you are adding training phrases to your intents and synonyms to your entity types, you will need to train your agent in order to have the latest changes ready for your end-users.

+

The cxcli tool has a command that allows you train your flow from your terminal or from your CI processes. You can find a more detailed explanation here.

+ +

If you want to see the full usage of the cxcli flow command, please refer to this page.

+

If you want to learn more about Dialogflow CX flows, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/flows/train/index.html b/flows/train/index.html new file mode 100644 index 00000000..783bd20c --- /dev/null +++ b/flows/train/index.html @@ -0,0 +1,2856 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Train - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Train

+

Usage

+

You can find the train functionality within the cxcli flow train subcommand. You can read the documentation about this command here.

+

Example

+

Here is a simple example of the cxcli flow train command:

+
cxcli flow train my-flow --project-id test-cx-346408 --location-id us-central1 --agent-name test-agent
+
+

The above command will give you output similar to the following:

+
$ cxcli flow train my-flow --project-id test-cx-346408 --location-id us-central1 --agent-name test-agent
+INFO Flow trained
+
+
+

Is it taking longer than expected?

+

That is okay, depending on the amount of data to train it takes longer.

+
+ +

If you want to learn more about Dialogflow CX flow train execution, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/flows/update/index.html b/flows/update/index.html new file mode 100644 index 00000000..9a25c18e --- /dev/null +++ b/flows/update/index.html @@ -0,0 +1,2852 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Update - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Update

+

Usage

+

You can find the update functionality within the cxcli flow update subcommand. You can read the documentation about this command here.

+

Example

+

Here is a simple example of the cxcli flow update command:

+
cxcli flow update my-flow --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description "My updated test flow"
+
+

The above command will give you output similar to the following:

+
$ cxcli flow update my-flow --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description "My updated test flow"
+INFO Flow updated
+
+ +

If you want to learn more about Dialogflow CX flow update, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/flowversions/create/index.html b/flowversions/create/index.html new file mode 100644 index 00000000..b4c099ea --- /dev/null +++ b/flowversions/create/index.html @@ -0,0 +1,2856 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Create

+

Usage

+

You can find the create functionality within the cxcli flow-version create subcommand. You can read the documentation about this command here.

+

Example

+

Here is a simple example of using the cxcli flow-version create command:

+
cxcli flow-version create "v1.0.0" --start-flow "Test Flow" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description "My flow version"
+
+

The above command will give you output similar to the following:

+
$ cxcli flow-version create "v1.0.0" --start-flow "Test Flow" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description "My flow version"
+INFO Version created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/flows/b23e0247-2dd4-4d86-a23a-a289569480d4/versions/6
+
+
+

Is it taking longer than expected?

+

That is okay, depending on the size of the flow it takes longer.

+
+ +

If you want to learn more about Dialogflow CX flow version creation, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/flowversions/delete/index.html b/flowversions/delete/index.html new file mode 100644 index 00000000..efeca734 --- /dev/null +++ b/flowversions/delete/index.html @@ -0,0 +1,2852 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Delete

+

Usage

+

You can find the delete functionality within the cxcli flow-version delete subcommand. You can read the documentation about this command here.

+

Example

+

Here is a simple example of the cxcli flow-version delete command:

+
cxcli flow-version delete "v1.0.0" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+
+

The above command will give you output similar to the following:

+
$ cxcli flow-version delete "v1.0.0" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+INFO Version deleted
+
+ +

If you want to learn more about Dialogflow CX flow version deletion, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/flowversions/introduction/index.html b/flowversions/introduction/index.html new file mode 100644 index 00000000..3cbe6d8a --- /dev/null +++ b/flowversions/introduction/index.html @@ -0,0 +1,2891 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Introduction - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Flow Versions

+

What is this?

+

It is possible to generate various iterations of your agent flows and deploy them to distinct serving environments.

+

When making modifications to a flow, you are essentially modifying a draft version. At any given time, you have the option to save a draft flow as a flow version. A flow version represents an unchangeable snapshot of your flow data along with all the related agent data, such as intents, entities, webhooks, pages, route groups, and more.

+

Furthermore, You can deploy this flow versions to different environments, such as development, test, and production. You can also deploy the same flow version to multiple environments.

+

With cxcli, you can easily interact with the flow versions of your Dialogflow CX agents.

+

All of the commands that you have available in cxcli to interact with your flows are located within the cxcli flow-version subcommand.

+

Create

+

The cxcli has a command that allows you to create a flow versions. You can find a more detailed information here.

+

Update

+

The cxcli has a command that allows you to update a flow versions. You can find a more detailed information here.

+

Delete

+

The cxcli has a command that allows you to delete your flow versions. You can find a more detailed explanation here.

+ +

If you want to see the full usage of the cxcli flow-version command, please refer to this page.

+

If you want to learn more about Dialogflow CX flows, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/flowversions/update/index.html b/flowversions/update/index.html new file mode 100644 index 00000000..5b5e8141 --- /dev/null +++ b/flowversions/update/index.html @@ -0,0 +1,2852 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Update - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Update

+

Usage

+

You can find the update functionality within the cxcli flow-version update subcommand. You can read the documentation about this command here.

+

Example

+

Here is a simple example of the cxcli flow update command:

+
cxcli flow-version update "v1.0.0" --start-flow "Test Flow" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description "My updated flow version"
+
+

The above command will give you output similar to the following:

+
$ cxcli flow-version update "v1.0.0" --start-flow "Test Flow" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description "My updated flow version"
+INFO Version updated
+
+ +

If you want to learn more about Dialogflow CX flow version update, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/generators/create/index.html b/generators/create/index.html new file mode 100644 index 00000000..7572b7db --- /dev/null +++ b/generators/create/index.html @@ -0,0 +1,2856 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Create

+

Usage

+

You can find the create functionality within the cxcli generator create subcommand. You can read the documentation about this command here.

+

If you want to create a generator, you have to set the --prompt parameter. This parameter is the prompt that will be used to generate the responses. You can use placeholders in the prompt to pass parameters to the generator. The parameters can be extracted from the user's input, or from the agent's session parameters.

+

The placeholders have the following format: $parameter-name. For example: +

Give a warm welcome to the user with name $name
+

+

Example

+

Here is a simple example of using the cxcli generator create command:

+
cxcli generator create my-generator --prompt "Give a warm welcome to the user with name $name" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 
+
+

The above command will give you output similar to the following:

+
$ cxcli generator create my-generator --prompt "Give a warm welcome to the user with name $name" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 
+[INFO] Generator created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/generators/03b0a452-997c-40dc-afa2-6bef917d224f
+
+ +

If you want to learn more about Dialogflow CX generator creation, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/generators/delete/index.html b/generators/delete/index.html new file mode 100644 index 00000000..f4d6ee1a --- /dev/null +++ b/generators/delete/index.html @@ -0,0 +1,2852 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Delete

+

Usage

+

You can find the delete functionality within the cxcli generator delete subcommand. You can read the documentation about this command here.

+

Example

+

Here is a simple example of the cxcli generator delete command:

+
cxcli generator delete my-generator --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+
+

The above command will give you output similar to the following:

+
$ cxcli generator delete my-generator --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+INFO Generator deleted
+
+ +

If you want to learn more about Dialogflow CX generator deletion, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/generators/introduction/index.html b/generators/introduction/index.html new file mode 100644 index 00000000..4e81f7ef --- /dev/null +++ b/generators/introduction/index.html @@ -0,0 +1,2896 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Introduction - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Generators

+

What is this?

+

Generators use Google's latest generative large language models (LLMs), and prompts that you provide, to generate agent behavior and responses at runtime. The available models are provided by Vertex AI.

+

You can pass parameters to the generators using placeholders in the prompts. The parameters can be extracted from the user's input, or from the agent's session parameters.

+

This is an example of a generator prompt:

+
Give a warm welcome to the user
+
+

And this is an example of a generator prompt with a placeholder:

+
Give a warm welcome to the user with name $name
+
+

With cxcli, you can easily interact with the generators of your Dialogflow CX agents.

+

All of the commands that you have available in cxcli to interact with your generators are located within the cxcli generator subcommand.

+

Create

+

The cxcli has a command that allows you to create a generator. You can find a more detailed information here.

+

Update

+

The cxcli has a command that allows you to update a generator. You can find a more detailed information here.

+

Delete

+

The cxcli has a command that allows you to delete a generator. You can find a more detailed explanation here.

+ +

If you want to see the full usage of the cxcli generator command, please refer to this page.

+

If you want to learn more about Dialogflow CX generators, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/generators/update/index.html b/generators/update/index.html new file mode 100644 index 00000000..4332793e --- /dev/null +++ b/generators/update/index.html @@ -0,0 +1,2856 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Update - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Update

+

Usage

+

You can find the update functionality within the cxcli generator update subcommand. You can read the documentation about this command here.

+

If you want to update a generator, you have to set the --prompt parameter. This parameter is the prompt that will be used to generate the responses. You can use placeholders in the prompt to pass parameters to the generator. The parameters can be extracted from the user's input, or from the agent's session parameters.

+

The placeholders have the following format: $parameter-name. For example: +

Give a warm welcome to the user with name $name
+

+

Example

+

Here is a simple example of the cxcli generator update command:

+
cxcli generator update my-generator --prompt "Give a warm farewell to the user with name $name" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 
+
+

The above command will give you output similar to the following:

+
$ cxcli generator update my-generator --prompt "Give a warm farewell to the user with name $name" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 
+INFO Generator updated
+
+ +

If you want to learn more about Dialogflow CX generator update, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/images/cx_logo.png b/images/cx_logo.png new file mode 100644 index 00000000..4c746e42 Binary files /dev/null and b/images/cx_logo.png differ diff --git a/images/favicon.ico b/images/favicon.ico new file mode 100644 index 00000000..477a04cc Binary files /dev/null and b/images/favicon.ico differ diff --git a/images/flow.png b/images/flow.png new file mode 100644 index 00000000..76af9ff9 Binary files /dev/null and b/images/flow.png differ diff --git a/images/gopher.png b/images/gopher.png new file mode 100644 index 00000000..919af744 Binary files /dev/null and b/images/gopher.png differ diff --git a/images/logo.png b/images/logo.png new file mode 100644 index 00000000..f26dd356 Binary files /dev/null and b/images/logo.png differ diff --git a/images/logo_background.png b/images/logo_background.png new file mode 100644 index 00000000..3cb51f8b Binary files /dev/null and b/images/logo_background.png differ diff --git a/images/nlu.png b/images/nlu.png new file mode 100644 index 00000000..d280eb9f Binary files /dev/null and b/images/nlu.png differ diff --git a/images/stt.png b/images/stt.png new file mode 100644 index 00000000..7bc5afbb Binary files /dev/null and b/images/stt.png differ diff --git a/images/tts.png b/images/tts.png new file mode 100644 index 00000000..ad5f0d4e Binary files /dev/null and b/images/tts.png differ diff --git a/index.html b/index.html new file mode 100644 index 00000000..21ed0bdc --- /dev/null +++ b/index.html @@ -0,0 +1,2836 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Dialogflow CX CLI

+

+ CXCLI Logo +

+ +

cxcli is a command-line tool that helps Dialogflow CX users test their agents and interact with them in various ways. +It is useful for your day-to-day tasks or if you want to integrate it with your favorite CI tool.

+

This CLI also allows you to interact with the text-to-speech and speech-to text APIs in Google Cloud.

+

Get started

+ +

Got questions, comments or suggestions?

+

cxcli is developed by xavidop.

+

You can contact us via email at: dialogflowcxcli@gmail.com.

+

Follow @dialogflowcxcli on Twitter for updates and announcements.

+

Visit our links section for more information about staying connected with us.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/intents/create/index.html b/intents/create/index.html new file mode 100644 index 00000000..7c06b8de --- /dev/null +++ b/intents/create/index.html @@ -0,0 +1,2856 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Create

+

Usage

+

You can find the create functionality within the cxcli intent create subcommand. You can read the documentation about this command here.

+

The --training-phrases parameter is a list of the training phrases for this intent, comma separated. For the entities used in this intent, add @entity-type to the word in the training phrase. This is the format:

+
word@entity-type
+
+

An example training phrase with a entity: hello, hi how are you today@sys.date, morning!

+

Example

+

Here is a simple example of using the cxcli intent create command:

+
cxcli intent create test_intent --training-phrases "hello, hi how are you today@sys.date, morning"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+
+

The above command will give you output similar to the following:

+
$ cxcli intent create test_intent --training-phrases "hello, hi how are you today@sys.date, morning"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+INFO Intent created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/intents/a7870357-e942-43dd-99d2-4de8c81a3c09
+
+ +

If you want to learn more about Dialogflow CX intent creation, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/intents/delete/index.html b/intents/delete/index.html new file mode 100644 index 00000000..9c785e63 --- /dev/null +++ b/intents/delete/index.html @@ -0,0 +1,2852 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Delete

+

Usage

+

You can find the delete functionality within the cxcli intent delete subcommand. You can read the documentation about this command here.

+

Example

+

Here is a simple example of the cxcli intent delete command:

+
cxcli intent delete test_intent --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+
+

The above command will give you output similar to the following:

+
$ cxcli intent delete test_intent --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+INFO Intent deleted
+
+ +

If you want to learn more about Dialogflow CX intent deletion, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/intents/introduction/index.html b/intents/introduction/index.html new file mode 100644 index 00000000..73b325c0 --- /dev/null +++ b/intents/introduction/index.html @@ -0,0 +1,2898 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Introduction - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Intent

+

What is this?

+

Before we discuss intents, it is important to first understand what is natural language understanding (NLU). Natural language understanding is a subset of natural language processing (NLP). It helps a "machine" to be able to understand human language.

+

In Dialogflow CX, this is an important concept, since it will help predict the user's intention and allow us to act in a "smarter" way, and avoid the all-too-common default fallback intent: "I did not understand you, could you repeat?".

+

We refer to these intentions, proposals, or user requests that machine must classify as "intents". Each intent has training phrases. For example, the default welcome_intent intent can contain these three training phrases:

+
    +
  1. Hi
    2. +
  2. Hello
    3. +
  3. Whats up!
    4. +
+

As you can see in the example above, the purpose of the welcome_intent intent is to start a conversation when a user says any of these training phrases. An intent can have multiple entities.

+

Whenever you create, modify, or delete an intent, it is important to re-train your Dialogflow CX flows. This will re-train your NLU model. By doing this, your bot will "understand you", including your latest changes.

+

With cxcli, you can easily interact with your Dialogflow CX intents.

+

All of the commands that you have available in cxcli to interact with your intents are located within the cxcli intents subcommand.

+

Create

+

The cxcli has a command that allows you to create an intent. You can find a more detailed explanation here

+

Update

+

The cxcli has a command that allows you to update an intent. You can find a more detailed explanation here

+

Delete

+

The cxcli has a command that allows you to delete your intents. You can find a more detailed explanation here

+ +

If you want to see the full usage of the cxcli intents command, please refer to this page.

+

If you want to learn more about Dialogflow CX intents, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/intents/update/index.html b/intents/update/index.html new file mode 100644 index 00000000..d8d55f6e --- /dev/null +++ b/intents/update/index.html @@ -0,0 +1,2856 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Update - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Update

+

Usage

+

You can find the update functionality within the cxcli intent update subcommand. You can read the documentation about this command here.

+

The --training-phrases parameter is a list of the training phrases for this intent, comma separated. For the entities used in this intent, add @entity-type to the word in the training phrase. This is the format:

+
word@entity-type
+
+

An example training phrase with a entity: hello, hi how are you today@sys.date, morning!

+

Example

+

Here is a simple example of using the cxcli intent update command:

+
cxcli intent update test_intent --training-phrases "hello, hi how are you today@sys.date, morning"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+
+

The above command will give you output similar to the following:

+
$ cxcli intent update test_intent --training-phrases "hello, hi how are you today@sys.date, morning"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+INFO Intent updated
+
+ +

If you want to learn more about Dialogflow CX intent update, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/links/index.html b/links/index.html new file mode 100644 index 00000000..b6990802 --- /dev/null +++ b/links/index.html @@ -0,0 +1,2761 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + Links - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+ +
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/nluprofiler/examples/audio/index.html b/nluprofiler/examples/audio/index.html new file mode 100644 index 00000000..36dd7a25 --- /dev/null +++ b/nluprofiler/examples/audio/index.html @@ -0,0 +1,2853 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Audio input - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Audio input

+

Suite file

+
# suite.yaml
+
+name: Example Suite
+description: Suite used as an example
+projectId: test-cx-346408
+locationId: us-central1
+agentName: test-agent
+tests:
+  - id: test_id
+    file: ./test.yaml
+
+

Test file

+
# test.yaml
+
+name: Example test
+description: These are some tests
+localeId: en
+checks:
+  - id: my_check
+    input: 
+      type: audio
+      audio: ./audio/hi.mp3
+    validate:
+      intent: hi_intent
+
+

You can download the audio file used in this example here

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/nluprofiler/examples/index.html b/nluprofiler/examples/index.html new file mode 100644 index 00000000..cc1f0317 --- /dev/null +++ b/nluprofiler/examples/index.html @@ -0,0 +1,2795 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Examples - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Examples

+

Simple

+

Simple example that demonstrates the NLU Profiler in action. Find it here

+

System entity detection

+

Example that shows how to validate Dialogflow CX built-in entities. Find it here

+

Text input with entities

+

Full example with multiple user-defined entities and Dialogflow CX built-in entities. Find it here

+

Prompt

+

Example that shows how to use a prompt as an user input Dialogflow CX. Find it here

+

Audio input

+

Example using an audio file as an input. Find it here

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/nluprofiler/examples/prompt/index.html b/nluprofiler/examples/prompt/index.html new file mode 100644 index 00000000..13fda80a --- /dev/null +++ b/nluprofiler/examples/prompt/index.html @@ -0,0 +1,2859 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Prompt - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Prompt example

+

Suite file

+
# suite.yaml
+
+name: Example Suite
+description: Suite used as an example
+projectId: test-cx-346408
+locationId: us-central1
+agentName: test-agent
+tests:
+  - id: test_id
+    file: ./test.yaml
+
+

Test file

+
# test.yaml
+
+name: Example test
+description: These are some tests
+localeId: en
+checks:
+  - id: my_first_check
+    input: 
+      type: prompt
+      prompt: give me a one line hello without exclamation mark using only 2 characters and lowercase
+    validate:
+      intent: hi_intent
+
+  - id: my_second_check
+    input: 
+      type: text
+      text: hello
+    validate:
+      intent: hi_intent
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/nluprofiler/examples/simple/index.html b/nluprofiler/examples/simple/index.html new file mode 100644 index 00000000..d0e570e3 --- /dev/null +++ b/nluprofiler/examples/simple/index.html @@ -0,0 +1,2859 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Simple - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Simple example

+

Suite file

+
# suite.yaml
+
+name: Example Suite
+description: Suite used as an example
+projectId: test-cx-346408
+locationId: us-central1
+agentName: test-agent
+tests:
+  - id: test_id
+    file: ./test.yaml
+
+

Test file

+
# test.yaml
+
+name: Example test
+description: These are some tests
+localeId: en
+checks:
+  - id: my_first_check
+    input: 
+      type: text
+      text: hi
+    validate:
+      intent: hi_intent
+
+  - id: my_second_check
+    input: 
+      type: text
+      text: hello
+    validate:
+      intent: hi_intent
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/nluprofiler/examples/system/index.html b/nluprofiler/examples/system/index.html new file mode 100644 index 00000000..d8d6d205 --- /dev/null +++ b/nluprofiler/examples/system/index.html @@ -0,0 +1,2855 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + System entities detection - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

System entity detection example

+

Suite file

+
# suite.yaml
+
+name: Example Suite
+description: Suite used as an example
+projectId: test-cx-346408
+locationId: us-central1
+agentName: test-agent
+tests:
+  - id: test_id
+    file: ./test.yaml
+
+

Test file

+
# test.yaml
+
+name: Example test
+description: These are some tests
+localeId: en
+checks:
+  - id: my_check
+    input: 
+      type: text
+      text: please, give me 3
+    validate:
+      intent: finish_order_intent
+      parameters:
+        - parameter: number
+          value: 3
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/nluprofiler/examples/text/index.html b/nluprofiler/examples/text/index.html new file mode 100644 index 00000000..8e4fb5e5 --- /dev/null +++ b/nluprofiler/examples/text/index.html @@ -0,0 +1,2869 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Text input with entities - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Text input with parameters example

+

Suite file

+
# suite.yaml
+
+name: Example Suite
+description: Suite used as an example
+projectId: test-cx-346408
+locationId: us-central1
+agentName: test-agent
+tests:
+  - id: test_id
+    file: ./test.yaml
+
+

Test file

+
# test.yaml
+
+name: Example test
+description: These are some tests
+localeId: en
+checks:
+  - id: my_first_check
+    input: 
+      type: text
+      text: I want 3 pizzas
+    validate:
+      intent: order_intent
+      parameters:
+        - parameter: number
+          value: 3
+        - parameter: order_type
+          value: pizza
+
+  - id: my_second_check
+    input: 
+      type: text
+      text: I want 2 cokes
+    validate:
+      intent: order_intent
+      parameters:
+        - parameter: number
+          value: 2
+        - parameter: order_type
+          value: coke
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/nluprofiler/introduction/index.html b/nluprofiler/introduction/index.html new file mode 100644 index 00000000..0112f12c --- /dev/null +++ b/nluprofiler/introduction/index.html @@ -0,0 +1,2904 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Introduction - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

NLU profiler

+

What is this?

+

+ Flow +

+ +

Use the NLU Profiler to test user utterances and improve your agent's interaction model.

+

With the NLU Profiler, you can see how utterances resolve to intents and slots in your interaction model. When an utterance doesn't resolve to the right intent or slot, you can update the interaction model and try again. With the cxcli, you can see which intents Dialogflow CX considered and discarded. Then, you can determine how to use additional samples to train your model to resolve utterances to their desired intents and slots.

+

Every suite is executed in the Dialogflow CX session so you can test not only your NLU but also a conversation itself.

+

All of the commands that are available in cxcli to execute the NLU profiler are located within the cxcli profile-nlu subcommand.

+

Reference

+

It is important to know which suites and tests you can build. Because of that, you can find the entire reference on the Reference page. Suites and test are defined as yaml files.

+

The cxcli has a command that allows you to run these suites from your terminal or from your CI pipelines.

+

To execute a suite, you can run the cxcli profile-nlu execute command. For the usage, please refer to this page.

+

Examples

+

You can find some useful examples on our GitHub repo and the Examples page.

+

Execution Example

+

Here is a simple example of the cxcli profile-nlu execute command:

+
cxcli profile-nlu execute examples/profilenlu/suite.yaml
+
+

The above command will give you output similar to the following:

+
$ cxcli profile-nlu execute suite.yaml
+[INFO] Running suite: Example NLU Profiler Suite
+[INFO][test-file:test_1][check:test_1_1][input:prompt] User> hi (auto-generated from prompt: "give me a one line hello without exclamation mark using only 2 characters and lowercase")
+[INFO][test-file:test_1][check:test_1_1][input:prompt] Agent> Hi! How are you doing?
+[INFO][test-file:test_1][check:test_1_1][validation:hi_intent] Intent Detected: hi_intent
+[INFO][test-file:test_1][check:test_1_2][input:text] User> hello
+[INFO][test-file:test_1][check:test_1_2][input:text] Agent> Hi! How are you doing?
+[INFO][test-file:test_1][check:test_1_2][validation:hi_intent] Intent Detected: hi_intent
+[INFO][test-file:test_1][check:test_1_3][input:audio] User> ./audio/hi.mp3
+[INFO][test-file:test_1][check:test_1_3][input:audio] Agent> Hi! How are you doing?
+[INFO][test-file:test_1][check:test_1_3][validation:hi_intent] Intent Detected: hi_intent
+[INFO][test-file:test_2][check:test_2_1][input:text] User> I want 3 pizzas
+[INFO][test-file:test_2][check:test_2_1][input:text] Agent> 
+[INFO][test-file:test_2][check:test_2_1][validation:order_intent] Intent Detected: order_intent
+[INFO][test-file:test_2][check:test_2_1][validation:order_intent] Param order_type: pizza 
+[INFO][test-file:test_2][check:test_2_1][validation:order_intent] Param number: 3 
+[INFO][test-file:test_2][check:test_2_2][input:text] User> I want 2 cokes
+[INFO][test-file:test_2][check:test_2_2][input:text] Agent> 
+[INFO][test-file:test_2][check:test_2_2][validation:order_intent] Intent Detected: order_intent
+[INFO][test-file:test_2][check:test_2_2][validation:order_intent] Param number: 2 
+[INFO][test-file:test_2][check:test_2_2][validation:order_intent] Param order_type: coke 
+
+
+

Are you running this command in a CI/CD pipeline?

+

If this is the case, we recommend that you set the --output-format parameter to json.

+
+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/nluprofiler/suites/index.html b/nluprofiler/suites/index.html new file mode 100644 index 00000000..355388e3 --- /dev/null +++ b/nluprofiler/suites/index.html @@ -0,0 +1,2857 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Suites - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Suites

+

Reference

+

A suite is a yaml file with the following structure:

+
# suite.yaml
+
+# Name of the suite.
+name: Example Suite
+# Brief description of the suite.
+description: Suite used as an example
+# Project ID on Google Cloud where is located your Dialogflow CX agent.
+projectId: test-cx-346408
+# Location where your Dialogflow CX agent is running. 
+# More info here: https://cloud.google.com/dialogflow/cx/docs/concept/region
+locationId: us-central1
+# Agent name of your Dialogflow CX agent.
+# Notice: it is the agent name, not the agent ID.
+agentName: test-agent
+# You can have multiple tests defined in separated files
+tests:
+  # ID of the test.
+  - id: test_id
+    # File where the test specification is located
+    file: ./test.yaml
+
+

It has the same structure as the Conversation Profiler suite.

+

JSON Schema

+

cxcli also has a jsonschema file, which you can use to have better +editor support:

+
https://cxcli.xavidop.me/static/nlusuite.json
+
+

You can also specify it in your yml config files by adding a +comment like the following: +

# yaml-language-server: $schema=https://cxcli.xavidop.me/static/nlusuite.json
+

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/nluprofiler/tests/index.html b/nluprofiler/tests/index.html new file mode 100644 index 00000000..59e317ae --- /dev/null +++ b/nluprofiler/tests/index.html @@ -0,0 +1,3050 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Tests - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Tests

+

Reference

+

A test is a yaml file with the following structure:

+
# test.yaml
+
+# Name of the test.
+name: Example test
+# Brief description of the test.
+description: These are some tests
+# Locale of the interaction model that is gonna be tested.
+# You can find the locales here: https://cloud.google.com/dialogflow/cx/docs/reference/language
+localeId: en
+# A check is the test itself: given an input, you will validate the intents and the parameters/entities detected by Dialogflow CX
+# You can have multiple checks defined
+checks:
+  # The ID of the check
+  - id: test
+    input:
+      # the input type
+      # it could be text or audio
+      type: text
+      # The input itself in text format. For type: audio, you have to specify the audio file.
+      text: I want 3 pizzas
+    validate:
+      # Intent that is supposed to be detected
+      intent: order_intent
+      # You can have multiple parameters/intents
+      # Notice: this could be empty if your intent does not have any entities/parameters.
+      parameters:
+        # Entity name that is supposed to be detected
+        - parameter: number
+          # Value that is supposed to be detected
+          value: 3
+
+

Input types

+

Text input

+

The input text is the simplest one. You just have to specify the text you want to send to Dialogflow CX. Make sure that the text is in the language you specified in the localeId field. to use this type you have to set the type field to text and the text field to the text you want to send.

+

Audio input

+

The audio input is a little bit more complex. You have to specify the path to the audio file you want to send to Dialogflow CX. Make sure that the audio file is in the language you specified in the localeId field. To use this type you have to set the type field to audio and the file field to the path to the audio file.

+

It is important to know that the input audio needs to have the following format:

+
    +
  1. A sample rate of 16000 Hertz
    2. +
  2. The audio encoding has to be Linear16. Linear16 is a 16-bit linear pulse-code modulation (PCM) encoding.
    3. +
+

If you don't have a file with this format, you can create it by yourself using the cxcli tts command! All the information is located here

+

Prompt input

+

The prompt input is the most complex one. You have to specify the input prompt you want to send to Dialogflow CX. To use this type you have to set the type field to prompt and the prompt field to the prompt you want to send.

+

It is important to know that the input prompt needs Vertex AI API to be enabled in your project and the proper permissions granted. You can find more information on the Authentication page.

+

Validation types

+

Intent validation

+

The intent validation is the simplest one. You just have to specify the intent you want to validate. To use this type you have to set the intent field to the intent you want to validate:

+
validate:
+  # Intent that is supposed to be detected
+  intent: order_intent
+
+

Parameter validation

+

The parameter validation is a little bit more complex. You have to specify the parameters you want to validate and the values that are supposed to be detected. To use this type you have to set a list wit of parameters and each value must have the parameter field to the parameter you want to validate and the value field to the value that is supposed to be detected:

+
validate:
+  # Intent that is supposed to be detected
+  intent: order_intent
+  # You can have multiple parameters/intents
+  # Notice: this could be empty if your intent does not have any entities/parameters.
+  parameters:
+    # Entity name that is supposed to be detected
+    - parameter: number
+      # Value that is supposed to be detected
+      value: 3
+
+

JSON Schema

+

cxcli also has a jsonschema file, which you can use to have better +editor support:

+
https://cxcli.xavidop.me/static/nlutest.json
+
+

You can also specify it in your yml config files by adding a +comment like the following: +

# yaml-language-server: $schema=https://cxcli.xavidop.me/static/nlutest.json
+

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/overview/authentication/index.html b/overview/authentication/index.html new file mode 100644 index 00000000..15bb5585 --- /dev/null +++ b/overview/authentication/index.html @@ -0,0 +1,2954 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Authentication - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Authentication

+

cxcli uses various Google Cloud APIs. By default, the tool uses the default configuration that uses the gcloud cli. If you want to use another authentication key you can provide a json file with the global --credentials parameter.

+

The cxcli source code is open source, you can check it out here to learn more about the actions the tool performs.

+

Below you can find the roles and the APIs that are required to use this tool.

+

Roles needed

+

Dialogflow CX

+

Dialogflow API Admin: Provides full access to create, update, query, detect intent, and delete the agent from the console or API. Click here for more information.

+

We are using the Admin role because cxcli performs the List agent action.

+

This role allows you to execute Speech-to-text and Text-to-speech actions

+

APIs enabled needed

+

The following APIs should be enabled on your Google Cloud project if you want to use the respective cxcli capabilities:

+

Dialogflow CX

+

You will need to enable the Dialogflow API on your project. More information here

+

Speech-to-text

+

You will need to enable the Cloud Speech-to-Text API on your project. More information here

+

Text-to-speech

+

You will need to enable the Cloud Text-to-Speech API on your project. More information here

+

Generative AI on Vertex AI

+

You will need to enable the Vertex AI API on your project. More information here

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/overview/faq/index.html b/overview/faq/index.html new file mode 100644 index 00000000..f36e2ad2 --- /dev/null +++ b/overview/faq/index.html @@ -0,0 +1,3036 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + FAQ - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Frequently Asked Questions (FAQ)

+

How does it work?

+

cxcli has three main purposes:

+
    +
  1. Make the interaction with your Dialogflow CX agents from your laptop or your continuous integration pipelines easier than ever
    2. +
  2. Create testing tools that will help users build their Dialogflow CX agent
    3. +
  3. Interact with other Google Cloud APIs such as TTS and STT in a very easy way
    4. +
+

Who is cxcli for?

+

cxcli is primarily for software engineering teams who are currently using Dialogflow CX. It is recommended for machine learning engineers that usually work with STT, TTS, NLU and NLP technologies.

+

What kind of machines/containers do I need for the cxcli?

+

You'll need either: a bare-metal host (your own, AWS i3.metal or Equinix Metal) or a VM that supports nested virtualisation such as those provided by Google Cloud, Azure, AWS DigitalOcean, etc. or a Linux or Windows container.

+

When will Jenkins, GitLab CI, BitBucket Pipeline Runners, Drone or Azure DevOps be supported?

+

For the current phase, we're targeting GitHub Actions because it has fine-grained access controls and the ability to schedule exactly one build to a runner. The other CI systems will be available soon.

+

That said, if you're using these tools within your organisation, we'd like to hear from you. +So feel free to reach out to us if you feel cxcli would be a good fit for your team.

+

Feel free to contact us at: dialogflowcxcli@gmail.com

+

What kind of access is required in my Google Cloud project?

+

Refer to the Authentication page here

+

Can cxcli be used on public repos?

+

Yes, cxcli can be used on public and private repos.

+

What's in the Container image and how is it built?

+

The Container image contains uses alpine:latest and the cxcli installed on it.

+

The image is built automatically using GitHub Actions and is available on a container registry.

+

Is ARM64 supported?

+

Yes, cxcli is built to run on both Intel/AMD and ARM64 hosts. This includes a Raspberry Pi 4B, AWS Graviton, Oracle Cloud ARM instances and potentially any other ARM64 instances that support virtualisation.

+

Are Windows or macOS supported?

+

Yes, in addition to Linux, Windows and macOS are also supported platforms for cxcli at this time on a AMD64 or ARM64 architecture.

+

Is cxcli free and open-source?

+

cxcli is an open source tool, however, it interacts with Google Cloud APIs, so a Google Cloud account is required.

+

The website and documentation are available on GitHub and we plan to release some open source tools in the future for cxcli customers.

+

Is there a risk that we could get "locked-in" to cxcli?

+

No, you can switch back to using either the gcloud CLI tool or the Google Cloud APIs at any time. Keep in mind that cxcli not only solves for a certain set of issues with both of those approaches but also simplifies the interaction with Google Cloud.

+

Why is the brand called "cxcli" and "Dialogflow CX CLI" ?

+

The name of the software is cxcli, in some places "cxcli" is not available, and we liked "Dialogflow CX CLI" because it refers to the what the tool does.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/overview/install/index.html b/overview/install/index.html new file mode 100644 index 00000000..51be6c0b --- /dev/null +++ b/overview/install/index.html @@ -0,0 +1,3334 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Install - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Install

+

You can use cxcli by installing a pre-compiled binary (in several ways), using Docker, or compiling it from source. In the below sections, you can find the steps for each approach.

+

Install a pre-compiled binary

+

homebrew tap

+
    +
  1. Add the Homebrew tap: +
    brew tap xavidop/tap git@github.com:xavidop/homebrew-tap.git
+brew update
+
    2. +
  2. Install the Dialogflow CX CLI: +
    brew install cxcli
+
    3. +
+

snapcraft

+
sudo snap install cxcli
+
+

scoop

+
scoop bucket add cxcli https://github.com/xavidop/scoop-bucket.git
+scoop install cxcli
+
+

apt

+
echo 'deb [trusted=yes] https://apt.fury.io/xavidop/ /' | sudo tee /etc/apt/sources.list.d/cxcli.list
+sudo apt update
+sudo apt install cxcli
+
+

yum

+
echo '[cxcli]
+name=Dialogflow CX CLI Repo
+baseurl=https://yum.fury.io/xavidop/
+enabled=1
+gpgcheck=0' | sudo tee /etc/yum.repos.d/cxcli.repo
+sudo yum install cxcli
+
+

aur

+
yay -S cxcli-bin
+
+

nix

+

nixpkgs

+
nix-env -iA cxcli
+
+
+

Info

+

The package in nixpkgs +might be slightly outdated, as it is not updated automatically. +Use our NUR to always get the latest updates.

+
+

nur

+

First, you'll need to add our NUR to your nix configuration. +You can follow the guides +here.

+

Once you do that, you can install the packages.

+
{ pkgs, lib, ... }: {
+    home.packages = with pkgs; [
+    nur.repos.xavidop.cxcli
+    ];
+}
+
+

deb, rpm and apk packages

+

Download the .deb, .rpm or .apk packages from the OSS releases page and install them with the appropriate tools.

+

go install

+
go install github.com/xavidop/dialogflow-cx-cli@latest
+
+

bash script

+
curl -sfL https://cxcli.xavidop.me/static/run | bash
+
+

Additional Options

+

You can also set the VERSION variable to specify +a version instead of using latest.

+

You can also pass flags and args to cxcli:

+
curl -sfL https://cxcli.xavidop.me/static/run |
+    VERSION=__VERSION__ bash -s -- version
+
+
+

Tip

+

This script does not install anything, it just downloads, verifies and +runs cxcli. +Its purpose is to be used within scripts and CIs.

+
+

manually

+

Download the pre-compiled binaries from the releases page and copy them to the desired location.

+

Verifying the artifacts

+

binaries

+

All artifacts are checksummed, and the checksum file is signed with cosign.

+
    +
  1. Download the files you want along with the checksums.txt, checksum.txt.pem, and checksums.txt.sig files from the releases page: + 
    wget https://github.com/xavidop/dialogflow-cx-cli/releases/download/__VERSION__/checksums.txt
+wget https://github.com/xavidop/dialogflow-cx-cli/releases/download/__VERSION__/checksums.txt.sig
+wget https://github.com/xavidop/dialogflow-cx-cli/releases/download/__VERSION__/checksums.txt.pem
+
    2. +
  2. Verify the signature: + 
    COSIGN_EXPERIMENTAL=1 cosign verify-blob \
+--cert checksums.txt.pem \
+--signature checksums.txt.sig \
+checksums.txt
+
    3. +
  3. If the signature is valid, you can then verify the SHA256 sums match with the downloaded binary: + 
    sha256sum --ignore-missing -c checksums.txt
+
    4. +
+

docker images

+

Our Docker images are signed with cosign.

+

Verify the signatures:

+
COSIGN_EXPERIMENTAL=1 cosign verify xavidop/cxcli
+
+
+

Info

+

The .pem and .sig files are the image name:tag, replacing / and : with -.

+
+

Running with Docker

+

You can also use cxcli within a Docker container. +To do that, you'll need to execute something more-or-less like the examples below.

+

Registries:

+ +

Example usage:

+
docker run --rm \
+    xavidop/cxcli cxcli version
+
+

Note that the image will almost always have the last stable Go version.

+

If you need other packages and dependencies, you are encouraged to keep your own image. You can +always use cxcli's own Dockerfile as a starting point and iterate on that.

+

Compiling from source

+

Here you have two options:

+

If you want to contribute to the project, please follow the +steps on our contributing guide.

+

If you just want to build from source for whatever reason, follow these steps:

+

clone:

+
git clone https://github.com/xavidop/dialogflow-cx-cli
+cd dialogflow-cx-cli
+
+

get the dependencies:

+
go mod tidy
+
+

build:

+
go build -o cxcli .
+
+

verify that it works:

+
./cxcli version
+
+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/overview/roadmap/index.html b/overview/roadmap/index.html new file mode 100644 index 00000000..4a87d30b --- /dev/null +++ b/overview/roadmap/index.html @@ -0,0 +1,2772 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Roadmap - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Roadmap

+

cxcli is in active development. The core product is functioning.

+

Our goal with the tool is to prove that there's market fit for a solution like this, and if so, we'll invest more time in automation, user experience, more features.

+

For now, if you're interested in participating and giving feedback, we believe cxcli already solves pain at this stage.

+

Shipped:

+
    +
  • Available in homebrew, snapcraft, apt, yum, scoop, aur package managers
    • +
  • Documentation updated
    • +
  • Profile NLU
    • +
  • Speech-to-text and Text-to-speech actions
    • +
  • Container image available for multiple architectures
    • +
  • SBOM files created
    • +
  • Artifacts uploaded, signed and available on GitHub
    • +
+

Coming soon:

+
    +
  • Continuous integration support (GitHub Action, CircleCI, etc.)
    • +
  • Flow import and export
    • +
  • Dialog from the terminal
    • +
  • More Agent actions (validate)
    • +
  • Pages Action (crate, update, delete)
    • +
  • Test Cases actions (export, import, run, run-all)
    • +
  • Changelog actions (show)
    • +
  • Experiment Actions - TBD
    • +
+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/search/search_index.json b/search/search_index.json new file mode 100644 index 00000000..3db77989 --- /dev/null +++ b/search/search_index.json @@ -0,0 +1 @@ +{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Dialogflow CX CLI","text":"

cxcli is a command-line tool that helps Dialogflow CX users test their agents and interact with them in various ways. It is useful for your day-to-day tasks or if you want to integrate it with your favorite CI tool.

This CLI also allows you to interact with the text-to-speech and speech-to text APIs in Google Cloud.

"},{"location":"#get-started","title":"Get started","text":"
  • How to install the tool
  • Authentication
  • Read the FAQ
"},{"location":"#got-questions-comments-or-suggestions","title":"Got questions, comments or suggestions?","text":"

cxcli is developed by xavidop.

You can contact us via email at: dialogflowcxcli@gmail.com.

Follow @dialogflowcxcli on Twitter for updates and announcements.

Visit our links section for more information about staying connected with us.

"},{"location":"ci/","title":"CI","text":"

TBD

"},{"location":"dialog/","title":"Interactive Dialog","text":"

The cxcli tool has command that allows you to interactively play with your agent from your terminal!

"},{"location":"dialog/#usage","title":"Usage","text":"

You can find the dialog functionality within the cxcli dialog subcommand. You can read the documentation about this command here.

"},{"location":"dialog/#parameters","title":"Parameters","text":"

These are the relevant parameters that you can use to interact with your agent interactively from your terminal:

  1. locale: this parameter accepts all of the locales that are available in Dialogflow CX.
"},{"location":"dialog/#example","title":"Example","text":"

Here is a simple example of the cxcli dialog command:

cxcli dialog --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\n

The above command will give you output similar to the following:

$ cxcli dialog --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\nINFO Please press Ctrl+C whenever you want to stop the interaction. \nUser> hi\nAgent> Hi, this is Information Finder. Which product information do you need?\nUser> sorry, can you repeat\nAgent> I didn't get that.\nAgent> Hi, I am a chatbot that can help you find information about CorpX products: Intelligent Customer Insight, Order Fulfillment, Order Handling, Order Management Suite, Sales Engine, or Supercharge.\nAgent> Do you want to continue looking up information for one of these products? Say yes or no.\nUser> no\nAgent> Goodbye\n

Important

Once the session is finished, you will get the terminal prompt again.

"},{"location":"links/","title":"Links","text":"
  • Follow our progress on the GitHub repository
  • Follow us on Twitter and Mastodon for updates
  • Join our Discord server
  • Read my blog
  • Sign up for my newsletter
  • For questions, support and general discussion, please use Discord or GitHub Discussions
  • Contributing Guidelines
  • Security Policy

This project adheres to the Contributor Covenant code of conduct. By participating, you are expected to uphold this code.

"},{"location":"security/","title":"Security Policy","text":""},{"location":"security/#supported-versions","title":"Supported Versions","text":"

Only the last stable version at any given point.

"},{"location":"security/#reporting-a-vulnerability","title":"Reporting a Vulnerability","text":"

Vulnerabilities can be disclosed via email to dialogflowcxcli@gmail.com

"},{"location":"stt/","title":"Speech-to-text","text":"

The cxcli tool has various commands that allow you to interact with Google Cloud's Speech to Text service using the Cloud Speech-to-text API!

Is this your first time using this feature?

Before you start using this functionality, please, read the authentication page.

"},{"location":"stt/#usage","title":"Usage","text":"

You can find the speech-to-text functionality within the cxcli stt subcommand. You can read the documentation about this command here.

The cxcli stt command has a recognize subcommand. You can find the usage of this command here.

"},{"location":"stt/#parameters","title":"Parameters","text":"

These are the relevant parameters that you can use to interact with Google Cloud STT:

  1. locale: this parameter accepts all of the locales that are available in the Google Cloud Speech-to-text API. You can find all the locales available here.
"},{"location":"stt/#audio-input-file","title":"Audio input file","text":"

It is important to know that the input audio needs to be in the following format:

  1. A sample rate of 16000 Hertz
  2. The audio encoding has to be Linear16. Linear16 is a 16-bit linear pulse-code modulation (PCM) encoding.

If you don't have a file with this format, you can create it by yourself using the cxcli tts command! All of the relevant information is located here.

"},{"location":"stt/#example","title":"Example","text":"

Here is a simple example of the cxcli stt recognize command:

cxcli stt recognize hi.mp3  --locale en-US\n

The above command will give you output similar to the following:

$ cxcli stt recognize hi.mp3 --locale en-US --verbose\nINFO Duration time: 570 miliseconds\nINFO Detections: 1\nINFO 1. Text detected: hi\nINFO 1. Confidence: 79.276474%\n

Are you running this command in a CI/CD pipeline?

If this is the case, we recommend that you set the --output-format parameter to json.

"},{"location":"troubleshooting/","title":"Troubleshooting","text":""},{"location":"troubleshooting/#getting-support","title":"Getting support","text":"

All users have access to a public Discord server for support and collaboration. Refer to the links page for more information.

"},{"location":"troubleshooting/#project-not-found","title":"Project not found","text":"

Make sure that you have configured either the gcloud CLI or the authentication json file properly. You can find more information on the Authentication page.

"},{"location":"troubleshooting/#you-need-to-enable-the-dialogflow-api","title":"You need to enable the Dialogflow API","text":"

You need to enable the Dialogflow API in your Google Cloud project if you want to interact with cxcli. Make sure you have the permissions needed for the tool. You can find more information on the Authentication page.

"},{"location":"troubleshooting/#you-need-to-enable-the-cloud-speech-to-text-api","title":"You need to enable the Cloud Speech-to-text API","text":"

You need to enable the Cloud Speech-to-text API in your Google Cloud project if you want to run the cxcli stt commands. You can find more information on the Authentication page.

"},{"location":"troubleshooting/#you-need-to-enable-the-cloud-text-to-speech-api","title":"You need to enable the Cloud Text-to-speech API","text":"

You need to enable the Cloud Text-to-speech API in your Google Cloud project if you want to run the cxcli tts commands. You can find more information on the Authentication page.

"},{"location":"tts/","title":"Text-to-speech","text":"

The cxcli tool has various commands that allow you to interact with Google Cloud's Text to Speech service using the Cloud Text-to-Speech API!

Is this your first time using this feature?

Before you start using this functionality, please, read the authentication page.

"},{"location":"tts/#usage","title":"Usage","text":"

You can find the text-to-speech functionality within the cxcli tts subcommand. You can read the documentation about this command here.

The cxcli tts command has a synthesize subcommand. You can find the usage of this command here.

"},{"location":"tts/#parameters","title":"Parameters","text":"

These are the relevant parameters that you can use to interact with Google Cloud TTS:

  1. locale: this parameter accepts all of the locales that are available in the Google Cloud Text-to-speech API. You can find all the locales available here.
  2. output-file: MP3 audio file where we are going to output the synthesized text.
"},{"location":"tts/#output","title":"Output","text":"

It is important to know that the output audio will have the following format:

  1. A sample rate of 16000 Hertz
  2. The audio encoding will be Linear16. Linear16 is a 16-bit linear pulse-code modulation (PCM) encoding.
"},{"location":"tts/#example","title":"Example","text":"

Here is a simple example of the cxcli tts synthesize command:

cxcli tts synthesize hi --locale en-US --output-file hi.mp3\n

The above command will give you an audio file similar to the following:

Your browser does not support the audio element.

You can download the audio file here.

"},{"location":"agents/create/","title":"Create","text":""},{"location":"agents/create/#usage","title":"Usage","text":"

You can find the create functionality within the cxcli agent create subcommand. You can read the documentation about this command here.

The argument to --timezone is a value from the IANA time zone database. This is an example: 

America/New_York\nEurope/Madrid\n

"},{"location":"agents/create/#example","title":"Example","text":"

Here is a simple example of the cxcli agent create command:

cxcli agent create test-agent --project-id test-cx-346408 --location-id us-central1 --locale en --timezone Europe/Madrid\n

The above command will give you output similar to the following:

$ cxcli agent create test-agent --project-id test-cx-346408 --location-id us-central1 --locale en --timezone Europe/Madrid\nINFO Agent created with id: projects/test-cx-346408/locations/us-central1/agents/e2ae2503-f38c-46a1-a3bf-22e57617baf0\n
"},{"location":"agents/create/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX Agent creation, refer to the official documentation.

"},{"location":"agents/delete/","title":"Delete","text":""},{"location":"agents/delete/#usage","title":"Usage","text":"

You can find the delete functionality within the cxcli agent delete subcommand. You can read the documentation about this command here.

"},{"location":"agents/delete/#example","title":"Example","text":"

Here is a simple example of the cxcli agent delete command:

cxcli agent delete test-agent --project-id test-cx-346408 --location-id us-central1\n

The above command will give you output similar to the following:

$ cxcli agent delete test-agent --project-id test-cx-346408 --location-id us-central1\nINFO Agent deleted\n
"},{"location":"agents/delete/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX Agent deletion, refer to the official documentation.

"},{"location":"agents/export/","title":"Export","text":""},{"location":"agents/export/#usage","title":"Usage","text":"

You can find the export functionality within the cxcli agent export subcommand. You can read the documentation about this command here.

Exported file format

You can export your agent in blob or json format. When you choose json format, the output file is going to be a zip file.

"},{"location":"agents/export/#example","title":"Example","text":"

Here is a simple example of the cxcli agent export command:

cxcli agent export test-agent --project-id test-cx-346408 --location-id us-central1 --export-format blob\n

The above command will give you output similar to the following:

$ cxcli agent export test-agent --project-id test-cx-346408 --location-id us-central1 --export-format json --output-file agent.zip\nINFO Agent exported to file: agent.zip\n

are you running this command in a CI/CD pipeline?

If this is the case, we recommend that you set the --output-format parameter to json.

"},{"location":"agents/export/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX exports, refer to the official documentation.

"},{"location":"agents/introduction/","title":"Agents","text":""},{"location":"agents/introduction/#what-is-this","title":"What is this?","text":"

An agent in Dialogflow CX is the entity that handles all the conversations that we have defined on the Dialogflow CX console with the end users.

An agent is basically an assistant that will manage the state of each user's conversation when the end users are interacting with the agent through text or audio in multiple channels.

With cxcli, you can easily interact with your Dialogflow CX agents.

All of the commands that are available in cxcli to interact with your agents are located within the cxcli agent subcommand.

"},{"location":"agents/introduction/#create","title":"Create","text":"

You can create an agent using this tool.

The cxcli has a command that allows you to create an agent. You can find a more detailed explanation here

"},{"location":"agents/introduction/#update","title":"Update","text":"

You can update an agent using this cli.

The cxcli has a command that allows you to update an agent. You can find a more detailed explanation here

"},{"location":"agents/introduction/#delete","title":"Delete","text":"

The cxcli has a command that allows you to delete your agent. You can find a more detailed explanation here

"},{"location":"agents/introduction/#restore","title":"Restore","text":"

You can restore an agent using a blob or a json-package file. Right now the Dialogflow CX API, used by the cxcli, works with the blob and json format.

The cxcli has a command that allows you to restore an agent. You can find a more detailed explanation here

"},{"location":"agents/introduction/#export","title":"Export","text":"

An agent can be exported as a blob or a json-package file. Right now the Dialogflow CX API, used by the cxcli, works with the blob and json format.

The cxcli has a command that allows you to export your agent. You can find a more detailed explanation here

"},{"location":"agents/introduction/#useful-links","title":"Useful Links","text":"

If you want to see the full usage of the cxcli agent command, please refer to this page.

If you want to learn more about Dialogflow CX agents, refer to the official documentation.

"},{"location":"agents/restore/","title":"Restore","text":""},{"location":"agents/restore/#usage","title":"Usage","text":"

You can find the restore functionality within the cxcli agent restore subcommand. You can read the documentation about this command here.

File format to be restored

Now you can restore your agents in blob or json format. When you choose json format, the input file has to be a zip file with a proper Dialogflow CX structure.

"},{"location":"agents/restore/#example","title":"Example","text":"

Here is a simple example of the cxcli agent restore command:

cxcli agent restore test-agent --project-id test-cx-346408 --location-id us-central1 --input agent.blob\n

The above command will give you output similar to the following:

$ cxcli agent restore test-agent --project-id test-cx-346408 --location-id us-central1 --input agent.zip\nINFO Agent restored\n

Are you running this command in a CI/CD pipeline?

If this is the case, we recommend that you set the --output-format parameter to json.

"},{"location":"agents/restore/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX restores, refer to the official documentation.

"},{"location":"agents/update/","title":"Update","text":""},{"location":"agents/update/#usage","title":"Usage","text":"

You can find the update functionality within the cxcli agent update subcommand. You can read the documentation about this command here.

The argument to --timezone is a value from the IANA time zone database. This is an example: 

America/New_York\nEurope/Madrid\n

"},{"location":"agents/update/#example","title":"Example","text":"

Here is a simple example of the cxcli agent update command:

cxcli agent update test-agent --project-id test-cx-346408 --location-id us-central1 --locale en --timezone Europe/Madrid\n

The above command will give you output similar to the following:

$ cxcli agent update test-agent --project-id test-cx-346408 --location-id us-central1 --locale en --timezone Europe/Madrid\nINFO Agent updated\n
"},{"location":"agents/update/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX Agent update, refer to the official documentation.

"},{"location":"cmd/cxcli/","title":"cxcli","text":"

Dialogflow CX CLI

"},{"location":"cmd/cxcli/#synopsis","title":"Synopsis","text":"

Welcome to cxcli!

This utility provides you with an easy way to interact with your Dialogflow CX agents.

You can find the documentation at https://github.com/xavidop/dialogflow-cx-cli.

Please file all bug reports on GitHub at https://github.com/xavidop/dialogflow-cx-cli/issues.

cxcli [flags]\n
"},{"location":"cmd/cxcli/#options","title":"Options","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -h, --help                   help for cxcli\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli/#see-also","title":"See also","text":"
  • cxcli agent - Actions on agent commands
  • cxcli completion - Generate the autocompletion script for the specified shell
  • cxcli dialog - Test your CX Agent interactively directly from your terminal
  • cxcli entity-type - Actions on entity type commands
  • cxcli environment - Actions on environment
  • cxcli flow - Actions on flow commands
  • cxcli flow-version - Actions on flow versions commands
  • cxcli generator - Actions on generator commands
  • cxcli intent - Actions on intent commands
  • cxcli jsonschema - outputs cxcli's JSON schema
  • cxcli profile-conversation - Actions on conversation testing
  • cxcli profile-nlu - Actions on NLU testing
  • cxcli stt - Actions on speech-to-text commands
  • cxcli tts - Actions on text-to-speech commands
  • cxcli version - Get cxcli version
  • cxcli webhook - Actions on webhook commands
"},{"location":"cmd/cxcli_agent/","title":"cxcli agent","text":"

Actions on agent commands

cxcli agent [flags]\n
"},{"location":"cmd/cxcli_agent/#options","title":"Options","text":"
  -h, --help   help for agent\n
"},{"location":"cmd/cxcli_agent/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_agent/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
  • cxcli agent create - Creates an agent
  • cxcli agent delete - Deletes a specific agent
  • cxcli agent export - Executes an export for a specific agent
  • cxcli agent restore - Executes a restore action for a specific agent
  • cxcli agent update - Update an agent
"},{"location":"cmd/cxcli_agent_create/","title":"cxcli agent create","text":"

Creates an agent

cxcli agent create [agent-name] [flags]\n
"},{"location":"cmd/cxcli_agent_create/#options","title":"Options","text":"
  -r, --avatar-uri string                   Avatar URI of the agent (optional)\n  -d, --description string                  Description of the agent (optional)\n  -b, --enable-interaction-logging string   Enable interaction logging for this agent. Possible values: true or false (optional)\n  -s, --enable-speech-adaptation string     Enable speech adaptation for this agent. Possible values: true or false (optional)\n  -n, --enable-spell-correction string      Enable spell correction for this agent. Possible values: true or false (optional)\n  -a, --enable-stackdriver-logging string   Enable Google Stackdriver logging for this agent. Possible values: true or false (optional)\n  -h, --help                                help for create\n  -e, --locale string                       Default locale of the agent (required)\n  -l, --location-id string                  Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string                   Dialogflow CX Project ID (required)\n  -x, --supported-locales strings           Supported locales of the agent, comma separated. Example: fr,es,de (optional)\n  -t, --timezone string                     Timezone of the agent from the time zone database https://www.iana.org/time-zones. Example: America/New_York, Europe/Madrid (required)\n
"},{"location":"cmd/cxcli_agent_create/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_agent_create/#see-also","title":"See also","text":"
  • cxcli agent - Actions on agent commands
"},{"location":"cmd/cxcli_agent_delete/","title":"cxcli agent delete","text":"

Deletes a specific agent

cxcli agent delete [agent-name] [flags]\n
"},{"location":"cmd/cxcli_agent_delete/#options","title":"Options","text":"
  -h, --help                 help for delete\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_agent_delete/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_agent_delete/#see-also","title":"See also","text":"
  • cxcli agent - Actions on agent commands
"},{"location":"cmd/cxcli_agent_export/","title":"cxcli agent export","text":"

Executes an export for a specific agent

cxcli agent export [agent-name] [flags]\n
"},{"location":"cmd/cxcli_agent_export/#options","title":"Options","text":"
  -t, --export-format string   Export format type: json or blob. blob by default. Default: blob (optional) (default \"blob\")\n  -h, --help                   help for export\n  -l, --location-id string     Dialogflow CX Location ID of the Project (required)\n  -f, --output-file string     Output file name. Default: agent.blob (optional) (default \"agent.blob\")\n  -p, --project-id string      Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_agent_export/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_agent_export/#see-also","title":"See also","text":"
  • cxcli agent - Actions on agent commands
"},{"location":"cmd/cxcli_agent_restore/","title":"cxcli agent restore","text":"

Executes a restore action for a specific agent

cxcli agent restore [agent-name] [flags]\n
"},{"location":"cmd/cxcli_agent_restore/#options","title":"Options","text":"
  -h, --help                 help for restore\n  -i, --input string         Input file name. Default: agent.blob (optional) (default \"agent.blob\")\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_agent_restore/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_agent_restore/#see-also","title":"See also","text":"
  • cxcli agent - Actions on agent commands
"},{"location":"cmd/cxcli_agent_update/","title":"cxcli agent update","text":"

Update an agent

cxcli agent update [agent-name] [flags]\n
"},{"location":"cmd/cxcli_agent_update/#options","title":"Options","text":"
  -r, --avatar-uri string                   Avatar URI of the agent (optional)\n  -d, --description string                  Description of the agent (optional)\n  -b, --enable-interaction-logging string   Enable interaction logging for this agent. Possible values: true or false (optional)\n  -s, --enable-speech-adaptation string     Enable speech adaptation for this agent. Possible values: true or false (optional)\n  -n, --enable-spell-correction string      Enable spell correction for this agent. Possible values: true or false (optional)\n  -a, --enable-stackdriver-logging string   Enable Google Stackdriver logging for this agent. Possible values: true or false (optional)\n  -h, --help                                help for update\n  -l, --location-id string                  Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string                   Dialogflow CX Project ID (required)\n  -x, --supported-locales strings           Supported locales of the agent, comma separated. Example: fr,es,de (optional)\n  -t, --timezone string                     Timezone of the agent from the time zone database https://www.iana.org/time-zones. Example: America/New_York, Europe/Madrid (optional)\n
"},{"location":"cmd/cxcli_agent_update/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_agent_update/#see-also","title":"See also","text":"
  • cxcli agent - Actions on agent commands
"},{"location":"cmd/cxcli_completion/","title":"cxcli completion","text":"

Generate the autocompletion script for the specified shell

"},{"location":"cmd/cxcli_completion/#synopsis","title":"Synopsis","text":"

Generate the autocompletion script for cxcli for the specified shell. See each sub-command's help for details on how to use the generated script.

"},{"location":"cmd/cxcli_completion/#options","title":"Options","text":"
  -h, --help   help for completion\n
"},{"location":"cmd/cxcli_completion/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_completion/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
  • cxcli completion bash - Generate the autocompletion script for bash
  • cxcli completion fish - Generate the autocompletion script for fish
  • cxcli completion powershell - Generate the autocompletion script for powershell
  • cxcli completion zsh - Generate the autocompletion script for zsh
"},{"location":"cmd/cxcli_completion_bash/","title":"cxcli completion bash","text":"

Generate the autocompletion script for bash

"},{"location":"cmd/cxcli_completion_bash/#synopsis","title":"Synopsis","text":"

Generate the autocompletion script for the bash shell.

This script depends on the 'bash-completion' package. If it is not installed already, you can install it via your OS's package manager.

To load completions in your current shell session:

source <(cxcli completion bash)\n

To load completions for every new session, execute once:

"},{"location":"cmd/cxcli_completion_bash/#linux","title":"Linux:","text":"
cxcli completion bash > /etc/bash_completion.d/cxcli\n
"},{"location":"cmd/cxcli_completion_bash/#macos","title":"macOS:","text":"
cxcli completion bash > $(brew --prefix)/etc/bash_completion.d/cxcli\n

You will need to start a new shell for this setup to take effect.

cxcli completion bash\n
"},{"location":"cmd/cxcli_completion_bash/#options","title":"Options","text":"
  -h, --help              help for bash\n      --no-descriptions   disable completion descriptions\n
"},{"location":"cmd/cxcli_completion_bash/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_completion_bash/#see-also","title":"See also","text":"
  • cxcli completion - Generate the autocompletion script for the specified shell
"},{"location":"cmd/cxcli_completion_fish/","title":"cxcli completion fish","text":"

Generate the autocompletion script for fish

"},{"location":"cmd/cxcli_completion_fish/#synopsis","title":"Synopsis","text":"

Generate the autocompletion script for the fish shell.

To load completions in your current shell session:

cxcli completion fish | source\n

To load completions for every new session, execute once:

cxcli completion fish > ~/.config/fish/completions/cxcli.fish\n

You will need to start a new shell for this setup to take effect.

cxcli completion fish [flags]\n
"},{"location":"cmd/cxcli_completion_fish/#options","title":"Options","text":"
  -h, --help              help for fish\n      --no-descriptions   disable completion descriptions\n
"},{"location":"cmd/cxcli_completion_fish/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_completion_fish/#see-also","title":"See also","text":"
  • cxcli completion - Generate the autocompletion script for the specified shell
"},{"location":"cmd/cxcli_completion_powershell/","title":"cxcli completion powershell","text":"

Generate the autocompletion script for powershell

"},{"location":"cmd/cxcli_completion_powershell/#synopsis","title":"Synopsis","text":"

Generate the autocompletion script for powershell.

To load completions in your current shell session:

cxcli completion powershell | Out-String | Invoke-Expression\n

To load completions for every new session, add the output of the above command to your powershell profile.

cxcli completion powershell [flags]\n
"},{"location":"cmd/cxcli_completion_powershell/#options","title":"Options","text":"
  -h, --help              help for powershell\n      --no-descriptions   disable completion descriptions\n
"},{"location":"cmd/cxcli_completion_powershell/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_completion_powershell/#see-also","title":"See also","text":"
  • cxcli completion - Generate the autocompletion script for the specified shell
"},{"location":"cmd/cxcli_completion_zsh/","title":"cxcli completion zsh","text":"

Generate the autocompletion script for zsh

"},{"location":"cmd/cxcli_completion_zsh/#synopsis","title":"Synopsis","text":"

Generate the autocompletion script for the zsh shell.

If shell completion is not already enabled in your environment you will need to enable it. You can execute the following once:

echo \"autoload -U compinit; compinit\" >> ~/.zshrc\n

To load completions in your current shell session:

source <(cxcli completion zsh)\n

To load completions for every new session, execute once:

"},{"location":"cmd/cxcli_completion_zsh/#linux","title":"Linux:","text":"
cxcli completion zsh > \"${fpath[1]}/_cxcli\"\n
"},{"location":"cmd/cxcli_completion_zsh/#macos","title":"macOS:","text":"
cxcli completion zsh > $(brew --prefix)/share/zsh/site-functions/_cxcli\n

You will need to start a new shell for this setup to take effect.

cxcli completion zsh [flags]\n
"},{"location":"cmd/cxcli_completion_zsh/#options","title":"Options","text":"
  -h, --help              help for zsh\n      --no-descriptions   disable completion descriptions\n
"},{"location":"cmd/cxcli_completion_zsh/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_completion_zsh/#see-also","title":"See also","text":"
  • cxcli completion - Generate the autocompletion script for the specified shell
"},{"location":"cmd/cxcli_dialog/","title":"cxcli dialog","text":"

Test your CX Agent interactively directly from your terminal

cxcli dialog [flags]\n
"},{"location":"cmd/cxcli_dialog/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -h, --help                 help for dialog\n  -e, --locale string        Locale of the intent. Default: agent locale (optional)\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_dialog/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_dialog/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
"},{"location":"cmd/cxcli_entity-type/","title":"cxcli entity-type","text":"

Actions on entity type commands

cxcli entity-type [flags]\n
"},{"location":"cmd/cxcli_entity-type/#options","title":"Options","text":"
  -h, --help   help for entity-type\n
"},{"location":"cmd/cxcli_entity-type/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_entity-type/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
  • cxcli entity-type create - Creates an entity type in an agent
  • cxcli entity-type delete - Deletes an entity type in an agent
  • cxcli entity-type update - Updates an entity type in an agent
"},{"location":"cmd/cxcli_entity-type_create/","title":"cxcli entity-type create","text":"

Creates an entity type in an agent

cxcli entity-type create [entity-type-name] [flags]\n
"},{"location":"cmd/cxcli_entity-type_create/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -n, --entities strings     List of the entities for this entity type, comma separated. Format: entity1@synonym1|synonym2,entity2@synonym1|synonym2. Example: pikachu@25|pika,charmander@3 (required)\n  -h, --help                 help for create\n  -e, --locale string        Locale of the intent. Default: agent locale (optional)\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n  -r, --redacted string      Set the entity type as redacted. Possible values: true or false (optional)\n
"},{"location":"cmd/cxcli_entity-type_create/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_entity-type_create/#see-also","title":"See also","text":"
  • cxcli entity-type - Actions on entity type commands
"},{"location":"cmd/cxcli_entity-type_delete/","title":"cxcli entity-type delete","text":"

Deletes an entity type in an agent

cxcli entity-type delete [entity-type-name] [flags]\n
"},{"location":"cmd/cxcli_entity-type_delete/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -f, --force string         Forces to delete the Entity type. NOTE: it will delete all any references to the entity type. Possible values: true or false (optional)\n  -h, --help                 help for delete\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_entity-type_delete/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_entity-type_delete/#see-also","title":"See also","text":"
  • cxcli entity-type - Actions on entity type commands
"},{"location":"cmd/cxcli_entity-type_update/","title":"cxcli entity-type update","text":"

Updates an entity type in an agent

cxcli entity-type update [entity-type-name] [flags]\n
"},{"location":"cmd/cxcli_entity-type_update/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -n, --entities strings     List of the entities for this entity type, comma separated. Format: entity1@synonym1|synonym2,entity2@synonym1|synonym2. Example: pikachu@25|pika,charmander@3 (required)\n  -h, --help                 help for update\n  -e, --locale string        Locale of the intent. Default: agent locale (optional)\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n  -r, --redacted string      Set the entity type as redacted. Possible values: true or false (optional)\n
"},{"location":"cmd/cxcli_entity-type_update/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_entity-type_update/#see-also","title":"See also","text":"
  • cxcli entity-type - Actions on entity type commands
"},{"location":"cmd/cxcli_environment/","title":"cxcli environment","text":"

Actions on environment

cxcli environment [flags]\n
"},{"location":"cmd/cxcli_environment/#options","title":"Options","text":"
  -h, --help   help for environment\n
"},{"location":"cmd/cxcli_environment/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_environment/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
  • cxcli environment create - create an environment
  • cxcli environment delete - delete an environment
  • cxcli environment execute-cicd - Executes a CI/CD pipeline for a specific environment
  • cxcli environment update - update an environment
"},{"location":"cmd/cxcli_environment_create/","title":"cxcli environment create","text":"

create an environment

cxcli environment create [name] [flags]\n
"},{"location":"cmd/cxcli_environment_create/#options","title":"Options","text":"
  -a, --agent-name string       Dialogflow CX Agent Name (required)\n  -d, --description string      Description for this environment (optional)\n  -s, --flow-versions strings   List of Flow and its version to be added to this environment, comma separated. Format: flowName1@version1,flowName2|version2. Example: Default Start Flow@v1.0.0|Buy Flow@v1.0.1 (required)\n  -h, --help                    help for create\n  -l, --location-id string      Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string       Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_environment_create/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_environment_create/#see-also","title":"See also","text":"
  • cxcli environment - Actions on environment
"},{"location":"cmd/cxcli_environment_delete/","title":"cxcli environment delete","text":"

delete an environment

cxcli environment delete [name] [flags]\n
"},{"location":"cmd/cxcli_environment_delete/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -h, --help                 help for delete\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_environment_delete/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_environment_delete/#see-also","title":"See also","text":"
  • cxcli environment - Actions on environment
"},{"location":"cmd/cxcli_environment_execute-cicd/","title":"cxcli environment execute-cicd","text":"

Executes a CI/CD pipeline for a specific environment

cxcli environment execute-cicd [environment] [flags]\n
"},{"location":"cmd/cxcli_environment_execute-cicd/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -h, --help                 help for execute-cicd\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_environment_execute-cicd/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_environment_execute-cicd/#see-also","title":"See also","text":"
  • cxcli environment - Actions on environment
"},{"location":"cmd/cxcli_environment_update/","title":"cxcli environment update","text":"

update an environment

cxcli environment update [name] [flags]\n
"},{"location":"cmd/cxcli_environment_update/#options","title":"Options","text":"
  -a, --agent-name string       Dialogflow CX Agent Name (required)\n  -d, --description string      Description for this environment (optional)\n  -s, --flow-versions strings   List of Flow and its version to be added to this environment, comma separated. Format: flowName1@version1,flowName2|version2. Example: Default Start Flow@v1.0.0|Buy Flow@v1.0.1 (required)\n  -h, --help                    help for update\n  -l, --location-id string      Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string       Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_environment_update/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_environment_update/#see-also","title":"See also","text":"
  • cxcli environment - Actions on environment
"},{"location":"cmd/cxcli_flow-version/","title":"cxcli flow-version","text":"

Actions on flow versions commands

cxcli flow-version [flags]\n
"},{"location":"cmd/cxcli_flow-version/#options","title":"Options","text":"
  -h, --help   help for flow-version\n
"},{"location":"cmd/cxcli_flow-version/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_flow-version/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
  • cxcli flow-version create - create a version
  • cxcli flow-version delete - delete a version
  • cxcli flow-version update - update a version
"},{"location":"cmd/cxcli_flow-version_create/","title":"cxcli flow-version create","text":"

create a version

cxcli flow-version create [name] [flags]\n
"},{"location":"cmd/cxcli_flow-version_create/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -d, --description string   Description for this version (optional)\n  -h, --help                 help for create\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n  -s, --start-flow string    Start Flow name to create the version (required)\n
"},{"location":"cmd/cxcli_flow-version_create/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_flow-version_create/#see-also","title":"See also","text":"
  • cxcli flow-version - Actions on flow versions commands
"},{"location":"cmd/cxcli_flow-version_delete/","title":"cxcli flow-version delete","text":"

delete a version

cxcli flow-version delete [name] [flags]\n
"},{"location":"cmd/cxcli_flow-version_delete/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -h, --help                 help for delete\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n  -s, --start-flow string    Start Flow name to create the version (required)\n
"},{"location":"cmd/cxcli_flow-version_delete/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_flow-version_delete/#see-also","title":"See also","text":"
  • cxcli flow-version - Actions on flow versions commands
"},{"location":"cmd/cxcli_flow-version_update/","title":"cxcli flow-version update","text":"

update a version

cxcli flow-version update [name] [flags]\n
"},{"location":"cmd/cxcli_flow-version_update/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -d, --description string   Description for this version (optional)\n  -h, --help                 help for update\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n  -s, --start-flow string    Start Flow name to create the version (required)\n
"},{"location":"cmd/cxcli_flow-version_update/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_flow-version_update/#see-also","title":"See also","text":"
  • cxcli flow-version - Actions on flow versions commands
"},{"location":"cmd/cxcli_flow/","title":"cxcli flow","text":"

Actions on flow commands

cxcli flow [flags]\n
"},{"location":"cmd/cxcli_flow/#options","title":"Options","text":"
  -h, --help   help for flow\n
"},{"location":"cmd/cxcli_flow/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_flow/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
  • cxcli flow create - Creates a flow in an agent
  • cxcli flow delete - Deletes a flow in an agent
  • cxcli flow train - Trains a flow in an agent. If flow name is set to \"all\", it will train all flows in an agent
  • cxcli flow update - Updates a flow in an agent
"},{"location":"cmd/cxcli_flow_create/","title":"cxcli flow create","text":"

Creates a flow in an agent

cxcli flow create [flow-name] [flags]\n
"},{"location":"cmd/cxcli_flow_create/#options","title":"Options","text":"
  -a, --agent-name string                     Dialogflow CX Agent Name (required)\n  -d, --description string                    Description for this flow (optional)\n  -h, --help                                  help for create\n  -e, --locale string                         Locale of the flow. Default: agent locale (optional)\n  -l, --location-id string                    Dialogflow CX Location ID of the Project (required)\n  -s, --nlu-classification-threshold string   NLU Classification Threshold. From 0.0 (completely uncertain) to 1.0 (completely certain). Default: 0.3 (optional) (default \"0.3\")\n  -t, --nlu-model-training-mode string        NLU Model training mode. Possible values: automatic or manual. Default: manual (optional) (default \"manual\")\n  -m, --nlu-model-type string                 NLU Model Type. Possible values: advanced or standard. Default: standard (optional) (default \"standard\")\n  -p, --project-id string                     Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_flow_create/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_flow_create/#see-also","title":"See also","text":"
  • cxcli flow - Actions on flow commands
"},{"location":"cmd/cxcli_flow_delete/","title":"cxcli flow delete","text":"

Deletes a flow in an agent

cxcli flow delete [flow-name] [flags]\n
"},{"location":"cmd/cxcli_flow_delete/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -h, --help                 help for delete\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_flow_delete/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_flow_delete/#see-also","title":"See also","text":"
  • cxcli flow - Actions on flow commands
"},{"location":"cmd/cxcli_flow_train/","title":"cxcli flow train","text":"

Trains a flow in an agent. If flow name is set to \"all\", it will train all flows in an agent

cxcli flow train [flow-name] [flags]\n
"},{"location":"cmd/cxcli_flow_train/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -h, --help                 help for train\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_flow_train/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_flow_train/#see-also","title":"See also","text":"
  • cxcli flow - Actions on flow commands
"},{"location":"cmd/cxcli_flow_update/","title":"cxcli flow update","text":"

Updates a flow in an agent

cxcli flow update [flow-name] [flags]\n
"},{"location":"cmd/cxcli_flow_update/#options","title":"Options","text":"
  -a, --agent-name string                     Dialogflow CX Agent Name (required)\n  -d, --description string                    Description for this flow (optional)\n  -h, --help                                  help for update\n  -e, --locale string                         Locale of the flow. Default: agent locale (optional)\n  -l, --location-id string                    Dialogflow CX Location ID of the Project (required)\n  -s, --nlu-classification-threshold string   NLU Classification Threshold. From 0.0 (completely uncertain) to 1.0 (completely certain). (optional)\n  -t, --nlu-model-training-mode string        NLU Model training mode. Possible values: automatic or manual (optional)\n  -m, --nlu-model-type string                 NLU Model Type. Possible values: advanced or standard (optional)\n  -p, --project-id string                     Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_flow_update/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_flow_update/#see-also","title":"See also","text":"
  • cxcli flow - Actions on flow commands
"},{"location":"cmd/cxcli_generator/","title":"cxcli generator","text":"

Actions on generator commands

cxcli generator [flags]\n
"},{"location":"cmd/cxcli_generator/#options","title":"Options","text":"
  -h, --help   help for generator\n
"},{"location":"cmd/cxcli_generator/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_generator/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
  • cxcli generator create - create a generator
  • cxcli generator delete - delete a generator
  • cxcli generator update - update a generator
"},{"location":"cmd/cxcli_generator_create/","title":"cxcli generator create","text":"

create a generator

cxcli generator create [name] [flags]\n
"},{"location":"cmd/cxcli_generator_create/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -h, --help                 help for create\n  -e, --locale string        Locale of the generator. Default: agent locale (optional)\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n  -r, --prompt string        Prompt (required)\n
"},{"location":"cmd/cxcli_generator_create/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_generator_create/#see-also","title":"See also","text":"
  • cxcli generator - Actions on generator commands
"},{"location":"cmd/cxcli_generator_delete/","title":"cxcli generator delete","text":"

delete a generator

cxcli generator delete [name] [flags]\n
"},{"location":"cmd/cxcli_generator_delete/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -f, --force string         Forces to delete the generator and its references. Possible values: true or false (optional)\n  -h, --help                 help for delete\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_generator_delete/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_generator_delete/#see-also","title":"See also","text":"
  • cxcli generator - Actions on generator commands
"},{"location":"cmd/cxcli_generator_update/","title":"cxcli generator update","text":"

update a generator

cxcli generator update [name] [flags]\n
"},{"location":"cmd/cxcli_generator_update/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -h, --help                 help for update\n  -e, --locale string        Locale of the generator. Default: agent locale (optional)\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n  -r, --prompt string        Prompt (required)\n
"},{"location":"cmd/cxcli_generator_update/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_generator_update/#see-also","title":"See also","text":"
  • cxcli generator - Actions on generator commands
"},{"location":"cmd/cxcli_intent/","title":"cxcli intent","text":"

Actions on intent commands

cxcli intent [flags]\n
"},{"location":"cmd/cxcli_intent/#options","title":"Options","text":"
  -h, --help   help for intent\n
"},{"location":"cmd/cxcli_intent/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_intent/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
  • cxcli intent create - Creates an intent in an agent
  • cxcli intent delete - Deletes an intent in an agent
  • cxcli intent update - Updates an intent in an agent
"},{"location":"cmd/cxcli_intent_create/","title":"cxcli intent create","text":"

Creates an intent in an agent

cxcli intent create [intent-name] [flags]\n
"},{"location":"cmd/cxcli_intent_create/#options","title":"Options","text":"
  -a, --agent-name string          Dialogflow CX Agent Name (required)\n  -d, --description string         Description for this intent (optional)\n  -h, --help                       help for create\n  -e, --locale string              Locale of the intent. Default: agent locale (optional)\n  -l, --location-id string         Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string          Dialogflow CX Project ID (required)\n  -t, --training-phrases strings   List of the training phrases for this intent, comma separated. Entities, add @entity-type to the word: word@entity-type in the training phrase. Example: hello,hi how are you today@sys.date,morning!. (required)\n
"},{"location":"cmd/cxcli_intent_create/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_intent_create/#see-also","title":"See also","text":"
  • cxcli intent - Actions on intent commands
"},{"location":"cmd/cxcli_intent_delete/","title":"cxcli intent delete","text":"

Deletes an intent in an agent

cxcli intent delete [intent-name] [flags]\n
"},{"location":"cmd/cxcli_intent_delete/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -h, --help                 help for delete\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_intent_delete/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_intent_delete/#see-also","title":"See also","text":"
  • cxcli intent - Actions on intent commands
"},{"location":"cmd/cxcli_intent_update/","title":"cxcli intent update","text":"

Updates an intent in an agent

cxcli intent update [intent-name] [flags]\n
"},{"location":"cmd/cxcli_intent_update/#options","title":"Options","text":"
  -a, --agent-name string          Dialogflow CX Agent Name (required)\n  -d, --description string         Description for this intent (optional)\n  -h, --help                       help for update\n  -e, --locale string              Locale of the intent. Default: agent locale (optional)\n  -l, --location-id string         Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string          Dialogflow CX Project ID (required)\n  -t, --training-phrases strings   List of the training phrases for this intent, comma separated. Entities, add @entity-type to the word: word@entity-type in the training phrase. Example: hello,hi how are you today@sys.date,morning!. (Optional)\n
"},{"location":"cmd/cxcli_intent_update/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_intent_update/#see-also","title":"See also","text":"
  • cxcli intent - Actions on intent commands
"},{"location":"cmd/cxcli_jsonschema/","title":"cxcli jsonschema","text":"

outputs cxcli's JSON schema

cxcli jsonschema [flags]\n
"},{"location":"cmd/cxcli_jsonschema/#options","title":"Options","text":"
  -h, --help                   help for jsonschema\n  -f, --output-folder string   Where to save the JSONSchema file (default \"-\")\n
"},{"location":"cmd/cxcli_jsonschema/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_jsonschema/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
"},{"location":"cmd/cxcli_profile-conversation/","title":"cxcli profile-conversation","text":"

Actions on conversation testing

cxcli profile-conversation [flags]\n
"},{"location":"cmd/cxcli_profile-conversation/#options","title":"Options","text":"
  -h, --help   help for profile-conversation\n
"},{"location":"cmd/cxcli_profile-conversation/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_profile-conversation/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
  • cxcli profile-conversation execute - Execute a suite
"},{"location":"cmd/cxcli_profile-conversation_execute/","title":"cxcli profile-conversation execute","text":"

Execute a suite

cxcli profile-conversation execute [suite-file] [flags]\n
"},{"location":"cmd/cxcli_profile-conversation_execute/#options","title":"Options","text":"
  -h, --help   help for execute\n
"},{"location":"cmd/cxcli_profile-conversation_execute/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_profile-conversation_execute/#see-also","title":"See also","text":"
  • cxcli profile-conversation - Actions on conversation testing
"},{"location":"cmd/cxcli_profile-nlu/","title":"cxcli profile-nlu","text":"

Actions on NLU testing

cxcli profile-nlu [flags]\n
"},{"location":"cmd/cxcli_profile-nlu/#options","title":"Options","text":"
  -h, --help   help for profile-nlu\n
"},{"location":"cmd/cxcli_profile-nlu/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_profile-nlu/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
  • cxcli profile-nlu execute - Execute a suite
"},{"location":"cmd/cxcli_profile-nlu_execute/","title":"cxcli profile-nlu execute","text":"

Execute a suite

cxcli profile-nlu execute [suite-file] [flags]\n
"},{"location":"cmd/cxcli_profile-nlu_execute/#options","title":"Options","text":"
  -h, --help   help for execute\n
"},{"location":"cmd/cxcli_profile-nlu_execute/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_profile-nlu_execute/#see-also","title":"See also","text":"
  • cxcli profile-nlu - Actions on NLU testing
"},{"location":"cmd/cxcli_stt/","title":"cxcli stt","text":"

Actions on speech-to-text commands

cxcli stt [flags]\n
"},{"location":"cmd/cxcli_stt/#options","title":"Options","text":"
  -h, --help   help for stt\n
"},{"location":"cmd/cxcli_stt/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_stt/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
  • cxcli stt recognize - Transforms audio into text
"},{"location":"cmd/cxcli_stt_recognize/","title":"cxcli stt recognize","text":"

Transforms audio into text

cxcli stt recognize [input] [flags]\n
"},{"location":"cmd/cxcli_stt_recognize/#options","title":"Options","text":"
  -h, --help            help for recognize\n  -l, --locale string   Input locale (required)\n
"},{"location":"cmd/cxcli_stt_recognize/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_stt_recognize/#see-also","title":"See also","text":"
  • cxcli stt - Actions on speech-to-text commands
"},{"location":"cmd/cxcli_tts/","title":"cxcli tts","text":"

Actions on text-to-speech commands

cxcli tts [flags]\n
"},{"location":"cmd/cxcli_tts/#options","title":"Options","text":"
  -h, --help   help for tts\n
"},{"location":"cmd/cxcli_tts/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_tts/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
  • cxcli tts synthesize - Transforms text into audio
"},{"location":"cmd/cxcli_tts_synthesize/","title":"cxcli tts synthesize","text":"

Transforms text into audio

cxcli tts synthesize [input] [flags]\n
"},{"location":"cmd/cxcli_tts_synthesize/#options","title":"Options","text":"
  -h, --help                 help for synthesize\n  -l, --locale string        Input locale (required)\n  -f, --output-file string   Output file name. Default: output.mp3 (optional) (default \"output.mp3\")\n
"},{"location":"cmd/cxcli_tts_synthesize/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_tts_synthesize/#see-also","title":"See also","text":"
  • cxcli tts - Actions on text-to-speech commands
"},{"location":"cmd/cxcli_version/","title":"cxcli version","text":"

Get cxcli version

cxcli version [flags]\n
"},{"location":"cmd/cxcli_version/#options","title":"Options","text":"
  -h, --help   help for version\n
"},{"location":"cmd/cxcli_version/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_version/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
"},{"location":"cmd/cxcli_webhook/","title":"cxcli webhook","text":"

Actions on webhook commands

cxcli webhook [flags]\n
"},{"location":"cmd/cxcli_webhook/#options","title":"Options","text":"
  -h, --help   help for webhook\n
"},{"location":"cmd/cxcli_webhook/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_webhook/#see-also","title":"See also","text":"
  • cxcli - Dialogflow CX CLI
  • cxcli webhook create - create a webhook
  • cxcli webhook delete - delete a webhook
  • cxcli webhook update - update a webhook
"},{"location":"cmd/cxcli_webhook_create/","title":"cxcli webhook create","text":"

create a webhook

cxcli webhook create [name] [flags]\n
"},{"location":"cmd/cxcli_webhook_create/#options","title":"Options","text":"
  -a, --agent-name string           Dialogflow CX Agent Name (required)\n  -e, --environment string          Environment where you want to set the webhook url. Default: global (optional) (default \"global\")\n  -f, --flexible string             Creates a flexible webhook. Possible values: true or false (optional) (default \"false\")\n  -h, --help                        help for create\n  -l, --location-id string          Dialogflow CX Location ID of the Project (required)\n  -m, --parameters-mapping string   Creates a parameter mapping for flexible webhook, comma separated. The format is parameter@json-path,paramter2@json-path2. Example: my-param@$.fully.qualified.path.to.field (required only if flexible is true)\n  -p, --project-id string           Dialogflow CX Project ID (required)\n  -t, --request-body string         Creates a request body for flexible webhook. It has to be in JSON Format (required only if flexible is true)\n  -r, --url string                  Webhook URL (required)\n
"},{"location":"cmd/cxcli_webhook_create/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_webhook_create/#see-also","title":"See also","text":"
  • cxcli webhook - Actions on webhook commands
"},{"location":"cmd/cxcli_webhook_delete/","title":"cxcli webhook delete","text":"

delete a webhook

cxcli webhook delete [name] [flags]\n
"},{"location":"cmd/cxcli_webhook_delete/#options","title":"Options","text":"
  -a, --agent-name string    Dialogflow CX Agent Name (required)\n  -f, --force string         Forces to delete the webhook and its references in environments and flows. Possible values: true or false (optional)\n  -h, --help                 help for delete\n  -l, --location-id string   Dialogflow CX Location ID of the Project (required)\n  -p, --project-id string    Dialogflow CX Project ID (required)\n
"},{"location":"cmd/cxcli_webhook_delete/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_webhook_delete/#see-also","title":"See also","text":"
  • cxcli webhook - Actions on webhook commands
"},{"location":"cmd/cxcli_webhook_update/","title":"cxcli webhook update","text":"

update a webhook

cxcli webhook update [name] [flags]\n
"},{"location":"cmd/cxcli_webhook_update/#options","title":"Options","text":"
  -a, --agent-name string           Dialogflow CX Agent Name (required)\n  -e, --environment string          Environment where you want to set the webhook url. Default: global (optional) (default \"global\")\n  -f, --flexible string             Creates a flexible webhook. Possible values: true or false (optional) (default \"false\")\n  -h, --help                        help for update\n  -l, --location-id string          Dialogflow CX Location ID of the Project (required)\n  -m, --parameters-mapping string   Creates a parameter mapping for flexible webhook, comma separated. The format is parameter@json-path,paramter2@json-path2. Example: my-param@$.fully.qualified.path.to.field. This only applies to flexible webhooks (optional)\n  -p, --project-id string           Dialogflow CX Project ID (required)\n  -t, --request-body string         Creates a request body for flexible webhook. It has to be in JSON Format. This only applies to flexible webhooks (optional)\n  -r, --url string                  Webhook URL (required)\n
"},{"location":"cmd/cxcli_webhook_update/#options-inherited-from-parent-commands","title":"Options inherited from parent commands","text":"
  -c, --credentials string     Google Cloud credentials JSON file path (optional)\n  -o, --output-format string   Output Format. Options: text, json. Default: text (optional) (default \"text\")\n  -u, --skip-update-check      Skip the check for updates check run before every command (optional)\n  -v, --verbose                verbose error output (with stack trace) (optional)\n
"},{"location":"cmd/cxcli_webhook_update/#see-also","title":"See also","text":"
  • cxcli webhook - Actions on webhook commands
"},{"location":"community/contributing/","title":"Contributing","text":"

By participating in this project, you agree to abide by our code of conduct.

"},{"location":"community/contributing/#set-up-your-machine","title":"Set up your machine","text":"

cxcli is written in Go.

Prerequisites:

  • Go 1.20+

Other things you might need to run the tests:

  • cosign
  • Docker
  • Podman
  • Snapcraft
  • Syft

Clone cxcli anywhere:

git clone git@github.com:xavidop/dialogflow-cx-cli.git\n

cd into the directory and install the dependencies:

go mod tidy\n

A good way of making sure everything is all right is running the build:

go build -o cxcli .\n
"},{"location":"community/contributing/#test-your-change","title":"Test your change","text":"

You can create a branch for your changes and try to build from the source as you go:

go build -o cxcli .\n
"},{"location":"community/contributing/#create-a-commit","title":"Create a commit","text":"

Commit messages should be well formatted, and to make that \"standardized\", we are using Conventional Commits.

You can follow the documentation on their website.

"},{"location":"community/contributing/#submit-a-pull-request","title":"Submit a pull request","text":"

Push your branch to your cxcli fork and open a pull request against the main branch.

"},{"location":"community/contributing/#financial-contributions","title":"Financial contributions","text":"

You can contribute in our GitHub Sponsors or to any of the contributors directly. See this page for more details.

"},{"location":"community/sponsors/","title":"Sponsors","text":"

Do you or your company use cxcli? You can help keep the project bug-free and feature rich by sponsoring the project and its maintainers.

"},{"location":"community/sponsors/#github-sponsors","title":"GitHub Sponsors","text":"

GitHub Sponsors is a great way to contribute directly to the primary maintainer, xavidop.

This money usually goes to buying coffee, beer, better hardware, and, hopefully, one day, paying the bills.

You can sponsor and see who's sponsoring Xavier Portilla Edo here.

\u2728\u2728 Thanks for your support! \u2728\u2728

"},{"location":"community/users/","title":"Users","text":""},{"location":"community/users/#who-uses-cxcli","title":"Who uses cxcli?","text":"

As the cxcli community grows, we'd like to keep a list of our users.

Here's a running list of some organizations using cxcli1:

  1. Empty list, become the first one!

Feel free to add yours!

  1. Entries were either added by the companies themselves or by the maintainers after seeing it in the wild.\u00a0\u21a9

"},{"location":"conversationprofiler/examples/","title":"Examples","text":""},{"location":"conversationprofiler/examples/#contains","title":"Contains","text":"

Simple example that demonstrates the Conversational Profiler in action using the contains validator. Find it here

"},{"location":"conversationprofiler/examples/#prompt","title":"Prompt","text":"

Example that shows how to use a prompt as an user input Dialogflow CX. Find it here

"},{"location":"conversationprofiler/examples/#string-similarity-algorithm","title":"String Similarity Algorithm","text":"

Full example using a string similarity algorithm to validate the agent's response. Find it here

"},{"location":"conversationprofiler/introduction/","title":"Conversation profiler","text":""},{"location":"conversationprofiler/introduction/#what-is-this","title":"What is this?","text":"

Use the Conversation Profiler to test user utterances and improve your agent's interaction model.

With the Conversation Profiler, you can test the conversation flow of your agent. This means that you can send user's utterances to your agent and check if the agent is responding as expected (interactions). This feature is also useful when you have generative AI models in your agent, and you want to test if the agent is responding as expected. It is similar to the Dialogflow CX console's Test Agent feature, but with the Conversation Profiler, you can run your tests in your CI/CD pipelines and also it has additional features. Every suite is executed in the same Dialogflow CX session.

All of the commands that are available in cxcli to execute the Conversation profiler are located within the cxcli profile-conversation subcommand.

"},{"location":"conversationprofiler/introduction/#reference","title":"Reference","text":"

It is important to know which suites and tests you can build. Because of that, you can find the entire reference on the Reference page. Suites and test are defined as yaml files.

The cxcli has a command that allows you to run these suites from your terminal or from your CI pipelines.

To execute a suite, you can run the cxcli profile-conversation execute command. For the usage, please refer to this page.

"},{"location":"conversationprofiler/introduction/#examples","title":"Examples","text":"

You can find some useful examples on our GitHub repo and the Examples page.

"},{"location":"conversationprofiler/introduction/#execution-example","title":"Execution Example","text":"

Here is a simple example of the cxcli profile-conversation execute command:

cxcli profile-conversation execute examples/profileconversation/suite.yaml\n

The above command will give you output similar to the following:

$ cxcli profile-conversation execute suite.yaml\n[INFO] Running suite: Example Conversation Profiler Suite\n[INFO][test-file:test_1][interaction:test_1_1][input:prompt] User> Hello! (auto-generated from prompt: \"give me a one line hello\")\n[INFO][test-file:test_1][interaction:test_1_1][input:prompt] Agent> Hi! How are you doing?\n[INFO][test-file:test_1][interaction:test_1_1][validation:equals] Validation with value \"hi\" \n[INFO][test-file:test_1][interaction:test_1_1][validation:equals] Validation configuration: {CaseSensitive:false}\n[INFO][test-file:test_1][interaction:test_1_2][input:text] User> hi\n[INFO][test-file:test_1][interaction:test_1_2][input:text] Agent> Hi! How are you doing?\n[INFO][test-file:test_1][interaction:test_1_2][validation:contains] Validation with value \"hi\" \n[INFO][test-file:test_1][interaction:test_1_2][validation:contains] Validation configuration: {CaseSensitive:false}\n[INFO][test-file:test_1][interaction:test_1_3][input:text] User> hello\n[INFO][test-file:test_1][interaction:test_1_3][input:text] Agent> Hi! How are you doing?\n[INFO][test-file:test_1][interaction:test_1_3][validation:equals] Validation with value \"hello\" \n[INFO][test-file:test_1][interaction:test_1_3][validation:equals] Validation configuration: {CaseSensitive:false}\n[INFO][test-file:test_1][interaction:test_1_4][input:text] User> hi\n[INFO][test-file:test_1][interaction:test_1_4][input:text] Agent> Hi! How are you doing?\n[INFO][test-file:test_1][interaction:test_1_4][validation:similarity] Validation with value \"hello\" \n[INFO][test-file:test_1][interaction:test_1_4][validation:similarity] Validation configuration: {CaseSensitive:false InsertCost:0 DeleteCost:0 ReplaceCost:0}\n

Are you running this command in a CI/CD pipeline?

If this is the case, we recommend that you set the --output-format parameter to json.

"},{"location":"conversationprofiler/suites/","title":"Suites","text":""},{"location":"conversationprofiler/suites/#reference","title":"Reference","text":"

A suite is a yaml file with the following structure:

# suite.yaml\n\n# Name of the suite.\nname: Example Suite\n# Brief description of the suite.\ndescription: Suite used as an example\n# Project ID on Google Cloud where is located your Dialogflow CX agent.\nprojectId: test-cx-346408\n# Location where your Dialogflow CX agent is running. \n# More info here: https://cloud.google.com/dialogflow/cx/docs/concept/region\nlocationId: us-central1\n# Agent name of your Dialogflow CX agent.\n# Notice: it is the agent name, not the agent ID.\nagentName: test-agent\n# You can have multiple tests defined in separated files\ntests:\n  # ID of the test.\n  - id: test_id\n    # File where the test specification is located\n    file: ./test.yaml\n

It has the same structure as the NLU Profiler suite.

"},{"location":"conversationprofiler/suites/#json-schema","title":"JSON Schema","text":"

cxcli also has a jsonschema file, which you can use to have better editor support:

https://cxcli.xavidop.me/static/conversationsuite.json\n

You can also specify it in your yml config files by adding a comment like the following: 

# yaml-language-server: $schema=https://cxcli.xavidop.me/static/conversationsuite.json\n

"},{"location":"conversationprofiler/tests/","title":"Tests","text":""},{"location":"conversationprofiler/tests/#reference","title":"Reference","text":"

A test is a yaml file with the following structure:

# test.yaml\n\n# Name of the test.\nname: Example test\n# Brief description of the test.\ndescription: These are some tests\n# Locale of the interaction model that is gonna be tested.\n# You can find the locales here: https://cloud.google.com/dialogflow/cx/docs/reference/language\nlocaleId: en\n# A interactions is the test itself: given an input, you will validate the agent response returned by Dialogflow CX\n# You can have multiple interactions defined\ninteractions:\n  # The ID of the interactions\n  - id: test_1\n    user:\n      # the input type\n      # it could be text, audio or prompt\n      type: text\n      # The input itself in text format. For type: audio, you have to specify the audio file.\n      text: I want 3 pizzas\n    agent:\n      validate:\n        # String validation to check if the response returned by Dialogflow CX is correct\n        - type: contains\n          value: pizza\n\n  - id: test_2\n    user: \n      type: text\n      text: hi\n    agent:\n      # example with a string similarity validation\n      validate:\n        - type: similarity\n          algorithm: levenshtein\n          threshold: 0.4\n          value: hello\n          configuration-levenshtein:\n            casesensitive: false\n\n  - id: test_3\n    user: \n      type: audio\n      audio: ./audio/hi.mp3\n    agent:\n      # example with a regexp validation\n      validate:\n        - type: regexp\n          value: '/my-regex/'\n
"},{"location":"conversationprofiler/tests/#input-types","title":"Input types","text":""},{"location":"conversationprofiler/tests/#text-input","title":"Text input","text":"

The input text is the simplest one. You just have to specify the text you want to send to Dialogflow CX. Make sure that the text is in the language you specified in the localeId field. to use this type you have to set the type field to text and the text field to the text you want to send.

"},{"location":"conversationprofiler/tests/#audio-input","title":"Audio input","text":"

The audio input is a little bit more complex. You have to specify the path to the audio file you want to send to Dialogflow CX. Make sure that the audio file is in the language you specified in the localeId field. To use this type you have to set the type field to audio and the file field to the path to the audio file.

It is important to know that the input audio needs to have the following format:

  1. A sample rate of 16000 Hertz
  2. The audio encoding has to be Linear16. Linear16 is a 16-bit linear pulse-code modulation (PCM) encoding.

If you don't have a file with this format, you can create it by yourself using the cxcli tts command! All the information is located here

"},{"location":"conversationprofiler/tests/#prompt-input","title":"Prompt input","text":"

The prompt input is the most complex one. You have to specify the input prompt you want to send to Dialogflow CX. To use this type you have to set the type field to prompt and the prompt field to the prompt you want to send.

It is important to know that the input prompt needs Vertex AI API to be enabled in your project and the proper permissions granted. You can find more information on the Authentication page.

"},{"location":"conversationprofiler/tests/#validation-types","title":"Validation types","text":""},{"location":"conversationprofiler/tests/#contains","title":"Contains","text":"

The contains validation type is the simplest one. It just checks if the response returned by the Dialogflow CX agent contains the value specified in the value field. To use this type you have to set the type field to contains and the value field to the value you want to check:

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: contains\n    value: pizza\n

The contains validation has its own options:

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: contains\n    value: pizza\n    configuration-contains:\n      casesensitive: true\n

If you set the casesensitive field to true, the validation will be case sensitive. By default, it is set to false.

"},{"location":"conversationprofiler/tests/#equals","title":"Equals","text":"

The equals validation type is a little bit more complex. It checks if the response returned by the Dialogflow CX agent is equal to the value specified in the value field. To use this type you have to set the type field to equals and the value field to the value you want to check:

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: equals\n    value: Here you have 3 pizzas\n

The equals validation has its own options:

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: equals\n    value: Here you have 3 pizzas\n    configuration-equals:\n      casesensitive: true\n

If you set the casesensitive field to true, the validation will be case sensitive. By default, it is set to false.

"},{"location":"conversationprofiler/tests/#regexp","title":"Regexp","text":"

The regexp validation type is the most complex one. It checks if the response returned by the Dialogflow CX agent matches the regexp specified in the value field. To use this type you have to set the type field to regexp and the value field to the regular expression you want to check:

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: regexp\n    value: '/Here you have \\d pizzas/'\n

The regexp validation has its own options:

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: regexp\n    value: '/Here you have \\d pizzas/'\n    configuration-regexp:\n      findinsubmatches: true\n

If you set the findinsubmatches field to true, the validation will check if the regexp matches any of the submatches. By default, it is set to false.

"},{"location":"conversationprofiler/tests/#string-similarity-algorithms","title":"String Similarity Algorithms","text":"

The string similarity validation type is the most complex one. It checks if the response returned by the Dialogflow CX agent is similar to the value specified in the value field using a threshold to check if the similarity is enough. To use this type you have to set the type field to similarity and the algorithm field to the algorithm you want to use and the value field to the value you want to check and the threshold field to the threshold you want to use. The available algorithms are:

  1. levenshtein: The Levenshtein distance is a string metric for measuring the difference between two sequences. Informally, the Levenshtein distance between two words is the minimum number of single-character edits (insertions, deletions or substitutions) required to change one word into the other.
  2. jaro: The Jaro distance is a measure of similarity between two strings. The higher the Jaro distance for two strings is, the more similar the strings are. The score is normalized such that 0 equates to no similarity and 1 is an exact match.
  3. jaro-winkler: The Jaro\u2013Winkler distance is a string metric for measuring the edit distance between two sequences. Informally, the Jaro\u2013Winkler distance is the edit distance between two strings with the twist that higher scores are returned for strings that match from the beginning for a set prefix length.
  4. smith-waterman-gotoh: The Smith\u2013Waterman algorithm performs local sequence alignment; that is, for determining similar regions between two strings of nucleic acid sequences or protein sequences. Instead of looking at the entire sequence, the Smith\u2013Waterman algorithm compares segments of all possible lengths and optimizes the similarity measure.
  5. sorensen-dice: The Dice distance is a measure of similarity between two strings. The higher the Dice distance for two strings is, the more similar the strings are. The score is normalized such that 0 equates to no similarity and 1 is an exact match.
  6. jaccard: The Jaccard distance is a measure of similarity between two strings. The higher the Jaccard distance for two strings is, the more similar the strings are. The score is normalized such that 0 equates to no similarity and 1 is an exact match.
  7. overlap-coefficient: The Overlap distance (or Szymkiewicz-Simpson distance) is a measure of similarity between two strings. The higher the Overlap distance for two strings is, the more similar the strings are. The score is normalized such that 0 equates to no similarity and 1 is an exact match.
  8. hamming: The Hamming measures the minimum number of substitutions required to change one string into the other, or equivalently, the minimum number of errors that could have transformed one string into the other. The higher the Hamming distance for two strings is, the more similar the strings are. The score is normalized such that 0 equates to no similarity and 1 is an exact match.
"},{"location":"conversationprofiler/tests/#levenshtein","title":"Levenshtein","text":"

The levenshtein algorithm has the following configuration:

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: levenshtein\n    value: hello\n    threshold: 0.4\n

The options are: 

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: levenshtein\n    value: hello\n    threshold: 0.4\n    configuration-levenshtein:\n      casesensitive: true\n      insertcost: 1\n      deletecost: 1\n      replacecost: 1\n
Let's explain each one of them:

  1. The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.
  2. the insertcost field is used to set the cost of an insert operation. By default, it is set to 1.
  3. the deletecost field is used to set the cost of a delete operation. By default, it is set to 1.
  4. the replacecost field is used to set the cost of a replace operation. By default, it is set to 1.
"},{"location":"conversationprofiler/tests/#jaro","title":"Jaro","text":"

The Jaro algorithm has the following configuration:

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: jaro\n    value: hello\n    threshold: 0.4\n

The options are: 

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: jaro\n    value: hello\n    threshold: 0.4\n    configuration-jaro:\n      casesensitive: true\n

The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.

"},{"location":"conversationprofiler/tests/#jaro-winkler","title":"Jaro-Winkler","text":"

The Jaro-Winkler algorithm has the following configuration:

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: jaro-winkler\n    value: hello\n    threshold: 0.4\n

The options are: 

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: jaro-winkler\n    value: hello\n    threshold: 0.4\n    configuration-jaro-winkler:\n      casesensitive: true\n

The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.

"},{"location":"conversationprofiler/tests/#smith-waterman-gotoh","title":"Smith-Waterman-Gotoh","text":"

The Smith-Waterman-Gotoh algorithm has the following configuration:

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: smith-waterman-gotoh\n    value: hello\n    threshold: 0.4\n

The options are: 

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: smith-waterman-gotoh\n    value: hello\n    threshold: 0.4\n    configuration-smith-waterman-gotoh:\n      casesensitive: true\n      gappenalty: -0.5\n

Let's explain each one of them:

  1. The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.
  2. the gappenalty defines a score penalty for character insertions or deletions. For relevant results, the gap penalty should be a non-positive number. By default, it is set to -0.5.
"},{"location":"conversationprofiler/tests/#sorensen-dice","title":"Sorensen-Dice","text":"

The Sorensen-Dice algorithm has the following configuration:

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: sorensen-dice\n    value: hello\n    threshold: 0.4\n

The options are: 

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: sorensen-dice\n    value: hello\n    threshold: 0.4\n    configuration-sorensen-dice:\n      casesensitive: true\n      NgramSize: 2\n

Let's explain each one of them:

  1. The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.
  2. The NgramSize represents the size (in characters) of the tokens generated when comparing the input sequences. By default, it is set to 2.
"},{"location":"conversationprofiler/tests/#jaccard","title":"Jaccard","text":"

The Jaccard algorithm has the following configuration:

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: jaccard\n    value: hello\n    threshold: 0.4\n

The options are: 

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: jaccard\n    value: hello\n    threshold: 0.4\n    configuration-jaccard:\n      casesensitive: true\n      NgramSize: 2\n

Let's explain each one of them:

  1. The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.
  2. The NgramSize represents the size (in characters) of the tokens generated when comparing the input sequences. By default, it is set to 2.
"},{"location":"conversationprofiler/tests/#overlap-coefficient","title":"Overlap Coefficient","text":"

The Overlap Coefficient algorithm has the following configuration:

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: overlap-coefficient\n    value: hello\n    threshold: 0.4\n

The options are: 

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: overlap-coefficient\n    value: hello\n    threshold: 0.4\n    configuration-overlap-coefficient:\n      casesensitive: true\n      NgramSize: 2\n

Let's explain each one of them:

  1. The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.
  2. The NgramSize represents the size (in characters) of the tokens generated when comparing the input sequences. By default, it is set to 2.
"},{"location":"conversationprofiler/tests/#hamming","title":"Hamming","text":"

The Hamming algorithm has the following configuration:

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: hamming\n    value: hello\n    threshold: 0.4\n

The options are: 

validate:\n  # String validation to check if the response returned by Dialogflow CX is correct\n  - type: similarity\n    algorithm: hamming\n    value: hello\n    threshold: 0.4\n    configuration-hamming:\n      casesensitive: true\n

The casesensitive field is used to check if the algorithm is case sensitive. By default, it is set to true.

"},{"location":"conversationprofiler/tests/#json-schema","title":"JSON Schema","text":"

cxcli also has a jsonschema file, which you can use to have better editor support:

https://cxcli.xavidop.me/static/conversationtest.json\n

You can also specify it in your yml config files by adding a comment like the following: 

# yaml-language-server: $schema=https://cxcli.xavidop.me/static/conversationtest.json\n

"},{"location":"conversationprofiler/examples/contains/","title":"Audio input","text":""},{"location":"conversationprofiler/examples/contains/#suite-file","title":"Suite file","text":"
# suite.yaml\n\nname: Example Suite\ndescription: Suite used as an example\nprojectId: test-cx-346408\nlocationId: us-central1\nagentName: test-agent\ntests:\n  - id: test_id\n    file: ./test.yaml\n
"},{"location":"conversationprofiler/examples/contains/#test-file","title":"Test file","text":"
# test.yaml\n\nname: Example test\ndescription: These are some tests\nlocaleId: en\ninteractions:\n  - id: test_1\n    user: \n      type: text\n      text: hi\n    agent:\n      validate:\n        - type: contains\n          value: hello\n

You can download the audio file used in this example here

"},{"location":"conversationprofiler/examples/prompt/","title":"Prompt example","text":""},{"location":"conversationprofiler/examples/prompt/#suite-file","title":"Suite file","text":"
# suite.yaml\n\nname: Example Suite\ndescription: Suite used as an example\nprojectId: test-cx-346408\nlocationId: us-central1\nagentName: test-agent\ntests:\n  - id: test_id\n    file: ./test.yaml\n
"},{"location":"conversationprofiler/examples/prompt/#test-file","title":"Test file","text":"
# test.yaml\n\nname: Example test\ndescription: These are some tests\nlocaleId: en\ninteractions:\n  - id: test_1_1\n    user: \n      type: prompt\n      prompt: give me a one line hello\n    agent:\n      validate:\n        - type: equals\n          value: hello\n
"},{"location":"conversationprofiler/examples/similarity/","title":"System entity detection example","text":""},{"location":"conversationprofiler/examples/similarity/#suite-file","title":"Suite file","text":"
# suite.yaml\n\nname: Example Suite\ndescription: Suite used as an example\nprojectId: test-cx-346408\nlocationId: us-central1\nagentName: test-agent\ntests:\n  - id: test_id\n    file: ./test.yaml\n
"},{"location":"conversationprofiler/examples/similarity/#test-file","title":"Test file","text":"
# test.yaml\n\nname: Example test\ndescription: These are some tests\nlocaleId: en\ninteractions:\n  - id: test_1_4\n    user: \n      type: text\n      text: hi\n    agent:\n      validate:\n        - type: similarity\n          algorithm: levenshtein\n          value: hello\n          threshold: 0.4\n          configuration-levenshtein:\n            casesensitive: false\n
"},{"location":"entitytypes/create/","title":"Create","text":""},{"location":"entitytypes/create/#usage","title":"Usage","text":"

You can find the create functionality within the cxcli entity-type create subcommand. You can read the documentation about this command here.

The argument to --entities is a list of the entities with their synonyms, comma separated. This parameter has the following format: 

entity1@synonym1|synonym2,entity2@synonym1|synonym2\n

An example entity type with synonyms: pikachu@25|pika,charmander@3

"},{"location":"entitytypes/create/#example","title":"Example","text":"

Here is a simple example of the cxcli entity-type create command:

cxcli entity-type create pokemon --entities \"pikachu@25|pika,charmander@3\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\n

The above command will give you output similar to the following:

$ cxcli entity-type create pokemon --entities \"pikachu@25|pika,charmander@3\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\nINFO Entity Type created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/entityTypes/457a451d-f5ce-47da-b8dc-16b17d874a5d\n
"},{"location":"entitytypes/create/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX entity types creation, refer to the official documentation.

"},{"location":"entitytypes/delete/","title":"Delete","text":""},{"location":"entitytypes/delete/#usage","title":"Usage","text":"

You can find the delete functionality within the cxcli entity-type delete subcommand. You can read the documentation about this command here.

"},{"location":"entitytypes/delete/#example","title":"Example","text":"

Here is a simple example of the cxcli entity-type delete command:

cxcli entity-type delete pokemon2  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\n

The above command will give you output similar to the following:

$ cxcli entity-type delete pokemon2  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\nINFO Entity Type deleted\n
"},{"location":"entitytypes/delete/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX entity types deletion, refer to the official documentation.

"},{"location":"entitytypes/introduction/","title":"Entity types","text":""},{"location":"entitytypes/introduction/#what-is-this","title":"What is this?","text":"

One of the most important aspects of natural language understanding is entity types or entities. Entities contain the important factors within a message such as names, dates, products, organizations, places, or anything that we want to extract from the message. We call this concept \u201centities\u201d. For example, let's take a look at the order_intent intent:

  1. I want a pizza
  2. I want 3 cokes
  3. Give me two burgers

As you can see in the example above, we can extract two entity Types: quantity and order_type. We can represent the entities within the above utterances as:

  1. I want {quantity} {order_type}
  2. Give me {quantity} {order_type}

We can also think of entity types as variables.

With cxcli, you can easily interact with your Dialogflow CX entity types.

All of the commands that you have available in cxcli to interact with your entity types are located within the cxcli entity-type subcommand.

"},{"location":"entitytypes/introduction/#create","title":"Create","text":"

The cxcli has a command that allows you to create an entity type. You can find a more detailed information here.

"},{"location":"entitytypes/introduction/#update","title":"Update","text":"

The cxcli has a command that allows you to update an entity type. You can find a more detailed information here.

"},{"location":"entitytypes/introduction/#delete","title":"Delete","text":"

The cxcli has a command that allows you to delete your entity type. You can find a more detailed explanation here.

"},{"location":"entitytypes/introduction/#useful-links","title":"Useful Links","text":"

If you want to see the full usage of the cxcli entity-type command, please refer to this page.

If you want to learn more about Dialogflow CX entity types, refer to the official documentation.

"},{"location":"entitytypes/update/","title":"Update","text":""},{"location":"entitytypes/update/#usage","title":"Usage","text":"

You can find the update functionality within the cxcli entity-type update subcommand. You can read the documentation about this command here.

The argument to --entities is a list of the entities with their synonyms, comma separated. This parameter has the following format: 

entity1@synonym1|synonym2,entity2@synonym1|synonym2\n

An example entity type with synonyms: pikachu@25|pika,charmander@3

"},{"location":"entitytypes/update/#example","title":"Example","text":"

Here is a simple example of the cxcli entity-type update command:

cxcli entity-type update pokemon --entities \"pikachu@25|pika,charmander@3\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\n

The above command will give you output similar to the following:

$ cxcli entity-type update pokemon --entities \"pikachu@25|pika,charmander@3\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\nINFO Entity Type updated\n
"},{"location":"entitytypes/update/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX entity types update, refer to the official documentation.

"},{"location":"environments/cicd/","title":"Environments CI/CD","text":""},{"location":"environments/cicd/#usage","title":"Usage","text":"

You can find the CI/CD functionality within the cxcli environment execute-cicd subcommand. You can read the documentation about this command here.

"},{"location":"environments/cicd/#example","title":"Example","text":"

Here is a simple example of the cxcli environment execute-cicd command:

cxcli environment execute-cicd cicd-env --project-id test-cx-346408 --location-id us-central1 --agent-name test-agent\n

The above command will give you output similar to the following:

$ cxcli environment execute-cicd cicd-env --project-id test-cx-346408 --location-id us-central1 --agent-name test-agent\nINFO Executing cicd for environment cicd-env\nINFO PASSED\n

Are you running this command in a CI/CD pipeline?

If this is the case, we recommend that you set the --output-format parameter to json.

"},{"location":"environments/cicd/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX CI/CD execution, refer to the official documentation.

"},{"location":"environments/create/","title":"Create","text":""},{"location":"environments/create/#usage","title":"Usage","text":"

You can find the create functionality within the cxcli environment create subcommand. You can read the documentation about this command here.

The --flow-versions parameter is a list of flows and their versions to include in the environment, comma separated. For each flow used in this environment, it is required to add the version with this format: @flow-version. This is the full format:

flow@flow-version\n

An example of flows with their versions:

Default Start Flow@production_v2,Test Flow@v1.0.0\n
"},{"location":"environments/create/#example","title":"Example","text":"

Here is a simple example of using the cxcli environment create command:

cxcli environment create my-env --flow-versions \"Default Start Flow@production_v2,Test Flow@v1.0.0\"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\n

The above command will give you output similar to the following:

$ cxcli environment create my-env --flow-versions \"Default Start Flow@production_v2,Test Flow@v1.0.0\"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\nINFO Environment created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/environments/9f9cf42a-9033-4d73-9407-613d041c9403\n
"},{"location":"environments/create/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX environment creation, refer to the official documentation.

"},{"location":"environments/delete/","title":"Delete","text":""},{"location":"environments/delete/#usage","title":"Usage","text":"

You can find the delete functionality within the cxcli environment delete subcommand. You can read the documentation about this command here.

"},{"location":"environments/delete/#example","title":"Example","text":"

Here is a simple example of the cxcli environment delete command:

cxcli environment delete my-env --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\n

The above command will give you output similar to the following:

$ cxcli environment delete my-env --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\nINFO Environment deleted\n
"},{"location":"environments/delete/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX environment deletion, refer to the official documentation.

"},{"location":"environments/introduction/","title":"Environments","text":""},{"location":"environments/introduction/#what-is-this","title":"What is this?","text":"

In software, it is a common pattern (and a best practice) to have different environments where developers can deploy different versions of their software. Each environment has its own configuration.

Dialogflow CX follows the same concept in that you can create a version of your agent and then deploy it to a specific environment. This is also similar to a webhook in that you can deploy a specific webhook version and use that version within an environment.

With cxcli, you can easily interact with the environments of your Dialogflow CX agents.

All of the commands that you have available in cxcli to interact with your environments are located within the cxcli environment subcommand.

"},{"location":"environments/introduction/#create","title":"Create","text":"

The cxcli has a command that allows you to create an environment. You can find a more detailed information here.

"},{"location":"environments/introduction/#update","title":"Update","text":"

The cxcli has a command that allows you to update an environment. You can find a more detailed information here.

"},{"location":"environments/introduction/#delete","title":"Delete","text":"

The cxcli has a command that allows you to delete your environment. You can find a more detailed explanation here.

"},{"location":"environments/introduction/#cicd","title":"CI/CD","text":"

In Dialogflow CX, when you are testing your agents, you can save those tests and associate them with a specific environment.

The cxcli tool has a command that allows you to run these CI/CD pipelines from your terminal or from your CI processes. You can find a more detailed explanation here.

"},{"location":"environments/introduction/#useful-links","title":"Useful Links","text":"

If you want to see the full usage of the cxcli environment command, please refer to this page.

If you want to learn more about Dialogflow CX environments, refer to the official documentation.

"},{"location":"environments/update/","title":"Update","text":""},{"location":"environments/update/#usage","title":"Usage","text":"

You can find the update functionality within the cxcli environment update subcommand. You can read the documentation about this command here.

The --flow-versions parameter is a list of flows and their versions to include in the environment, comma separated. For each flow used in this environment, it is required to add the version with this format: @flow-version. This is the full format:

flow@flow-version\n

An example of flows with their versions:

Default Start Flow@production_v2,Test Flow@v1.0.0\n
"},{"location":"environments/update/#example","title":"Example","text":"

Here is a simple example of the cxcli entity-type update command:

cxcli environment update my-env --flow-versions \"Default Start Flow@production_v3,Test Flow@v1.1.0\"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description \"This is a test environment\"\n

The above command will give you output similar to the following:

$ cxcli environment update my-env --flow-versions \"Default Start Flow@production_v3,Test Flow@v1.1.0\"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description \"This is a test environment\"\nINFO Environment updated\n
"},{"location":"environments/update/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX environment update, refer to the official documentation.

"},{"location":"flows/create/","title":"Create","text":""},{"location":"flows/create/#usage","title":"Usage","text":"

You can find the create functionality within the cxcli flow create subcommand. You can read the documentation about this command here.

"},{"location":"flows/create/#example","title":"Example","text":"

Here is a simple example of using the cxcli flow create command:

cxcli flow create my-flow --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description \"My test flow\"\n

The above command will give you output similar to the following:

$ cxcli flow create my-flow --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description \"My test flow\"\nINFO Flow created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/flows/49a38c72-2a63-4d71-a266-2d722eb8360e\n
"},{"location":"flows/create/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX flow creation, refer to the official documentation.

"},{"location":"flows/delete/","title":"Delete","text":""},{"location":"flows/delete/#usage","title":"Usage","text":"

You can find the delete functionality within the cxcli flow delete subcommand. You can read the documentation about this command here.

"},{"location":"flows/delete/#example","title":"Example","text":"

Here is a simple example of the cxcli flow delete command:

cxcli flow delete my-flow --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\n

The above command will give you output similar to the following:

$ cxcli flow delete my-flow --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\nINFO Flow deleted\n
"},{"location":"flows/delete/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX flow deletion, refer to the official documentation.

"},{"location":"flows/introduction/","title":"Flows","text":""},{"location":"flows/introduction/#what-is-this","title":"What is this?","text":"

In intricate conversations, various topics come into play. Take, for example, a flight book service, where a dialogue may cover areas like seat booking a meal reservation, obtaining customer information, and confirming the booking. Each of these topics requires multiple interactions between the agent and the end-user to gather the necessary information.

Flows are employed to delineate these topics and their respective conversational paths. Each agent is equipped with a default start flow, which serves as a foundation for simple agents.

With cxcli, you can easily interact with the flows of your Dialogflow CX agents.

All of the commands that you have available in cxcli to interact with your flows are located within the cxcli flow subcommand.

"},{"location":"flows/introduction/#create","title":"Create","text":"

The cxcli has a command that allows you to create a flow. You can find a more detailed information here.

"},{"location":"flows/introduction/#update","title":"Update","text":"

The cxcli has a command that allows you to update a flow. You can find a more detailed information here.

"},{"location":"flows/introduction/#delete","title":"Delete","text":"

The cxcli has a command that allows you to delete your flow. You can find a more detailed explanation here.

"},{"location":"flows/introduction/#train","title":"Train","text":"

In Dialogflow CX, when you are adding training phrases to your intents and synonyms to your entity types, you will need to train your agent in order to have the latest changes ready for your end-users.

The cxcli tool has a command that allows you train your flow from your terminal or from your CI processes. You can find a more detailed explanation here.

"},{"location":"flows/introduction/#useful-links","title":"Useful Links","text":"

If you want to see the full usage of the cxcli flow command, please refer to this page.

If you want to learn more about Dialogflow CX flows, refer to the official documentation.

"},{"location":"flows/train/","title":"Train","text":""},{"location":"flows/train/#usage","title":"Usage","text":"

You can find the train functionality within the cxcli flow train subcommand. You can read the documentation about this command here.

"},{"location":"flows/train/#example","title":"Example","text":"

Here is a simple example of the cxcli flow train command:

cxcli flow train my-flow --project-id test-cx-346408 --location-id us-central1 --agent-name test-agent\n

The above command will give you output similar to the following:

$ cxcli flow train my-flow --project-id test-cx-346408 --location-id us-central1 --agent-name test-agent\nINFO Flow trained\n

Is it taking longer than expected?

That is okay, depending on the amount of data to train it takes longer.

"},{"location":"flows/train/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX flow train execution, refer to the official documentation.

"},{"location":"flows/update/","title":"Update","text":""},{"location":"flows/update/#usage","title":"Usage","text":"

You can find the update functionality within the cxcli flow update subcommand. You can read the documentation about this command here.

"},{"location":"flows/update/#example","title":"Example","text":"

Here is a simple example of the cxcli flow update command:

cxcli flow update my-flow --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description \"My updated test flow\"\n

The above command will give you output similar to the following:

$ cxcli flow update my-flow --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description \"My updated test flow\"\nINFO Flow updated\n
"},{"location":"flows/update/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX flow update, refer to the official documentation.

"},{"location":"flowversions/create/","title":"Create","text":""},{"location":"flowversions/create/#usage","title":"Usage","text":"

You can find the create functionality within the cxcli flow-version create subcommand. You can read the documentation about this command here.

"},{"location":"flowversions/create/#example","title":"Example","text":"

Here is a simple example of using the cxcli flow-version create command:

cxcli flow-version create \"v1.0.0\" --start-flow \"Test Flow\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description \"My flow version\"\n

The above command will give you output similar to the following:

$ cxcli flow-version create \"v1.0.0\" --start-flow \"Test Flow\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description \"My flow version\"\nINFO Version created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/flows/b23e0247-2dd4-4d86-a23a-a289569480d4/versions/6\n

Is it taking longer than expected?

That is okay, depending on the size of the flow it takes longer.

"},{"location":"flowversions/create/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX flow version creation, refer to the official documentation.

"},{"location":"flowversions/delete/","title":"Delete","text":""},{"location":"flowversions/delete/#usage","title":"Usage","text":"

You can find the delete functionality within the cxcli flow-version delete subcommand. You can read the documentation about this command here.

"},{"location":"flowversions/delete/#example","title":"Example","text":"

Here is a simple example of the cxcli flow-version delete command:

cxcli flow-version delete \"v1.0.0\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\n

The above command will give you output similar to the following:

$ cxcli flow-version delete \"v1.0.0\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\nINFO Version deleted\n
"},{"location":"flowversions/delete/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX flow version deletion, refer to the official documentation.

"},{"location":"flowversions/introduction/","title":"Flow Versions","text":""},{"location":"flowversions/introduction/#what-is-this","title":"What is this?","text":"

It is possible to generate various iterations of your agent flows and deploy them to distinct serving environments.

When making modifications to a flow, you are essentially modifying a draft version. At any given time, you have the option to save a draft flow as a flow version. A flow version represents an unchangeable snapshot of your flow data along with all the related agent data, such as intents, entities, webhooks, pages, route groups, and more.

Furthermore, You can deploy this flow versions to different environments, such as development, test, and production. You can also deploy the same flow version to multiple environments.

With cxcli, you can easily interact with the flow versions of your Dialogflow CX agents.

All of the commands that you have available in cxcli to interact with your flows are located within the cxcli flow-version subcommand.

"},{"location":"flowversions/introduction/#create","title":"Create","text":"

The cxcli has a command that allows you to create a flow versions. You can find a more detailed information here.

"},{"location":"flowversions/introduction/#update","title":"Update","text":"

The cxcli has a command that allows you to update a flow versions. You can find a more detailed information here.

"},{"location":"flowversions/introduction/#delete","title":"Delete","text":"

The cxcli has a command that allows you to delete your flow versions. You can find a more detailed explanation here.

"},{"location":"flowversions/introduction/#useful-links","title":"Useful Links","text":"

If you want to see the full usage of the cxcli flow-version command, please refer to this page.

If you want to learn more about Dialogflow CX flows, refer to the official documentation.

"},{"location":"flowversions/update/","title":"Update","text":""},{"location":"flowversions/update/#usage","title":"Usage","text":"

You can find the update functionality within the cxcli flow-version update subcommand. You can read the documentation about this command here.

"},{"location":"flowversions/update/#example","title":"Example","text":"

Here is a simple example of the cxcli flow update command:

cxcli flow-version update \"v1.0.0\" --start-flow \"Test Flow\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description \"My updated flow version\"\n

The above command will give you output similar to the following:

$ cxcli flow-version update \"v1.0.0\" --start-flow \"Test Flow\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --description \"My updated flow version\"\nINFO Version updated\n
"},{"location":"flowversions/update/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX flow version update, refer to the official documentation.

"},{"location":"generators/create/","title":"Create","text":""},{"location":"generators/create/#usage","title":"Usage","text":"

You can find the create functionality within the cxcli generator create subcommand. You can read the documentation about this command here.

If you want to create a generator, you have to set the --prompt parameter. This parameter is the prompt that will be used to generate the responses. You can use placeholders in the prompt to pass parameters to the generator. The parameters can be extracted from the user's input, or from the agent's session parameters.

The placeholders have the following format: $parameter-name. For example: 

Give a warm welcome to the user with name $name\n

"},{"location":"generators/create/#example","title":"Example","text":"

Here is a simple example of using the cxcli generator create command:

cxcli generator create my-generator --prompt \"Give a warm welcome to the user with name $name\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 \n

The above command will give you output similar to the following:

$ cxcli generator create my-generator --prompt \"Give a warm welcome to the user with name $name\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 \n[INFO] Generator created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/generators/03b0a452-997c-40dc-afa2-6bef917d224f\n
"},{"location":"generators/create/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX generator creation, refer to the official documentation.

"},{"location":"generators/delete/","title":"Delete","text":""},{"location":"generators/delete/#usage","title":"Usage","text":"

You can find the delete functionality within the cxcli generator delete subcommand. You can read the documentation about this command here.

"},{"location":"generators/delete/#example","title":"Example","text":"

Here is a simple example of the cxcli generator delete command:

cxcli generator delete my-generator --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\n

The above command will give you output similar to the following:

$ cxcli generator delete my-generator --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\nINFO Generator deleted\n
"},{"location":"generators/delete/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX generator deletion, refer to the official documentation.

"},{"location":"generators/introduction/","title":"Generators","text":""},{"location":"generators/introduction/#what-is-this","title":"What is this?","text":"

Generators use Google's latest generative large language models (LLMs), and prompts that you provide, to generate agent behavior and responses at runtime. The available models are provided by Vertex AI.

You can pass parameters to the generators using placeholders in the prompts. The parameters can be extracted from the user's input, or from the agent's session parameters.

This is an example of a generator prompt:

Give a warm welcome to the user\n

And this is an example of a generator prompt with a placeholder:

Give a warm welcome to the user with name $name\n

With cxcli, you can easily interact with the generators of your Dialogflow CX agents.

All of the commands that you have available in cxcli to interact with your generators are located within the cxcli generator subcommand.

"},{"location":"generators/introduction/#create","title":"Create","text":"

The cxcli has a command that allows you to create a generator. You can find a more detailed information here.

"},{"location":"generators/introduction/#update","title":"Update","text":"

The cxcli has a command that allows you to update a generator. You can find a more detailed information here.

"},{"location":"generators/introduction/#delete","title":"Delete","text":"

The cxcli has a command that allows you to delete a generator. You can find a more detailed explanation here.

"},{"location":"generators/introduction/#useful-links","title":"Useful Links","text":"

If you want to see the full usage of the cxcli generator command, please refer to this page.

If you want to learn more about Dialogflow CX generators, refer to the official documentation.

"},{"location":"generators/update/","title":"Update","text":""},{"location":"generators/update/#usage","title":"Usage","text":"

You can find the update functionality within the cxcli generator update subcommand. You can read the documentation about this command here.

If you want to update a generator, you have to set the --prompt parameter. This parameter is the prompt that will be used to generate the responses. You can use placeholders in the prompt to pass parameters to the generator. The parameters can be extracted from the user's input, or from the agent's session parameters.

The placeholders have the following format: $parameter-name. For example: 

Give a warm welcome to the user with name $name\n

"},{"location":"generators/update/#example","title":"Example","text":"

Here is a simple example of the cxcli generator update command:

cxcli generator update my-generator --prompt \"Give a warm farewell to the user with name $name\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 \n

The above command will give you output similar to the following:

$ cxcli generator update my-generator --prompt \"Give a warm farewell to the user with name $name\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 \nINFO Generator updated\n
"},{"location":"generators/update/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX generator update, refer to the official documentation.

"},{"location":"intents/create/","title":"Create","text":""},{"location":"intents/create/#usage","title":"Usage","text":"

You can find the create functionality within the cxcli intent create subcommand. You can read the documentation about this command here.

The --training-phrases parameter is a list of the training phrases for this intent, comma separated. For the entities used in this intent, add @entity-type to the word in the training phrase. This is the format:

word@entity-type\n

An example training phrase with a entity: hello, hi how are you today@sys.date, morning!

"},{"location":"intents/create/#example","title":"Example","text":"

Here is a simple example of using the cxcli intent create command:

cxcli intent create test_intent --training-phrases \"hello, hi how are you today@sys.date, morning\"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\n

The above command will give you output similar to the following:

$ cxcli intent create test_intent --training-phrases \"hello, hi how are you today@sys.date, morning\"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\nINFO Intent created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/intents/a7870357-e942-43dd-99d2-4de8c81a3c09\n
"},{"location":"intents/create/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX intent creation, refer to the official documentation.

"},{"location":"intents/delete/","title":"Delete","text":""},{"location":"intents/delete/#usage","title":"Usage","text":"

You can find the delete functionality within the cxcli intent delete subcommand. You can read the documentation about this command here.

"},{"location":"intents/delete/#example","title":"Example","text":"

Here is a simple example of the cxcli intent delete command:

cxcli intent delete test_intent --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\n

The above command will give you output similar to the following:

$ cxcli intent delete test_intent --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\nINFO Intent deleted\n
"},{"location":"intents/delete/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX intent deletion, refer to the official documentation.

"},{"location":"intents/introduction/","title":"Intent","text":""},{"location":"intents/introduction/#what-is-this","title":"What is this?","text":"

Before we discuss intents, it is important to first understand what is natural language understanding (NLU). Natural language understanding is a subset of natural language processing (NLP). It helps a \"machine\" to be able to understand human language.

In Dialogflow CX, this is an important concept, since it will help predict the user's intention and allow us to act in a \"smarter\" way, and avoid the all-too-common default fallback intent: \"I did not understand you, could you repeat?\".

We refer to these intentions, proposals, or user requests that machine must classify as \"intents\". Each intent has training phrases. For example, the default welcome_intent intent can contain these three training phrases:

  1. Hi
  2. Hello
  3. Whats up!

As you can see in the example above, the purpose of the welcome_intent intent is to start a conversation when a user says any of these training phrases. An intent can have multiple entities.

Whenever you create, modify, or delete an intent, it is important to re-train your Dialogflow CX flows. This will re-train your NLU model. By doing this, your bot will \"understand you\", including your latest changes.

With cxcli, you can easily interact with your Dialogflow CX intents.

All of the commands that you have available in cxcli to interact with your intents are located within the cxcli intents subcommand.

"},{"location":"intents/introduction/#create","title":"Create","text":"

The cxcli has a command that allows you to create an intent. You can find a more detailed explanation here

"},{"location":"intents/introduction/#update","title":"Update","text":"

The cxcli has a command that allows you to update an intent. You can find a more detailed explanation here

"},{"location":"intents/introduction/#delete","title":"Delete","text":"

The cxcli has a command that allows you to delete your intents. You can find a more detailed explanation here

"},{"location":"intents/introduction/#useful-links","title":"Useful Links","text":"

If you want to see the full usage of the cxcli intents command, please refer to this page.

If you want to learn more about Dialogflow CX intents, refer to the official documentation.

"},{"location":"intents/update/","title":"Update","text":""},{"location":"intents/update/#usage","title":"Usage","text":"

You can find the update functionality within the cxcli intent update subcommand. You can read the documentation about this command here.

The --training-phrases parameter is a list of the training phrases for this intent, comma separated. For the entities used in this intent, add @entity-type to the word in the training phrase. This is the format:

word@entity-type\n

An example training phrase with a entity: hello, hi how are you today@sys.date, morning!

"},{"location":"intents/update/#example","title":"Example","text":"

Here is a simple example of using the cxcli intent update command:

cxcli intent update test_intent --training-phrases \"hello, hi how are you today@sys.date, morning\"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\n

The above command will give you output similar to the following:

$ cxcli intent update test_intent --training-phrases \"hello, hi how are you today@sys.date, morning\"  --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\nINFO Intent updated\n
"},{"location":"intents/update/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX intent update, refer to the official documentation.

"},{"location":"nluprofiler/examples/","title":"Examples","text":""},{"location":"nluprofiler/examples/#simple","title":"Simple","text":"

Simple example that demonstrates the NLU Profiler in action. Find it here

"},{"location":"nluprofiler/examples/#system-entity-detection","title":"System entity detection","text":"

Example that shows how to validate Dialogflow CX built-in entities. Find it here

"},{"location":"nluprofiler/examples/#text-input-with-entities","title":"Text input with entities","text":"

Full example with multiple user-defined entities and Dialogflow CX built-in entities. Find it here

"},{"location":"nluprofiler/examples/#prompt","title":"Prompt","text":"

Example that shows how to use a prompt as an user input Dialogflow CX. Find it here

"},{"location":"nluprofiler/examples/#audio-input","title":"Audio input","text":"

Example using an audio file as an input. Find it here

"},{"location":"nluprofiler/introduction/","title":"NLU profiler","text":""},{"location":"nluprofiler/introduction/#what-is-this","title":"What is this?","text":"

Use the NLU Profiler to test user utterances and improve your agent's interaction model.

With the NLU Profiler, you can see how utterances resolve to intents and slots in your interaction model. When an utterance doesn't resolve to the right intent or slot, you can update the interaction model and try again. With the cxcli, you can see which intents Dialogflow CX considered and discarded. Then, you can determine how to use additional samples to train your model to resolve utterances to their desired intents and slots.

Every suite is executed in the Dialogflow CX session so you can test not only your NLU but also a conversation itself.

All of the commands that are available in cxcli to execute the NLU profiler are located within the cxcli profile-nlu subcommand.

"},{"location":"nluprofiler/introduction/#reference","title":"Reference","text":"

It is important to know which suites and tests you can build. Because of that, you can find the entire reference on the Reference page. Suites and test are defined as yaml files.

The cxcli has a command that allows you to run these suites from your terminal or from your CI pipelines.

To execute a suite, you can run the cxcli profile-nlu execute command. For the usage, please refer to this page.

"},{"location":"nluprofiler/introduction/#examples","title":"Examples","text":"

You can find some useful examples on our GitHub repo and the Examples page.

"},{"location":"nluprofiler/introduction/#execution-example","title":"Execution Example","text":"

Here is a simple example of the cxcli profile-nlu execute command:

cxcli profile-nlu execute examples/profilenlu/suite.yaml\n

The above command will give you output similar to the following:

$ cxcli profile-nlu execute suite.yaml\n[INFO] Running suite: Example NLU Profiler Suite\n[INFO][test-file:test_1][check:test_1_1][input:prompt] User> hi (auto-generated from prompt: \"give me a one line hello without exclamation mark using only 2 characters and lowercase\")\n[INFO][test-file:test_1][check:test_1_1][input:prompt] Agent> Hi! How are you doing?\n[INFO][test-file:test_1][check:test_1_1][validation:hi_intent] Intent Detected: hi_intent\n[INFO][test-file:test_1][check:test_1_2][input:text] User> hello\n[INFO][test-file:test_1][check:test_1_2][input:text] Agent> Hi! How are you doing?\n[INFO][test-file:test_1][check:test_1_2][validation:hi_intent] Intent Detected: hi_intent\n[INFO][test-file:test_1][check:test_1_3][input:audio] User> ./audio/hi.mp3\n[INFO][test-file:test_1][check:test_1_3][input:audio] Agent> Hi! How are you doing?\n[INFO][test-file:test_1][check:test_1_3][validation:hi_intent] Intent Detected: hi_intent\n[INFO][test-file:test_2][check:test_2_1][input:text] User> I want 3 pizzas\n[INFO][test-file:test_2][check:test_2_1][input:text] Agent> \n[INFO][test-file:test_2][check:test_2_1][validation:order_intent] Intent Detected: order_intent\n[INFO][test-file:test_2][check:test_2_1][validation:order_intent] Param order_type: pizza \n[INFO][test-file:test_2][check:test_2_1][validation:order_intent] Param number: 3 \n[INFO][test-file:test_2][check:test_2_2][input:text] User> I want 2 cokes\n[INFO][test-file:test_2][check:test_2_2][input:text] Agent> \n[INFO][test-file:test_2][check:test_2_2][validation:order_intent] Intent Detected: order_intent\n[INFO][test-file:test_2][check:test_2_2][validation:order_intent] Param number: 2 \n[INFO][test-file:test_2][check:test_2_2][validation:order_intent] Param order_type: coke \n

Are you running this command in a CI/CD pipeline?

If this is the case, we recommend that you set the --output-format parameter to json.

"},{"location":"nluprofiler/suites/","title":"Suites","text":""},{"location":"nluprofiler/suites/#reference","title":"Reference","text":"

A suite is a yaml file with the following structure:

# suite.yaml\n\n# Name of the suite.\nname: Example Suite\n# Brief description of the suite.\ndescription: Suite used as an example\n# Project ID on Google Cloud where is located your Dialogflow CX agent.\nprojectId: test-cx-346408\n# Location where your Dialogflow CX agent is running. \n# More info here: https://cloud.google.com/dialogflow/cx/docs/concept/region\nlocationId: us-central1\n# Agent name of your Dialogflow CX agent.\n# Notice: it is the agent name, not the agent ID.\nagentName: test-agent\n# You can have multiple tests defined in separated files\ntests:\n  # ID of the test.\n  - id: test_id\n    # File where the test specification is located\n    file: ./test.yaml\n

It has the same structure as the Conversation Profiler suite.

"},{"location":"nluprofiler/suites/#json-schema","title":"JSON Schema","text":"

cxcli also has a jsonschema file, which you can use to have better editor support:

https://cxcli.xavidop.me/static/nlusuite.json\n

You can also specify it in your yml config files by adding a comment like the following: 

# yaml-language-server: $schema=https://cxcli.xavidop.me/static/nlusuite.json\n

"},{"location":"nluprofiler/tests/","title":"Tests","text":""},{"location":"nluprofiler/tests/#reference","title":"Reference","text":"

A test is a yaml file with the following structure:

# test.yaml\n\n# Name of the test.\nname: Example test\n# Brief description of the test.\ndescription: These are some tests\n# Locale of the interaction model that is gonna be tested.\n# You can find the locales here: https://cloud.google.com/dialogflow/cx/docs/reference/language\nlocaleId: en\n# A check is the test itself: given an input, you will validate the intents and the parameters/entities detected by Dialogflow CX\n# You can have multiple checks defined\nchecks:\n  # The ID of the check\n  - id: test\n    input:\n      # the input type\n      # it could be text or audio\n      type: text\n      # The input itself in text format. For type: audio, you have to specify the audio file.\n      text: I want 3 pizzas\n    validate:\n      # Intent that is supposed to be detected\n      intent: order_intent\n      # You can have multiple parameters/intents\n      # Notice: this could be empty if your intent does not have any entities/parameters.\n      parameters:\n        # Entity name that is supposed to be detected\n        - parameter: number\n          # Value that is supposed to be detected\n          value: 3\n
"},{"location":"nluprofiler/tests/#input-types","title":"Input types","text":""},{"location":"nluprofiler/tests/#text-input","title":"Text input","text":"

The input text is the simplest one. You just have to specify the text you want to send to Dialogflow CX. Make sure that the text is in the language you specified in the localeId field. to use this type you have to set the type field to text and the text field to the text you want to send.

"},{"location":"nluprofiler/tests/#audio-input","title":"Audio input","text":"

The audio input is a little bit more complex. You have to specify the path to the audio file you want to send to Dialogflow CX. Make sure that the audio file is in the language you specified in the localeId field. To use this type you have to set the type field to audio and the file field to the path to the audio file.

It is important to know that the input audio needs to have the following format:

  1. A sample rate of 16000 Hertz
  2. The audio encoding has to be Linear16. Linear16 is a 16-bit linear pulse-code modulation (PCM) encoding.

If you don't have a file with this format, you can create it by yourself using the cxcli tts command! All the information is located here

"},{"location":"nluprofiler/tests/#prompt-input","title":"Prompt input","text":"

The prompt input is the most complex one. You have to specify the input prompt you want to send to Dialogflow CX. To use this type you have to set the type field to prompt and the prompt field to the prompt you want to send.

It is important to know that the input prompt needs Vertex AI API to be enabled in your project and the proper permissions granted. You can find more information on the Authentication page.

"},{"location":"nluprofiler/tests/#validation-types","title":"Validation types","text":""},{"location":"nluprofiler/tests/#intent-validation","title":"Intent validation","text":"

The intent validation is the simplest one. You just have to specify the intent you want to validate. To use this type you have to set the intent field to the intent you want to validate:

validate:\n  # Intent that is supposed to be detected\n  intent: order_intent\n
"},{"location":"nluprofiler/tests/#parameter-validation","title":"Parameter validation","text":"

The parameter validation is a little bit more complex. You have to specify the parameters you want to validate and the values that are supposed to be detected. To use this type you have to set a list wit of parameters and each value must have the parameter field to the parameter you want to validate and the value field to the value that is supposed to be detected:

validate:\n  # Intent that is supposed to be detected\n  intent: order_intent\n  # You can have multiple parameters/intents\n  # Notice: this could be empty if your intent does not have any entities/parameters.\n  parameters:\n    # Entity name that is supposed to be detected\n    - parameter: number\n      # Value that is supposed to be detected\n      value: 3\n
"},{"location":"nluprofiler/tests/#json-schema","title":"JSON Schema","text":"

cxcli also has a jsonschema file, which you can use to have better editor support:

https://cxcli.xavidop.me/static/nlutest.json\n

You can also specify it in your yml config files by adding a comment like the following: 

# yaml-language-server: $schema=https://cxcli.xavidop.me/static/nlutest.json\n

"},{"location":"nluprofiler/examples/audio/","title":"Audio input","text":""},{"location":"nluprofiler/examples/audio/#suite-file","title":"Suite file","text":"
# suite.yaml\n\nname: Example Suite\ndescription: Suite used as an example\nprojectId: test-cx-346408\nlocationId: us-central1\nagentName: test-agent\ntests:\n  - id: test_id\n    file: ./test.yaml\n
"},{"location":"nluprofiler/examples/audio/#test-file","title":"Test file","text":"
# test.yaml\n\nname: Example test\ndescription: These are some tests\nlocaleId: en\nchecks:\n  - id: my_check\n    input: \n      type: audio\n      audio: ./audio/hi.mp3\n    validate:\n      intent: hi_intent\n

You can download the audio file used in this example here

"},{"location":"nluprofiler/examples/prompt/","title":"Prompt example","text":""},{"location":"nluprofiler/examples/prompt/#suite-file","title":"Suite file","text":"
# suite.yaml\n\nname: Example Suite\ndescription: Suite used as an example\nprojectId: test-cx-346408\nlocationId: us-central1\nagentName: test-agent\ntests:\n  - id: test_id\n    file: ./test.yaml\n
"},{"location":"nluprofiler/examples/prompt/#test-file","title":"Test file","text":"
# test.yaml\n\nname: Example test\ndescription: These are some tests\nlocaleId: en\nchecks:\n  - id: my_first_check\n    input: \n      type: prompt\n      prompt: give me a one line hello without exclamation mark using only 2 characters and lowercase\n    validate:\n      intent: hi_intent\n\n  - id: my_second_check\n    input: \n      type: text\n      text: hello\n    validate:\n      intent: hi_intent\n
"},{"location":"nluprofiler/examples/simple/","title":"Simple example","text":""},{"location":"nluprofiler/examples/simple/#suite-file","title":"Suite file","text":"
# suite.yaml\n\nname: Example Suite\ndescription: Suite used as an example\nprojectId: test-cx-346408\nlocationId: us-central1\nagentName: test-agent\ntests:\n  - id: test_id\n    file: ./test.yaml\n
"},{"location":"nluprofiler/examples/simple/#test-file","title":"Test file","text":"
# test.yaml\n\nname: Example test\ndescription: These are some tests\nlocaleId: en\nchecks:\n  - id: my_first_check\n    input: \n      type: text\n      text: hi\n    validate:\n      intent: hi_intent\n\n  - id: my_second_check\n    input: \n      type: text\n      text: hello\n    validate:\n      intent: hi_intent\n
"},{"location":"nluprofiler/examples/system/","title":"System entity detection example","text":""},{"location":"nluprofiler/examples/system/#suite-file","title":"Suite file","text":"
# suite.yaml\n\nname: Example Suite\ndescription: Suite used as an example\nprojectId: test-cx-346408\nlocationId: us-central1\nagentName: test-agent\ntests:\n  - id: test_id\n    file: ./test.yaml\n
"},{"location":"nluprofiler/examples/system/#test-file","title":"Test file","text":"
# test.yaml\n\nname: Example test\ndescription: These are some tests\nlocaleId: en\nchecks:\n  - id: my_check\n    input: \n      type: text\n      text: please, give me 3\n    validate:\n      intent: finish_order_intent\n      parameters:\n        - parameter: number\n          value: 3\n
"},{"location":"nluprofiler/examples/text/","title":"Text input with parameters example","text":""},{"location":"nluprofiler/examples/text/#suite-file","title":"Suite file","text":"
# suite.yaml\n\nname: Example Suite\ndescription: Suite used as an example\nprojectId: test-cx-346408\nlocationId: us-central1\nagentName: test-agent\ntests:\n  - id: test_id\n    file: ./test.yaml\n
"},{"location":"nluprofiler/examples/text/#test-file","title":"Test file","text":"
# test.yaml\n\nname: Example test\ndescription: These are some tests\nlocaleId: en\nchecks:\n  - id: my_first_check\n    input: \n      type: text\n      text: I want 3 pizzas\n    validate:\n      intent: order_intent\n      parameters:\n        - parameter: number\n          value: 3\n        - parameter: order_type\n          value: pizza\n\n  - id: my_second_check\n    input: \n      type: text\n      text: I want 2 cokes\n    validate:\n      intent: order_intent\n      parameters:\n        - parameter: number\n          value: 2\n        - parameter: order_type\n          value: coke\n
"},{"location":"overview/authentication/","title":"Authentication","text":"

cxcli uses various Google Cloud APIs. By default, the tool uses the default configuration that uses the gcloud cli. If you want to use another authentication key you can provide a json file with the global --credentials parameter.

The cxcli source code is open source, you can check it out here to learn more about the actions the tool performs.

Below you can find the roles and the APIs that are required to use this tool.

"},{"location":"overview/authentication/#roles-needed","title":"Roles needed","text":""},{"location":"overview/authentication/#dialogflow-cx","title":"Dialogflow CX","text":"

Dialogflow API Admin: Provides full access to create, update, query, detect intent, and delete the agent from the console or API. Click here for more information.

We are using the Admin role because cxcli performs the List agent action.

This role allows you to execute Speech-to-text and Text-to-speech actions

"},{"location":"overview/authentication/#apis-enabled-needed","title":"APIs enabled needed","text":"

The following APIs should be enabled on your Google Cloud project if you want to use the respective cxcli capabilities:

"},{"location":"overview/authentication/#dialogflow-cx_1","title":"Dialogflow CX","text":"

You will need to enable the Dialogflow API on your project. More information here

"},{"location":"overview/authentication/#speech-to-text","title":"Speech-to-text","text":"

You will need to enable the Cloud Speech-to-Text API on your project. More information here

"},{"location":"overview/authentication/#text-to-speech","title":"Text-to-speech","text":"

You will need to enable the Cloud Text-to-Speech API on your project. More information here

"},{"location":"overview/authentication/#generative-ai-on-vertex-ai","title":"Generative AI on Vertex AI","text":"

You will need to enable the Vertex AI API on your project. More information here

"},{"location":"overview/faq/","title":"Frequently Asked Questions (FAQ)","text":""},{"location":"overview/faq/#how-does-it-work","title":"How does it work?","text":"

cxcli has three main purposes:

  1. Make the interaction with your Dialogflow CX agents from your laptop or your continuous integration pipelines easier than ever
  2. Create testing tools that will help users build their Dialogflow CX agent
  3. Interact with other Google Cloud APIs such as TTS and STT in a very easy way
"},{"location":"overview/faq/#who-is-cxcli-for","title":"Who is cxcli for?","text":"

cxcli is primarily for software engineering teams who are currently using Dialogflow CX. It is recommended for machine learning engineers that usually work with STT, TTS, NLU and NLP technologies.

"},{"location":"overview/faq/#what-kind-of-machinescontainers-do-i-need-for-the-cxcli","title":"What kind of machines/containers do I need for the cxcli?","text":"

You'll need either: a bare-metal host (your own, AWS i3.metal or Equinix Metal) or a VM that supports nested virtualisation such as those provided by Google Cloud, Azure, AWS DigitalOcean, etc. or a Linux or Windows container.

"},{"location":"overview/faq/#when-will-jenkins-gitlab-ci-bitbucket-pipeline-runners-drone-or-azure-devops-be-supported","title":"When will Jenkins, GitLab CI, BitBucket Pipeline Runners, Drone or Azure DevOps be supported?","text":"

For the current phase, we're targeting GitHub Actions because it has fine-grained access controls and the ability to schedule exactly one build to a runner. The other CI systems will be available soon.

That said, if you're using these tools within your organisation, we'd like to hear from you. So feel free to reach out to us if you feel cxcli would be a good fit for your team.

Feel free to contact us at: dialogflowcxcli@gmail.com

"},{"location":"overview/faq/#what-kind-of-access-is-required-in-my-google-cloud-project","title":"What kind of access is required in my Google Cloud project?","text":"

Refer to the Authentication page here

"},{"location":"overview/faq/#can-cxcli-be-used-on-public-repos","title":"Can cxcli be used on public repos?","text":"

Yes, cxcli can be used on public and private repos.

"},{"location":"overview/faq/#whats-in-the-container-image-and-how-is-it-built","title":"What's in the Container image and how is it built?","text":"

The Container image contains uses alpine:latest and the cxcli installed on it.

The image is built automatically using GitHub Actions and is available on a container registry.

"},{"location":"overview/faq/#is-arm64-supported","title":"Is ARM64 supported?","text":"

Yes, cxcli is built to run on both Intel/AMD and ARM64 hosts. This includes a Raspberry Pi 4B, AWS Graviton, Oracle Cloud ARM instances and potentially any other ARM64 instances that support virtualisation.

"},{"location":"overview/faq/#are-windows-or-macos-supported","title":"Are Windows or macOS supported?","text":"

Yes, in addition to Linux, Windows and macOS are also supported platforms for cxcli at this time on a AMD64 or ARM64 architecture.

"},{"location":"overview/faq/#is-cxcli-free-and-open-source","title":"Is cxcli free and open-source?","text":"

cxcli is an open source tool, however, it interacts with Google Cloud APIs, so a Google Cloud account is required.

The website and documentation are available on GitHub and we plan to release some open source tools in the future for cxcli customers.

"},{"location":"overview/faq/#is-there-a-risk-that-we-could-get-locked-in-to-cxcli","title":"Is there a risk that we could get \"locked-in\" to cxcli?","text":"

No, you can switch back to using either the gcloud CLI tool or the Google Cloud APIs at any time. Keep in mind that cxcli not only solves for a certain set of issues with both of those approaches but also simplifies the interaction with Google Cloud.

"},{"location":"overview/faq/#why-is-the-brand-called-cxcli-and-dialogflow-cx-cli","title":"Why is the brand called \"cxcli\" and \"Dialogflow CX CLI\" ?","text":"

The name of the software is cxcli, in some places \"cxcli\" is not available, and we liked \"Dialogflow CX CLI\" because it refers to the what the tool does.

"},{"location":"overview/install/","title":"Install","text":"

You can use cxcli by installing a pre-compiled binary (in several ways), using Docker, or compiling it from source. In the below sections, you can find the steps for each approach.

"},{"location":"overview/install/#install-a-pre-compiled-binary","title":"Install a pre-compiled binary","text":""},{"location":"overview/install/#homebrew-tap","title":"homebrew tap","text":"
  1. Add the Homebrew tap: 
    brew tap xavidop/tap git@github.com:xavidop/homebrew-tap.git\nbrew update\n
  2. Install the Dialogflow CX CLI: 
    brew install cxcli\n
"},{"location":"overview/install/#snapcraft","title":"snapcraft","text":"
sudo snap install cxcli\n
"},{"location":"overview/install/#scoop","title":"scoop","text":"
scoop bucket add cxcli https://github.com/xavidop/scoop-bucket.git\nscoop install cxcli\n
"},{"location":"overview/install/#apt","title":"apt","text":"
echo 'deb [trusted=yes] https://apt.fury.io/xavidop/ /' | sudo tee /etc/apt/sources.list.d/cxcli.list\nsudo apt update\nsudo apt install cxcli\n
"},{"location":"overview/install/#yum","title":"yum","text":"
echo '[cxcli]\nname=Dialogflow CX CLI Repo\nbaseurl=https://yum.fury.io/xavidop/\nenabled=1\ngpgcheck=0' | sudo tee /etc/yum.repos.d/cxcli.repo\nsudo yum install cxcli\n
"},{"location":"overview/install/#aur","title":"aur","text":"
yay -S cxcli-bin\n
"},{"location":"overview/install/#nix","title":"nix","text":""},{"location":"overview/install/#nixpkgs","title":"nixpkgs","text":"
nix-env -iA cxcli\n

Info

The package in nixpkgs might be slightly outdated, as it is not updated automatically. Use our NUR to always get the latest updates.

"},{"location":"overview/install/#nur","title":"nur","text":"

First, you'll need to add our NUR to your nix configuration. You can follow the guides here.

Once you do that, you can install the packages.

{ pkgs, lib, ... }: {\n    home.packages = with pkgs; [\n    nur.repos.xavidop.cxcli\n    ];\n}\n
"},{"location":"overview/install/#deb-rpm-and-apk-packages","title":"deb, rpm and apk packages","text":"

Download the .deb, .rpm or .apk packages from the OSS releases page and install them with the appropriate tools.

"},{"location":"overview/install/#go-install","title":"go install","text":"
go install github.com/xavidop/dialogflow-cx-cli@latest\n
"},{"location":"overview/install/#bash-script","title":"bash script","text":"
curl -sfL https://cxcli.xavidop.me/static/run | bash\n
"},{"location":"overview/install/#additional-options","title":"Additional Options","text":"

You can also set the VERSION variable to specify a version instead of using latest.

You can also pass flags and args to cxcli:

curl -sfL https://cxcli.xavidop.me/static/run |\n    VERSION=__VERSION__ bash -s -- version\n

Tip

This script does not install anything, it just downloads, verifies and runs cxcli. Its purpose is to be used within scripts and CIs.

"},{"location":"overview/install/#manually","title":"manually","text":"

Download the pre-compiled binaries from the releases page and copy them to the desired location.

"},{"location":"overview/install/#verifying-the-artifacts","title":"Verifying the artifacts","text":""},{"location":"overview/install/#binaries","title":"binaries","text":"

All artifacts are checksummed, and the checksum file is signed with cosign.

  1. Download the files you want along with the checksums.txt, checksum.txt.pem, and checksums.txt.sig files from the releases page: 
    wget https://github.com/xavidop/dialogflow-cx-cli/releases/download/__VERSION__/checksums.txt\nwget https://github.com/xavidop/dialogflow-cx-cli/releases/download/__VERSION__/checksums.txt.sig\nwget https://github.com/xavidop/dialogflow-cx-cli/releases/download/__VERSION__/checksums.txt.pem\n
  2. Verify the signature: 
    COSIGN_EXPERIMENTAL=1 cosign verify-blob \\\n--cert checksums.txt.pem \\\n--signature checksums.txt.sig \\\nchecksums.txt\n
  3. If the signature is valid, you can then verify the SHA256 sums match with the downloaded binary: 
    sha256sum --ignore-missing -c checksums.txt\n
"},{"location":"overview/install/#docker-images","title":"docker images","text":"

Our Docker images are signed with cosign.

Verify the signatures:

COSIGN_EXPERIMENTAL=1 cosign verify xavidop/cxcli\n

Info

The .pem and .sig files are the image name:tag, replacing / and : with -.

"},{"location":"overview/install/#running-with-docker","title":"Running with Docker","text":"

You can also use cxcli within a Docker container. To do that, you'll need to execute something more-or-less like the examples below.

Registries:

  • xavidop/cxcli
  • ghcr.io/xavidop/cxcli

Example usage:

docker run --rm \\\n    xavidop/cxcli cxcli version\n

Note that the image will almost always have the last stable Go version.

If you need other packages and dependencies, you are encouraged to keep your own image. You can always use cxcli's own Dockerfile as a starting point and iterate on that.

"},{"location":"overview/install/#compiling-from-source","title":"Compiling from source","text":"

Here you have two options:

If you want to contribute to the project, please follow the steps on our contributing guide.

If you just want to build from source for whatever reason, follow these steps:

clone:

git clone https://github.com/xavidop/dialogflow-cx-cli\ncd dialogflow-cx-cli\n

get the dependencies:

go mod tidy\n

build:

go build -o cxcli .\n

verify that it works:

./cxcli version\n
"},{"location":"overview/roadmap/","title":"Roadmap","text":"

cxcli is in active development. The core product is functioning.

Our goal with the tool is to prove that there's market fit for a solution like this, and if so, we'll invest more time in automation, user experience, more features.

For now, if you're interested in participating and giving feedback, we believe cxcli already solves pain at this stage.

Shipped:

  • Available in homebrew, snapcraft, apt, yum, scoop, aur package managers
  • Documentation updated
  • Profile NLU
  • Speech-to-text and Text-to-speech actions
  • Container image available for multiple architectures
  • SBOM files created
  • Artifacts uploaded, signed and available on GitHub

Coming soon:

  • Continuous integration support (GitHub Action, CircleCI, etc.)
  • Flow import and export
  • Dialog from the terminal
  • More Agent actions (validate)
  • Pages Action (crate, update, delete)
  • Test Cases actions (export, import, run, run-all)
  • Changelog actions (show)
  • Experiment Actions - TBD
"},{"location":"webhooks/create/","title":"Create","text":""},{"location":"webhooks/create/#usage","title":"Usage","text":"

You can find the create functionality within the cxcli webhook create subcommand. You can read the documentation about this command here.

"},{"location":"webhooks/create/#flexible-webhook","title":"Flexible Webhook","text":"

If you want to create a flexible webhook, you have to set the --flexible parameter. When you set these parameters, you have to provide a --request-body and a --parameters-mapping parameter:

  1. The --request-body parameter is a JSON string that will be sent to the webhook.
  2. The --parameters-mapping parameter is a comma-separated list of key-value pairs. The key is the name of the parameter that will be sent to the webhook, and the value is a JSON path that will be used to extract the value from the --request-body parameter. This parameter has the following format: 
    parameter@json-path,paramter2@json-path2\n
    An example of a parameter mapping: my-param@$.fully.qualified.path.to.field
"},{"location":"webhooks/create/#example","title":"Example","text":""},{"location":"webhooks/create/#standard-webhook","title":"Standard Webhook","text":"

Here is a simple example of using the cxcli webhook create command:

cxcli webhook create my-webhook --url \"https://my-webhook.com\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 \n

The above command will give you output similar to the following:

$ cxcli webhook create my-webhook --url \"https://my-webhook.com\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 \nINFO Webhook created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/webhooks/55f56aeb-be30-40a2-8bd6-cbbd6b9cc041\n
"},{"location":"webhooks/create/#flexible-webhook_1","title":"Flexible Webhook","text":"
cxcli webhook create my-webhook --url \"https://my-webhook.com\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --flexible true --request-body \"{\\\"hello\\\": true}\" --parameters-mapping \"my-param@$.fully.qualified.path.to.field, my-param2@$.fully.qualified.path.to.field2\"\n

The above command will give you output similar to the following:

$ cxcli webhook create my-webhook --url \"https://my-webhook.com\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --flexible true --request-body \"{\\\"hello\\\": true}\" --parameters-mapping \"my-param@$.fully.qualified.path.to.field, my-param2@$.fully.qualified.path.to.field2\"\nINFO Webhook created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/webhooks/13df6f13-6848-4fab-8cda-752b4f9819fa \n
"},{"location":"webhooks/create/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX webhook creation, refer to the official documentation.

"},{"location":"webhooks/delete/","title":"Delete","text":""},{"location":"webhooks/delete/#usage","title":"Usage","text":"

You can find the delete functionality within the cxcli webhook delete subcommand. You can read the documentation about this command here.

"},{"location":"webhooks/delete/#example","title":"Example","text":"

Here is a simple example of the cxcli webhook delete command:

cxcli webhook delete my-webhook --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\n

The above command will give you output similar to the following:

$ cxcli webhook delete my-webhook --agent-name test-agent --project-id test-cx-346408 --location-id us-central1\nINFO Webhook deleted\n
"},{"location":"webhooks/delete/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX webhook deletion, refer to the official documentation.

"},{"location":"webhooks/introduction/","title":"Webhooks","text":""},{"location":"webhooks/introduction/#what-is-this","title":"What is this?","text":"

Webhooks serve as platforms for hosting your business logic or invoking other services. Within a session, webhooks enable you to utilize the data extracted through Dialogflow's natural language processing to generate dynamic responses, verify gathered data, or initiate actions on the backend.

There are two types of webhooks: standard webhooks and flexible webhooks. In the case of a standard webhook, the request and response fields are determined by Dialogflow. On the other hand, a flexible webhook allows you to specify the request and response fields according to your requirements.

With cxcli, you can easily interact with the webhooks of your Dialogflow CX agents.

All of the commands that you have available in cxcli to interact with your webhooks are located within the cxcli webhook subcommand.

You can create, update or delete standard and flexible webhooks with cxcli for a specific environment by setting the --environment parameter. If you do not specify an environment, the cxcli will create, update or delete this webhook for all environments.

"},{"location":"webhooks/introduction/#create","title":"Create","text":"

The cxcli has a command that allows you to create a standard or flexible webhook. You can find a more detailed information here.

"},{"location":"webhooks/introduction/#update","title":"Update","text":"

The cxcli has a command that allows you to update a standard or flexible webhook. You can find a more detailed information here.

"},{"location":"webhooks/introduction/#delete","title":"Delete","text":"

The cxcli has a command that allows you to delete your standard or flexible webhook. You can find a more detailed explanation here.

"},{"location":"webhooks/introduction/#useful-links","title":"Useful Links","text":"

If you want to see the full usage of the cxcli webhook command, please refer to this page.

If you want to learn more about Dialogflow CX webhooks, refer to the official documentation.

"},{"location":"webhooks/update/","title":"Update","text":""},{"location":"webhooks/update/#usage","title":"Usage","text":"

You can find the update functionality within the cxcli webhook update subcommand. You can read the documentation about this command here.

"},{"location":"webhooks/update/#flexible-webhook","title":"Flexible Webhook","text":"

If you want to update a flexible webhook, you have to set the --flexible parameter. When you set these parameters, you have to provide a --request-body and a --parameters-mapping parameter:

  1. The --request-body parameter is a JSON string that will be sent to the webhook.
  2. The --parameters-mapping parameter is a comma-separated list of key-value pairs. The key is the name of the parameter that will be sent to the webhook, and the value is a JSON path that will be used to extract the value from the --request-body parameter. This parameter has the following format: 
    parameter@json-path,paramter2@json-path2\n
    An example of a parameter mapping: my-param@$.fully.qualified.path.to.field
"},{"location":"webhooks/update/#example","title":"Example","text":""},{"location":"webhooks/update/#standard-webhook","title":"Standard Webhook","text":"

Here is a simple example of the cxcli webhook update command:

cxcli webhook update my-webhook --url \"https://my-webhook-updated.com\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 \n

The above command will give you output similar to the following:

$ cxcli webhook update my-webhook --url \"https://my-webhook-updated.com\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 \nINFO Webhook updated\n
"},{"location":"webhooks/update/#flexible-webhook_1","title":"Flexible Webhook","text":"

Here is a simple example of the cxcli webhook update command:

cxcli webhook update my-webhook --url \"https://my-webhook-updated.com\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --flexible true --request-body \"{\\\"hello\\\": false}\" --parameters-mapping \"my-param@$.fully.qualified.path.to.field\"\n

The above command will give you output similar to the following:

$ cxcli webhook update my-webhook --url \"https://my-webhook-updated.com\" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --flexible true --request-body \"{\\\"hello\\\": false}\" --parameters-mapping \"my-param@$.fully.qualified.path.to.field\"\nINFO Webhook updated\n
"},{"location":"webhooks/update/#useful-links","title":"Useful Links","text":"

If you want to learn more about Dialogflow CX webhook update, refer to the official documentation.

"}]} \ No newline at end of file diff --git a/security/index.html b/security/index.html new file mode 100644 index 00000000..6714a777 --- /dev/null +++ b/security/index.html @@ -0,0 +1,2762 @@ + + + + + + + + + + + + + + + + + + + + + + + + + Security Policy - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Security Policy

+

Supported Versions

+

Only the last stable version at any given point.

+

Reporting a Vulnerability

+

Vulnerabilities can be disclosed via email to dialogflowcxcli@gmail.com

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/sitemap.xml b/sitemap.xml new file mode 100644 index 00000000..f180c65c --- /dev/null +++ b/sitemap.xml @@ -0,0 +1,603 @@ + + + + https://cxcli.xavidop.me/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/ci/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/dialog/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/links/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/security/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/stt/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/troubleshooting/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/tts/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/agents/create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/agents/delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/agents/export/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/agents/introduction/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/agents/restore/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/agents/update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_agent/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_agent_create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_agent_delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_agent_export/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_agent_restore/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_agent_update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_completion/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_completion_bash/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_completion_fish/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_completion_powershell/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_completion_zsh/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_dialog/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_entity-type/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_entity-type_create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_entity-type_delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_entity-type_update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_environment/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_environment_create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_environment_delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_environment_execute-cicd/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_environment_update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_flow-version/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_flow-version_create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_flow-version_delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_flow-version_update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_flow/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_flow_create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_flow_delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_flow_train/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_flow_update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_generator/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_generator_create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_generator_delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_generator_update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_intent/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_intent_create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_intent_delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_intent_update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_jsonschema/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_profile-conversation/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_profile-conversation_execute/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_profile-nlu/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_profile-nlu_execute/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_stt/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_stt_recognize/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_tts/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_tts_synthesize/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_version/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_webhook/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_webhook_create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_webhook_delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/cmd/cxcli_webhook_update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/community/contributing/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/community/sponsors/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/community/users/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/conversationprofiler/examples/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/conversationprofiler/introduction/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/conversationprofiler/suites/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/conversationprofiler/tests/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/conversationprofiler/examples/contains/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/conversationprofiler/examples/prompt/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/conversationprofiler/examples/similarity/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/entitytypes/create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/entitytypes/delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/entitytypes/introduction/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/entitytypes/update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/environments/cicd/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/environments/create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/environments/delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/environments/introduction/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/environments/update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/flows/create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/flows/delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/flows/introduction/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/flows/train/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/flows/update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/flowversions/create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/flowversions/delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/flowversions/introduction/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/flowversions/update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/generators/create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/generators/delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/generators/introduction/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/generators/update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/intents/create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/intents/delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/intents/introduction/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/intents/update/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/nluprofiler/examples/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/nluprofiler/introduction/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/nluprofiler/suites/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/nluprofiler/tests/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/nluprofiler/examples/audio/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/nluprofiler/examples/prompt/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/nluprofiler/examples/simple/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/nluprofiler/examples/system/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/nluprofiler/examples/text/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/overview/authentication/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/overview/faq/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/overview/install/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/overview/roadmap/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/webhooks/create/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/webhooks/delete/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/webhooks/introduction/ + 2024-05-10 + daily + + + https://cxcli.xavidop.me/webhooks/update/ + 2024-05-10 + daily + + \ No newline at end of file diff --git a/sitemap.xml.gz b/sitemap.xml.gz new file mode 100644 index 00000000..776bbf60 Binary files /dev/null and b/sitemap.xml.gz differ diff --git a/static/conversationsuite.json b/static/conversationsuite.json new file mode 100644 index 00000000..9808d923 --- /dev/null +++ b/static/conversationsuite.json @@ -0,0 +1,66 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://github.com/xavidop/dialogflow-cx-cli/internal/types/profileconversation/suite", + "$ref": "#/$defs/Suite", + "$defs": { + "Suite": { + "properties": { + "Name": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "ProjectID": { + "type": "string" + }, + "LocationID": { + "type": "string" + }, + "AgentName": { + "type": "string" + }, + "Tests": { + "items": { + "$ref": "#/$defs/Tests" + }, + "type": "array" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Name", + "Description", + "ProjectID", + "LocationID", + "AgentName", + "Tests" + ] + }, + "Tests": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://github.com/xavidop/dialogflow-cx-cli/internal/types/profileconversation/tests", + "$ref": "#/$defs/Tests", + "$defs": { + "Tests": { + "properties": { + "ID": { + "type": "string" + }, + "File": { + "type": "string" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "ID", + "File" + ] + } + } + } + }, + "description": "cxcli Conversation Profiler suite definition file" + } \ No newline at end of file diff --git a/static/conversationtest.json b/static/conversationtest.json new file mode 100644 index 00000000..f53a6b26 --- /dev/null +++ b/static/conversationtest.json @@ -0,0 +1,328 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://github.com/xavidop/dialogflow-cx-cli/internal/types/profileconversation/test", + "$ref": "#/$defs/Test", + "$defs": { + "Agent": { + "properties": { + "Intent": { + "type": "string" + }, + "Validate": { + "items": { + "$ref": "#/$defs/Validate" + }, + "type": "array" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Intent", + "Validate" + ] + }, + "Contains": { + "properties": { + "CaseSensitive": { + "type": "boolean" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "CaseSensitive" + ] + }, + "Equals": { + "properties": { + "CaseSensitive": { + "type": "boolean" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "CaseSensitive" + ] + }, + "Hamming": { + "properties": { + "CaseSensitive": { + "type": "boolean" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "CaseSensitive" + ] + }, + "Interaction": { + "properties": { + "ID": { + "type": "string" + }, + "User": { + "$ref": "#/$defs/User" + }, + "Agent": { + "$ref": "#/$defs/Agent" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "ID", + "User", + "Agent" + ] + }, + "Jaccard": { + "properties": { + "CaseSensitive": { + "type": "boolean" + }, + "NgramSize": { + "type": "integer" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "CaseSensitive", + "NgramSize" + ] + }, + "Jaro": { + "properties": { + "CaseSensitive": { + "type": "boolean" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "CaseSensitive" + ] + }, + "JaroWinkler": { + "properties": { + "CaseSensitive": { + "type": "boolean" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "CaseSensitive" + ] + }, + "Levenshtein": { + "properties": { + "CaseSensitive": { + "type": "boolean" + }, + "InsertCost": { + "type": "integer" + }, + "DeleteCost": { + "type": "integer" + }, + "ReplaceCost": { + "type": "integer" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "CaseSensitive", + "InsertCost", + "DeleteCost", + "ReplaceCost" + ] + }, + "OverlapCoefficient": { + "properties": { + "CaseSensitive": { + "type": "boolean" + }, + "NgramSize": { + "type": "integer" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "CaseSensitive", + "NgramSize" + ] + }, + "Regexp": { + "properties": { + "FindInSubmatches": { + "type": "boolean" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "FindInSubmatches" + ] + }, + "SmithWatermanGotoh": { + "properties": { + "CaseSensitive": { + "type": "boolean" + }, + "GapPenalty": { + "type": "number" + }, + "Substitution": true + }, + "additionalProperties": false, + "type": "object", + "required": [ + "CaseSensitive", + "GapPenalty", + "Substitution" + ] + }, + "SorensenDice": { + "properties": { + "CaseSensitive": { + "type": "boolean" + }, + "NgramSize": { + "type": "integer" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "CaseSensitive", + "NgramSize" + ] + }, + "Test": { + "properties": { + "Name": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "LocaleID": { + "type": "string" + }, + "Interactions": { + "items": { + "$ref": "#/$defs/Interaction" + }, + "type": "array" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Name", + "Description", + "LocaleID", + "Interactions" + ] + }, + "User": { + "properties": { + "Type": { + "type": "string" + }, + "Text": { + "type": "string" + }, + "Prompt": { + "type": "string" + }, + "Audio": { + "type": "string" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Type", + "Text", + "Prompt", + "Audio" + ] + }, + "Validate": { + "properties": { + "Type": { + "type": "string" + }, + "Value": { + "type": "string" + }, + "Algorithm": { + "type": "string" + }, + "Threshold": { + "type": "number" + }, + "ConfigurationContains": { + "$ref": "#/$defs/Contains" + }, + "ConfigurationRegexp": { + "$ref": "#/$defs/Regexp" + }, + "ConfigurationEquals": { + "$ref": "#/$defs/Equals" + }, + "ConfigurationHamming": { + "$ref": "#/$defs/Hamming" + }, + "ConfigurationLevenshtein": { + "$ref": "#/$defs/Levenshtein" + }, + "ConfigurationJaro": { + "$ref": "#/$defs/Jaro" + }, + "ConfigurationJaroWinkler": { + "$ref": "#/$defs/JaroWinkler" + }, + "ConfigurationSmithWatermanGotoh": { + "$ref": "#/$defs/SmithWatermanGotoh" + }, + "ConfigurationSorensenDice": { + "$ref": "#/$defs/SorensenDice" + }, + "ConfigurationJaccard": { + "$ref": "#/$defs/Jaccard" + }, + "ConfigurationOverlapCoefficient": { + "$ref": "#/$defs/OverlapCoefficient" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Type", + "Value", + "Algorithm", + "Threshold", + "ConfigurationContains", + "ConfigurationRegexp", + "ConfigurationEquals", + "ConfigurationHamming", + "ConfigurationLevenshtein", + "ConfigurationJaro", + "ConfigurationJaroWinkler", + "ConfigurationSmithWatermanGotoh", + "ConfigurationSorensenDice", + "ConfigurationJaccard", + "ConfigurationOverlapCoefficient" + ] + } + }, + "description": "cxcli Conversation Profiler test definition file" + } \ No newline at end of file diff --git a/static/hi.mp3 b/static/hi.mp3 new file mode 100644 index 00000000..d17b135a Binary files /dev/null and b/static/hi.mp3 differ diff --git a/static/nlusuite.json b/static/nlusuite.json new file mode 100644 index 00000000..e83076a8 --- /dev/null +++ b/static/nlusuite.json @@ -0,0 +1,66 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://github.com/xavidop/dialogflow-cx-cli/internal/types/profilenlu/suite", + "$ref": "#/$defs/Suite", + "$defs": { + "Suite": { + "properties": { + "Name": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "ProjectID": { + "type": "string" + }, + "LocationID": { + "type": "string" + }, + "AgentName": { + "type": "string" + }, + "Tests": { + "items": { + "$ref": "#/$defs/Tests" + }, + "type": "array" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Name", + "Description", + "ProjectID", + "LocationID", + "AgentName", + "Tests" + ] + }, + "Tests": { + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://github.com/xavidop/dialogflow-cx-cli/internal/types/profilenlu/tests", + "$ref": "#/$defs/Tests", + "$defs": { + "Tests": { + "properties": { + "ID": { + "type": "string" + }, + "File": { + "type": "string" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "ID", + "File" + ] + } + } + } + }, + "description": "cxcli NLU Profiler suite definition file" + } \ No newline at end of file diff --git a/static/nlutest.json b/static/nlutest.json new file mode 100644 index 00000000..8cafbf15 --- /dev/null +++ b/static/nlutest.json @@ -0,0 +1,114 @@ +{ + "$schema": "https://json-schema.org/draft/2020-12/schema", + "$id": "https://github.com/xavidop/dialogflow-cx-cli/internal/types/profilenlu/test", + "$ref": "#/$defs/Test", + "$defs": { + "Check": { + "properties": { + "ID": { + "type": "string" + }, + "Input": { + "$ref": "#/$defs/Input" + }, + "Validate": { + "$ref": "#/$defs/Validate" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "ID", + "Input", + "Validate" + ] + }, + "Input": { + "properties": { + "Type": { + "type": "string" + }, + "Text": { + "type": "string" + }, + "Prompt": { + "type": "string" + }, + "Audio": { + "type": "string" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Type", + "Text", + "Prompt", + "Audio" + ] + }, + "Parameter": { + "properties": { + "Parameter": { + "type": "string" + }, + "Value": { + "type": "string" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Parameter", + "Value" + ] + }, + "Test": { + "properties": { + "Name": { + "type": "string" + }, + "Description": { + "type": "string" + }, + "LocaleID": { + "type": "string" + }, + "Checks": { + "items": { + "$ref": "#/$defs/Check" + }, + "type": "array" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Name", + "Description", + "LocaleID", + "Checks" + ] + }, + "Validate": { + "properties": { + "Intent": { + "type": "string" + }, + "Parameters": { + "items": { + "$ref": "#/$defs/Parameter" + }, + "type": "array" + } + }, + "additionalProperties": false, + "type": "object", + "required": [ + "Intent", + "Parameters" + ] + } + }, + "description": "cxcli NLU Profiler test definition file" + } \ No newline at end of file diff --git a/static/run b/static/run new file mode 100644 index 00000000..2a108d41 --- /dev/null +++ b/static/run @@ -0,0 +1,45 @@ +#!/bin/sh +set -e + + +echo "Using the OSS distribution..." +RELEASES_URL="https://github.com/xavidop/dialogflow-cx-cli/releases" +FILE_BASENAME="cxcli" + +test -z "$VERSION" && VERSION="$(curl -sfL -o /dev/null -w %{url_effective} "$RELEASES_URL/latest" | + rev | + cut -f1 -d'/'| + rev)" + +test -z "$VERSION" && { + echo "Unable to get cxcli version." >&2 + exit 1 +} + +test -z "$TMPDIR" && TMPDIR="$(mktemp -d)" +export TAR_FILE="$TMPDIR/${FILE_BASENAME}_$(uname -s)_$(uname -m).tar.gz" + +( + cd "$TMPDIR" + echo "Downloading Dialogflow CX CLI $VERSION..." + curl -sfLo "$TAR_FILE" \ + "$RELEASES_URL/download/$VERSION/${FILE_BASENAME}_$(uname -s)_$(uname -m).tar.gz" + curl -sfLo "checksums.txt" "$RELEASES_URL/download/$VERSION/checksums.txt" + curl -sfLo "checksums.txt.sig" "$RELEASES_URL/download/$VERSION/checksums.txt.sig" + curl -sfLo "checksums.txt.pem" "$RELEASES_URL/download/$VERSION/checksums.txt.pem" + echo "Verifying checksums..." + sha256sum --ignore-missing --quiet --check checksums.txt + if command -v cosign >/dev/null 2>&1; then + echo "Verifying signatures..." + COSIGN_EXPERIMENTAL=1 cosign verify-blob \ + --cert checksums.txt.pem \ + --signature checksums.txt.sig \ + checksums.txt + else + echo "Could not verify signatures, cosign is not installed." + fi +) + +tar -xf "$TAR_FILE" -C "$TMPDIR" +"${TMPDIR}/cxcli" "$@" + diff --git a/stt/index.html b/stt/index.html new file mode 100644 index 00000000..b2c2b68b --- /dev/null +++ b/stt/index.html @@ -0,0 +1,2907 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Speech-to-text - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Speech-to-text

+

+ Google Cloud TTS Logo +

+ +

The cxcli tool has various commands that allow you to interact with Google Cloud's Speech to Text service using the Cloud Speech-to-text API!

+
+

Is this your first time using this feature?

+

Before you start using this functionality, please, read the authentication page.

+
+

Usage

+

You can find the speech-to-text functionality within the cxcli stt subcommand. You can read the documentation about this command here.

+

The cxcli stt command has a recognize subcommand. You can find the usage of this command here.

+

Parameters

+

These are the relevant parameters that you can use to interact with Google Cloud STT:

+
    +
  1. locale: this parameter accepts all of the locales that are available in the Google Cloud Speech-to-text API. You can find all the locales available here.
    2. +
+

Audio input file

+

It is important to know that the input audio needs to be in the following format:

+
    +
  1. A sample rate of 16000 Hertz
    2. +
  2. The audio encoding has to be Linear16. Linear16 is a 16-bit linear pulse-code modulation (PCM) encoding.
    3. +
+

If you don't have a file with this format, you can create it by yourself using the cxcli tts command! All of the relevant information is located here.

+

Example

+

Here is a simple example of the cxcli stt recognize command:

+
cxcli stt recognize hi.mp3  --locale en-US
+
+

The above command will give you output similar to the following:

+
$ cxcli stt recognize hi.mp3 --locale en-US --verbose
+INFO Duration time: 570 miliseconds
+INFO Detections: 1
+INFO 1. Text detected: hi
+INFO 1. Confidence: 79.276474%
+
+
+

Are you running this command in a CI/CD pipeline?

+

If this is the case, we recommend that you set the --output-format parameter to json.

+
+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/troubleshooting/index.html b/troubleshooting/index.html new file mode 100644 index 00000000..785f6c3a --- /dev/null +++ b/troubleshooting/index.html @@ -0,0 +1,2884 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Troubleshooting - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Troubleshooting

+

Getting support

+

All users have access to a public Discord server for support and collaboration. Refer to the links page for more information.

+

Project not found

+

Make sure that you have configured either the gcloud CLI or the authentication json file properly. You can find more information on the Authentication page.

+

You need to enable the Dialogflow API

+

You need to enable the Dialogflow API in your Google Cloud project if you want to interact with cxcli. Make sure you have the permissions needed for the tool. You can find more information on the Authentication page.

+

You need to enable the Cloud Speech-to-text API

+

You need to enable the Cloud Speech-to-text API in your Google Cloud project if you want to run the cxcli stt commands. You can find more information on the Authentication page.

+

You need to enable the Cloud Text-to-speech API

+

You need to enable the Cloud Text-to-speech API in your Google Cloud project if you want to run the cxcli tts commands. You can find more information on the Authentication page.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/tts/index.html b/tts/index.html new file mode 100644 index 00000000..4573f9e6 --- /dev/null +++ b/tts/index.html @@ -0,0 +1,2902 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Text-to-speech - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Text-to-speech

+

+ Google Cloud TTS Logo +

+ +

The cxcli tool has various commands that allow you to interact with Google Cloud's Text to Speech service using the Cloud Text-to-Speech API!

+
+

Is this your first time using this feature?

+

Before you start using this functionality, please, read the authentication page.

+
+

Usage

+

You can find the text-to-speech functionality within the cxcli tts subcommand. You can read the documentation about this command here.

+

The cxcli tts command has a synthesize subcommand. You can find the usage of this command here.

+

Parameters

+

These are the relevant parameters that you can use to interact with Google Cloud TTS:

+
    +
  1. locale: this parameter accepts all of the locales that are available in the Google Cloud Text-to-speech API. You can find all the locales available here.
    2. +
  2. output-file: MP3 audio file where we are going to output the synthesized text.
    3. +
+

Output

+

It is important to know that the output audio will have the following format:

+
    +
  1. A sample rate of 16000 Hertz
    2. +
  2. The audio encoding will be Linear16. Linear16 is a 16-bit linear pulse-code modulation (PCM) encoding.
    3. +
+

Example

+

Here is a simple example of the cxcli tts synthesize command:

+
cxcli tts synthesize hi --locale en-US --output-file hi.mp3
+
+

The above command will give you an audio file similar to the following:

+

+

You can download the audio file here.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/webhooks/create/index.html b/webhooks/create/index.html new file mode 100644 index 00000000..ed8547dd --- /dev/null +++ b/webhooks/create/index.html @@ -0,0 +1,2947 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Create - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Create

+

Usage

+

You can find the create functionality within the cxcli webhook create subcommand. You can read the documentation about this command here.

+

Flexible Webhook

+

If you want to create a flexible webhook, you have to set the --flexible parameter. When you set these parameters, you have to provide a --request-body and a --parameters-mapping parameter:

+
    +
  1. The --request-body parameter is a JSON string that will be sent to the webhook.
    2. +
  2. The --parameters-mapping parameter is a comma-separated list of key-value pairs. The key is the name of the parameter that will be sent to the webhook, and the value is a JSON path that will be used to extract the value from the --request-body parameter. This parameter has the following format: +
    parameter@json-path,paramter2@json-path2
+
    +An example of a parameter mapping: my-param@$.fully.qualified.path.to.field
    3. +
+

Example

+

Standard Webhook

+

Here is a simple example of using the cxcli webhook create command:

+
cxcli webhook create my-webhook --url "https://my-webhook.com" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 
+
+

The above command will give you output similar to the following:

+
$ cxcli webhook create my-webhook --url "https://my-webhook.com" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 
+INFO Webhook created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/webhooks/55f56aeb-be30-40a2-8bd6-cbbd6b9cc041
+
+

Flexible Webhook

+
cxcli webhook create my-webhook --url "https://my-webhook.com" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --flexible true --request-body "{\"hello\": true}" --parameters-mapping "my-param@$.fully.qualified.path.to.field, my-param2@$.fully.qualified.path.to.field2"
+
+

The above command will give you output similar to the following:

+
$ cxcli webhook create my-webhook --url "https://my-webhook.com" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --flexible true --request-body "{\"hello\": true}" --parameters-mapping "my-param@$.fully.qualified.path.to.field, my-param2@$.fully.qualified.path.to.field2"
+INFO Webhook created with id: projects/test-cx-346408/locations/us-central1/agents/40278ea0-c0fc-4d9a-a4d4-caa68d86295f/webhooks/13df6f13-6848-4fab-8cda-752b4f9819fa 
+
+ +

If you want to learn more about Dialogflow CX webhook creation, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/webhooks/delete/index.html b/webhooks/delete/index.html new file mode 100644 index 00000000..9ef668ce --- /dev/null +++ b/webhooks/delete/index.html @@ -0,0 +1,2852 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Delete - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Delete

+

Usage

+

You can find the delete functionality within the cxcli webhook delete subcommand. You can read the documentation about this command here.

+

Example

+

Here is a simple example of the cxcli webhook delete command:

+
cxcli webhook delete my-webhook --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+
+

The above command will give you output similar to the following:

+
$ cxcli webhook delete my-webhook --agent-name test-agent --project-id test-cx-346408 --location-id us-central1
+INFO Webhook deleted
+
+ +

If you want to learn more about Dialogflow CX webhook deletion, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/webhooks/introduction/index.html b/webhooks/introduction/index.html new file mode 100644 index 00000000..339c05f6 --- /dev/null +++ b/webhooks/introduction/index.html @@ -0,0 +1,2891 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Introduction - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Webhooks

+

What is this?

+

Webhooks serve as platforms for hosting your business logic or invoking other services. Within a session, webhooks enable you to utilize the data extracted through Dialogflow's natural language processing to generate dynamic responses, verify gathered data, or initiate actions on the backend.

+

There are two types of webhooks: standard webhooks and flexible webhooks. In the case of a standard webhook, the request and response fields are determined by Dialogflow. On the other hand, a flexible webhook allows you to specify the request and response fields according to your requirements.

+

With cxcli, you can easily interact with the webhooks of your Dialogflow CX agents.

+

All of the commands that you have available in cxcli to interact with your webhooks are located within the cxcli webhook subcommand.

+

You can create, update or delete standard and flexible webhooks with cxcli for a specific environment by setting the --environment parameter. If you do not specify an environment, the cxcli will create, update or delete this webhook for all environments.

+

Create

+

The cxcli has a command that allows you to create a standard or flexible webhook. You can find a more detailed information here.

+

Update

+

The cxcli has a command that allows you to update a standard or flexible webhook. You can find a more detailed information here.

+

Delete

+

The cxcli has a command that allows you to delete your standard or flexible webhook. You can find a more detailed explanation here.

+ +

If you want to see the full usage of the cxcli webhook command, please refer to this page.

+

If you want to learn more about Dialogflow CX webhooks, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file diff --git a/webhooks/update/index.html b/webhooks/update/index.html new file mode 100644 index 00000000..89c6152e --- /dev/null +++ b/webhooks/update/index.html @@ -0,0 +1,2948 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + Update - Dialogflow CX CLI + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ +
+ + + + + + +
+ + +
+ +
+ + + + + + +
+
+ + + +
+
+
+ + + + + +
+
+
+ + + +
+
+
+ + + +
+
+
+ + + +
+
+ + + + + + + +

Update

+

Usage

+

You can find the update functionality within the cxcli webhook update subcommand. You can read the documentation about this command here.

+

Flexible Webhook

+

If you want to update a flexible webhook, you have to set the --flexible parameter. When you set these parameters, you have to provide a --request-body and a --parameters-mapping parameter:

+
    +
  1. The --request-body parameter is a JSON string that will be sent to the webhook.
    2. +
  2. The --parameters-mapping parameter is a comma-separated list of key-value pairs. The key is the name of the parameter that will be sent to the webhook, and the value is a JSON path that will be used to extract the value from the --request-body parameter. This parameter has the following format: +
    parameter@json-path,paramter2@json-path2
+
    +An example of a parameter mapping: my-param@$.fully.qualified.path.to.field
    3. +
+

Example

+

Standard Webhook

+

Here is a simple example of the cxcli webhook update command:

+
cxcli webhook update my-webhook --url "https://my-webhook-updated.com" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 
+
+

The above command will give you output similar to the following:

+
$ cxcli webhook update my-webhook --url "https://my-webhook-updated.com" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 
+INFO Webhook updated
+
+

Flexible Webhook

+

Here is a simple example of the cxcli webhook update command:

+
cxcli webhook update my-webhook --url "https://my-webhook-updated.com" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --flexible true --request-body "{\"hello\": false}" --parameters-mapping "my-param@$.fully.qualified.path.to.field"
+
+

The above command will give you output similar to the following:

+
$ cxcli webhook update my-webhook --url "https://my-webhook-updated.com" --agent-name test-agent --project-id test-cx-346408 --location-id us-central1 --flexible true --request-body "{\"hello\": false}" --parameters-mapping "my-param@$.fully.qualified.path.to.field"
+INFO Webhook updated
+
+ +

If you want to learn more about Dialogflow CX webhook update, refer to the official documentation.

+ + + + + + + + + + + + + + + +
+
+ + + +
+ +
+ + + +
+
+
+
+ + + + + + + + + + \ No newline at end of file

You can sponsor and see who's sponsoring Xavier Portilla Edo here.