Dear ImGui plugin for Adventure Game Studio

Using ocornut Dear ImGui, and also using software renderer with modifications from LAK132, and using other changes to ensure AGS compatibility.

ImGui reference commit is 3f26a07ee1813cecaa87253436149e28fc11dc4e.

Additionally using David Cappelo clip library for providing clipboard integration.

Run a simple demo window to see what’s possible with Dear ImGui.

// use function room_RepExec() when in Room Script and link it throught the editor
void repeatedly_execute(){
  AgsImGui.NewFrame(); //let's begin a new frame, we end it with a Render
  AgsImGui.ShowDemoWindow(); //Shows a demo of everything possible
  AgsImGui.Render(); // This will generate drawing instructions. 
  // AGS will actually draw this on screen later on, on Post Screen Draw stage.
}

Some of what is shown on Demo Window is not yet exposed in the AgsImGui Script API.

Let’s do a simple example now.

bool is_button_clicked;

// use function room_RepExec() when in Room Script and link it throught the editor
void repeatedly_execute(){
  AgsImGui.NewFrame(); //let's begin a new frame, we end it with a Render
	
  AgsImGui.BeginWindow("My first window");	
  ViewFrame* vf = Game.GetViewFrame(player.View, player.Loop, player.Frame);
  is_button_clicked = AgsImGui.ImageButton(vf.Graphic); 
  if(AgsImGui.IsItemHovered()) AgsImGui.SetTooltip(String.Format("frame %d",player.Frame));
  player.x = AgsImGui.DragInt("player.x", player.x);
  player.y = AgsImGui.DragInt("player.y", player.y);
  AgsImGui.EndWindow();
	
  AgsImGui.Render(); // This will generate drawing instructions. 
  // AGS will actually draw this on screen later on, on Post Screen Draw stage.
}

Note ImGui will save a ImGui.ini to allow window positions and some more data to persist between sections when no guidance is given.

static ImGuiStyle* AgsImGui.GetStyle()

Gets the Style customization use in AgsImGui. Check ImGuiStyle for more information.

static void AgsImGui.SetStyle(ImGuiStyle* imGuiStyle)

Sets the Style customization use in AgsImGui. Check ImGuiStyle for more information.

ImGuiStyle* style = AgsImGui.GetStyle();
style.Alpha = 0.5
style.Colors[eImGuiCol_PopupBg] = ImVec4.Create(1.00, 1.00, 1.00, 1.00); //white 
AgsImGui.SetStyle(style);

static void AgsImGui.NewFrame()

Call this before calling any AgsImGui commands.

static void AgsImGui.EndFrame()

We don’t need this if we are using Render, since it will automatically call AgsImGui.EndFrame() too.

static void AgsImGui.Render()

This will EndFrame and proceed to generate drawing instructions.

static String AgsImGui.GetVersion()

static void AgsImGui.ShowDemoWindow()

static void AgsImGui.ShowAboutWindow()

static void AgsImGui.ShowMetricsWindow()

static void AgsImGui.ShowUserGuide()

static AgsImGui.ImGuiBeginWindow BeginWindow(String name, bool has_close_button = 0, ImGuiWindowFlags flags = 0)

static void EndWindow()

static bool BeginChild(String str_id, int width = 0, int height = 0, bool border = false, ImGuiWindowFlags flags = 0)

Child Windows. Always call a matching EndChild() for each BeginChild() call, regardless of its return value. Child windows can embed their own child.

static void EndChild()

Pop child window from the stack.

Most of the functions are referring to the last/previous item we submitted.

static bool AgsImGui.IsItemHovered(ImGuiHoveredFlags flags = 0)

Is the last item hovered? (and usable, aka not blocked by a popup, etc.). You can specify a flag for more options.

static bool IsItemHovered(ImGuiHoveredFlags flags = 0)

static bool AgsImGui.IsItemActive()

Is the last item active? (e.g. button being held, text field being edited. This will continuously return true while holding mouse button on an item.)

static bool AgsImGui.IsItemFocused()

Is the last item focused for keyboard navigation?

static bool AgsImGui.IsItemVisible()

Is the last item visible? (items may be out of sight because of clipping/scrolling)

static bool AgsImGui.IsItemEdited()

Did the last item modify its underlying value this frame? or was pressed? This is generally the same as the bool return value of many widgets.

static bool AgsImGui.IsItemActivated()

Was the last item just made active (item was previously inactive).

static bool AgsImGui.IsItemDeactivated()

Was the last item just made inactive (item was previously active). Useful for Undo/Redo patterns with widgets that requires continuous editing.

static bool AgsImGui.IsItemDeactivatedAfterEdit()

Was the last item just made inactive and made a value change when it was active? (e.g. Slider/Drag moved). Useful for Undo/Redo patterns with widgets that requires continuous editing.

static bool AgsImGui.IsItemToggledOpen()

Was the last item open state toggled? set by TreeNode().

static bool AgsImGui.IsAnyItemHovered()

is any item hovered?

static bool AgsImGui.IsAnyItemActive()

is any item active?

static bool AgsImGui.IsAnyItemFocused()

is any item focused?

static bool AgsImGui.IsWindowAppearing()

‘current window’ = the window we are appending into while inside a Begin()/End() block.

static bool AgsImGui.IsWindowCollapsed()

return true when window is collapsed. Use this between Begin and End of a window.

static bool AgsImGui.IsWindowFocused(ImGuiFocusedFlags flags=0)

is current window focused? or its root/child, depending on flags. see flags for options. Use this between Begin and End of a window.

static bool AgsImGui.IsWindowHovered(ImGuiHoveredFlags flags=0)

is current window hovered (and typically: not blocked by a popup/modal)? see flags for options. Use this between Begin and End of a window.

static void AgsImGui.Text(String text)

Draws a string of text.

static void AgsImGui.TextColored(int ags_color, String text)

shortcut for PushStyleColor(ImGuiCol_Text, col); Text(fmt, …); PopStyleColor();

static void AgsImGui.TextDisabled(String text)

shortcut for PushStyleColor(ImGuiCol_Text, style.Colors[ImGuiCol_TextDisabled]); Text(fmt, …); PopStyleColor();

static void AgsImGui.TextWrapped(String text)

shortcut for PushTextWrapPos(0.0f); Text(fmt, …); PopTextWrapPos();.

static void AgsImGui.LabelText(String label, String text)

Display text+label aligned the same way as value+label widgets .

static void AgsImGui.Bullet(String text)

Draws a bullet and a string of text. Shortcut for Bullet()+Text().

Most widgets return true when the value has been changed or when pressed/selected.

You may also use one of the many IsItemXXX functions (e.g. IsItemActive, IsItemHovered, etc.) to query widget state.

static bool AgsImGui.Button(String label, int width = 0, int height = 0)

Creates a button. Returns true while button is pressed.

static bool AgsImGui.SmallButton(String label)

Creates a button with no padding to be easier to embed within text. Returns true while button is pressed.

static void AgsImGui.Image(int sprite_id)

Create an image with passed sprite ID.

static bool AgsImGui.ImageButton(int sprite_id)

Create a button with an image with passed sprite ID. Returns true while button is pressed.

static bool AgsImGui.ArrowButton(String label, ImGuiDir dir)

Creates a button with an arrow shape. Returns true while button is pressed.

static bool AgsImGui.Checkbox(String label, bool initial_value)

Creates a checkbox button. Returns true when button is marked.

static bool AgsImGui.RadioButton(String label, bool active)

Creates a radio button. Returns true while button is marked.

static void AgsImGui.Bullet()

Draw a small circle and keep the cursor on the same line. advance cursor x position by GetTreeNodeToLabelSpacing(), same distance that TreeNode() uses .

A selectable highlights when hovered, and can display another color when selected.

static bool AgsImGui.Selectable(String label, bool selected = false, ImGuiSelectableFlags flags = 0, int width = 0, int height = 0)

bool selected carry the selection state (read-only). When Selectable() is clicked it returns true so you can modify your selection state.

CTRL+Click on any drag box to turn them into an input box. Manually input values aren’t clamped and can go off-bounds.

static float AgsImGui.DragFloat(String label, float value, float min_value = 0, float max_value = 0, float speed = 0, String format = 0)

Returns the current value of the drag box. Format string uses regular "%f" specifiers, so you can use to define how many decimals you want.

static int AgsImGui.DragInt(String label, int value, int min_value = 0, int max_value = 0, float speed = 0, String format = 0)

Returns the current value of the drag box. Format string uses regular "%d", you can use it to specify left most zeroes.

CTRL+Click on any slider to turn them into an input box. Manually input values aren’t clamped and can go off-bounds.

static float AgsImGui.SliderFloat(String label, float value, float min_value = 0, float max_value = 0, String format = 0)

Returns the current value of the slider. Format string uses regular "%f" specifiers, so you can use to define how many decimals you want.

static int AgsImGui.SliderInt(String label, int value, int min_value = 0, int max_value = 0, String format = 0)

Returns the current value of the slider. Format string uses regular "%d", you can use it to specify left most zeroes.

static String AgsImGui.InputText(String label, String text_buffer, int buffer_size, ImGuiInputTextFlags flags =0)

Pass a string to identify the input field as label, this label is going to be used for ID and can’t be empty.

Remember that we don’t save state between frames, so you have to do this yourself by reapplying the output to input as needed.

This function returns null when the input hasn’t changed, and returns a string with all the text, when it has been modified.

This widget supports Ctrl+Z for undo, Ctrl+X for Cut, Ctrl+C for copy, Ctrl+V for pasting, mouse selection and cursor navigation with arrows. Behavior can be modified by passing flags, see the enums section. Flags can be combined with bitwise operations.

Example:

String input_string;
function room_RepExec() {   
  AgsImGui.NewFrame();  
    // buff
  String out_string = AgsImGui.InputText("type here!",input_string, 128);
  if(out_string!=null) input_string = out_string;
  
  AgsImGui.Render();
}


function room_Load() {
  input_string = "Hello String!";
}

static String AgsImGui.InputTextMultiline(String label, String text_buffer, int buffer_size, int width=0, int height=0, ImGuiInputTextFlags flags = 0)

Same as InputText, but allows controlling the input size and supports multiline text.

static String AgsImGui.InputTextWithHint(String label, String hint, String text_buffer, int buffer_size, ImGuiInputTextFlags flags = 0)

Same as InputText, but supports passing an input hint text.

static bool AgsImGui.BeginCombo(String label, String preview_value, ImGuiComboFlags flags = 0);

The BeginCombo()/EndCombo() allows to manage your contents and selection state however you want it, by creating e.g. Selectable() items.

Example:

bool option1;
bool option2;
if(AgsImGui.BeginCombo("My combo","click me!")){
  option1 = AgsImGui.Selectable("Option 1");
  option2 = AgsImGui.Selectable("Option 2");
  AgsImGui.EndCombo();
}

static void EndCombo()

Only call EndCombo() if BeginCombo() returns true!

static bool AgsImGui.BeginListBox(String label, int items_count, int height_in_items = -1);

The BeginListBox()/EndListBox() allows to manage your contents and selection state however you want it, by creating e.g. Selectable() items.

Example:

bool option1;
bool option2;
if(AgsImGui.BeginListBox("My ListBox",2)){
  option1 = AgsImGui.Selectable("Option 1");
  option2 = AgsImGui.Selectable("Option 2");
  AgsImGui.EndListBox();
}

static void AgsImGui.EndListBox()

Only call EndListBox() if BeginListBox() returns true!

TreeNode functions return true when the node is open, in which case you need to also call TreePop() when you are finished displaying the tree node contents.

static bool AgsImGui.TreeNode(String label)

Show the contents and call TreePop() at the end, if this returns true.

static bool AgsImGui.TreeNodeWithID(String str_id, String text)

Show the contents and call TreePop() at the end, if this returns true.

static bool AgsImGui.TreeNodeV(String str_id, String text)

Show the contents and call TreePop() at the end, if this returns true.

static bool AgsImGui.TreeNodeEx(String label, ImGuiTreeNodeFlags flags = 0)

Show the contents and call TreePop() at the end, if this returns true.

static bool AgsImGui.TreeNodeExWithID(String str_id, ImGuiTreeNodeFlags flags, String text)

Show the contents and call TreePop() at the end, if this returns true.

static bool AgsImGui.TreeNodeExV(String str_id, ImGuiTreeNodeFlags flags, String text)

Show the contents and call TreePop() at the end, if this returns true.

static void AgsImGui.TreePush(String str_id)

~ Indent()+PushId(). Already called by TreeNode() when returning true, but you can call TreePush/TreePop yourself if desired.

static void AgsImGuiTreePop()

~ Unindent()+PopId().

static float AgsImGui.GetTreeNodeToLabelSpacing()

Horizontal distance preceding label when using TreeNode*() or Bullet() == (g.FontSize + style.FramePadding.x*2) for a regular unframed TreeNode.

static bool AgsImGui.CollapsingHeader(String label, ImGuiTreeNodeFlags flags = 0)

If returning ‘true’ the header is open. doesn’t indent nor push on ID stack. user doesn’t have to call TreePop().

static void AgsImGui.SetNextItemOpen(bool is_open, ImGuiCond cond = 0)

Set next TreeNode/CollapsingHeader open state.

Tooltip are windows following the mouse which do not take focus away.

Remember we can only have one active tooltip at all times, and the last one called is the active one.

static void AgsImGui.BeginTooltip()

Begin/append a tooltip window. to create full-featured tooltip (with any kind of items). Doesn’t return nothing.

static void AgsImGui.EndTooltip()

Always call after a BeginTooltip block!

static void AgsImGui.SetTooltip(String text)

Set a text-only tooltip, typically use with AgsImGui.IsItemHovered(). Override any previous call to SetTooltip().

Example:

AgsImGui.Button("Clicks for nothing!");
if(AgsImGui.IsItemHovered()) AgsImGui.SetTooltip("Button is hovered!");

static void AgsImGui.OpenPopup(String str_id)

call to mark popup as open (don’t call every frame!). Popups are closed when user click outside, or if CloseCurrentPopup() is called within a BeginPopup()/EndPopup() block.

Popup identifiers are relative to the current ID-stack.

Example:

// If the button is in the Window, this code goes inside the window.
if(AgsImGui.BeginPopup("my_popup")){
  AgsImGui.Text("This is a popup");
  AgsImGui.EndPopup();  
}
if(AgsImGui.Button("open popup"))
{
  AgsImGui.OpenPopup("my_popup");
}

static bool AgsImGui.BeginPopup(String str_id, ImGuiWindowFlags flags = 0)

Return true if the popup is open, and you can start outputting to it. Only call EndPopup() if BeginPopup() returns true!

Generally you will want to run this on every frame, and it will return true once the popup has been made open, and return false again once it’s closed.

static bool AgsImGui.BeginPopupModal(String name, bool has_close_button = 0, ImGuiWindowFlags flags = 0)

Modal dialog, a regular window with title bar, block interactions behind the modal window, and you can’t close the modal window by clicking outside.

static void AgsImGui.EndPopup()

Only call EndPopup() if BeginPopupXXX() returns true!

static bool AgsImGui.IsPopupOpen(String str_id)

Return true if the popup is open at the current begin-ed level of the popup stack.

static void AgsImGui.CloseCurrentPopup()

Close the popup we have begin-ed into. clicking on a MenuItem or Selectable automatically close the current popup.

static bool AgsImGui.BeginTabBar(String str_id, ImGuiTabBarFlags flags = 0)

create and append into a TabBar

static void AgsImGui.EndTabBar()

only call EndTabBar() if BeginTabBar() returns true!

static bool AgsImGui.BeginTabItem(String label, bool has_close_button = 0, ImGuiTabItemFlags flags = 0)

create a Tab. Returns true if the Tab is selected.

static void AgsImGui.EndTabItem()

only call EndTabItem() if BeginTabItem() returns true!

static void AgsImGui.SetTabItemClosed(String tab_or_docked_window_label)

notify TabBar or Docking system of a closed tab/window ahead (useful to reduce visual flicker on reorderable tab bars). For tab-bar: call after BeginTabBar() and before Tab submissions. Otherwise call with a window name.

static bool AgsImGui.BeginMenuBar()

Append to menu-bar of current window (requires ImGuiWindowFlags_MenuBar flag set on parent window).

static void AgsImGui.EndMenuBar()

Only call EndMenuBar() if BeginMenuBar() returns true!

static bool AgsImGui.BeginMainMenuBar()

Create and append to a full screen menu-bar.

static void AgsImGui.EndMainMenuBar()

Only call EndMainMenuBar() if BeginMainMenuBar() returns true!

static bool AgsImGui.BeginMenu(String label, bool enabled = true)

Create a sub-menu entry. Only call EndMenu() if this returns true!

static void AgsImGui.EndMenu()

Only call EndMenu() if BeginMenu() returns true!

static bool AgsImGui.MenuItem(String label, String shortcut, bool selected = false, bool enabled = true)

return true when activated. shortcuts are displayed for convenience but not processed by ImGui at the moment!

static void AgsImGuiHelper.SetClipboarText(String text)

static String AgsImGuiHelper.GetClipboarText()

This is a format used to describe either x,y points or zero origin rectangles and other things that can be described as vectors. It’s used more in the attributes of a ImGuiStyle object.

static ImVec2* ImVec2.Create(float x = 0, float y = 0)

Creates a new ImVec2 object. You can pass float variable for it’s X and Y properties.

attribute float ImVec2.X

It’s the X attribute of a ImVec2 object. Usually represents the horizontal axis.

attribute float ImVec2.Y

It’s the Y attribute of a ImVec2 object. Usually represents the vertical axis.

ImVec2* ImVec2.Scale(float scale)

Multiplies x and y coordinates by a scalar and returns a new ImVec2 with the result.

float ImVec2.Length()

Returns length from ImVec2 (distance from 0,0 origin).

float ImVec2.SquaredLength()

Returns squared length from ImVec2 (distance from 0,0 origin). Faster than length.

ImVec2* ImVec2.Add(ImVec2* imVec2)

Returns a new ImVec2 with the sum of this with imVec2.

ImVec2* ImVec2.Sub(ImVec2* imVec2)

Returns a new ImVec2 with the subtraction of imVec2 from this.

This is a format used to describe either x,y,w,z points or any origin rectangles and other things that can be described as vectors with 4 coordinates. It’s the preferable format for ImGui Colors, and used a lot for this! It’s used more in the attributes of a ImGuiStyle object.

static ImVec4* ImVec4.Create(float x = 0, float y = 0, float z = 0, float w = 0)

Creates a new ImVec4 object. You can pass float variable for it’s X, Y, Z and W properties.

attribute float ImVec4.X

It’s the X attribute of a ImVec4 object. Usually represents the horizontal axis. When used for colors correspond to the color Red.

attribute float ImVec4.Y

It’s the Y attribute of a ImVec4 object. Usually represents the vertical axis. When used for colors correspond to the color Green.

attribute float ImVec4.Z

It’s the Z attribute of a ImVec4 object. Usually represents the length in the horizontal axis. When used for colors correspond to the color Blue.

attribute float ImVec4.W

It’s the W attribute of a ImVec4 object. Usually represents the length in the vertical axis. When used for colors correspond to the alpha of the colors, where 0.0 is transparent and 1.0 is opaque.

ImVec4* ImVec4.Scale(float scale)

Multiplies x, y, z and w coordinates by a scalar and returns a new ImVec4 with the result.

float ImVec4.Length()

Returns length from ImVec4 (distance from 0,0,0,0 origin).

float ImVec4.SquaredLength()

Returns squared length from ImVec4 (distance from 0,0,0,0 origin). Faster than length.

ImVec4* ImVec4.Add(ImVec4* imVec4)

Returns a new ImVec4 with the sum of this with imVec4.

ImVec4* ImVec4.Sub(ImVec4* imVec4)

Returns a new ImVec4 with the subtraction of imVec4 from this.

static ImGuiStyle* ImGuiStyle.Create()

Creates a new empty ImGuiStyle object. Rarely used, it’s usually more advised to use ImGui.GetStyle() instead, unless it’s planned to customize all elements of a ImGuiStyle object.

attribute float ImGuiStyle.Alpha

Global alpha applies to everything in Dear ImGui.

attribute ImVec2* ImGuiStyle.WindowPadding

Padding within a window.

attribute float ImGuiStyle.WindowRounding

Radius of window corners rounding. Set to 0.0f to have rectangular windows.

attribute float ImGuiStyle.WindowBorderSize

Thickness of border around windows. Generally set to 0.0f or 1.0f.

attribute ImVec2* ImGuiStyle.WindowMinSize

Minimum window size. This is a global setting. For individual windows, use SetNextWindowSizeConstraints().

attribute ImVec2* ImGuiStyle.WindowTitleAlign

Alignment for title bar text. Defaults to (0.0f,0.5f) for left-aligned,vertically centered.

attribute ImGuiDir ImGuiStyle.WindowMenuButtonPosition

Side of the collapsing/docking button in the title bar (None/Left/Right). Defaults to ImGuiDir_Left.

attribute float ImGuiStyle.ChildRounding

Radius of child window corners rounding. Set to 0.0f to have rectangular windows.

attribute float ImGuiStyle.ChildBorderSize

Thickness of border around child windows. Generally set to 0.0f or 1.0f.

attribute float ImGuiStyle.PopupRounding

Radius of popup window corners rounding. (Note that tooltip windows use WindowRounding)

attribute float ImGuiStyle.PopupBorderSize

Thickness of border around popup/tooltip windows. Generally set to 0.0f or 1.0f.

attribute ImVec2* ImGuiStyle.FramePadding

Padding within a framed rectangle (used by most widgets).

attribute float ImGuiStyle.FrameRounding

Radius of frame corners rounding. Set to 0.0f to have rectangular frame (used by most widgets).

attribute float ImGuiStyle.FrameBorderSize

Thickness of border around frames. Generally set to 0.0f or 1.0f. (Other values are not well tested and more CPU/GPU costly).

attribute ImVec2* ImGuiStyle.ItemSpacing

Horizontal and vertical spacing between widgets/lines.

attribute ImVec2* ImGuiStyle.ItemInnerSpacing

Horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label).

attribute ImVec2* ImGuiStyle.TouchExtraPadding

Expand reactive bounding box for touch-based system where touch position is not accurate enough. Unfortunately we don’t sort widgets so priority on overlap will always be given to the first widget. Don’t grow this too much!

attribute float ImGuiStyle.IndentSpacing

Horizontal indentation when e.g. entering a tree node. Generally == (FontSize + FramePadding.x*2).

attribute float ImGuiStyle.ColumnsMinSpacing

Minimum horizontal spacing between two columns. Preferably > (FramePadding.x + 1).

attribute float ImGuiStyle.ScrollbarSize

Width of the vertical scrollbar, Height of the horizontal scrollbar.

attribute float ImGuiStyle.ScrollbarRounding

Radius of grab corners for scrollbar.

attribute float ImGuiStyle.GrabMinSize

Minimum width/height of a grab box for slider/scrollbar.

attribute float ImGuiStyle.GrabRounding

Radius of grabs corners rounding. Set to 0.0f to have rectangular slider grabs.

attribute float ImGuiStyle.TabRounding

Radius of upper corners of a tab. Set to 0.0f to have rectangular tabs.

attribute float ImGuiStyle.TabBorderSize

Thickness of border around tabs.

attribute float ImGuiStyle.TabMinWidthForUnselectedCloseButton

Minimum width for close button to appears on an unselected tab when hovered. Set to 0.0f to always show when hovering, set to FLT_MAX to never show close button unless selected.

attribute ImGuiDir ImGuiStyle.ColorButtonPosition

Side of the color button in the ColorEdit4 widget (left/right). Defaults to ImGuiDir_Right.

attribute ImVec2* ImGuiStyle.ButtonTextAlign

Alignment of button text when button is larger than text. Defaults to (0.5f, 0.5f) (centered).

attribute ImVec2* ImGuiStyle.SelectableTextAlign

Alignment of selectable text. Defaults to (0.0f, 0.0f) (top-left aligned). It’s generally important to keep this left-aligned if you want to lay multiple items on a same line.

attribute ImVec2* ImGuiStyle.DisplayWindowPadding

Window position are clamped to be visible within the display area by at least this amount. Only applies to regular windows.

attribute ImVec2* ImGuiStyle.DisplaySafeAreaPadding

If you cannot see the edges of your screen (e.g. on a TV) increase the safe area padding. Apply to popups/tooltips as well regular windows. NB: Prefer configuring your TV sets correctly!

attribute float ImGuiStyle.MouseCursorScale

Scale software rendered mouse cursor (when io.MouseDrawCursor is enabled). May be removed later.

attribute bool ImGuiStyle.AntiAliasedLines

Enable anti-aliasing on lines/borders. Disable if you are really tight on CPU/GPU.

attribute bool ImGuiStyle.AntiAliasedFill

Enable anti-aliasing on filled shapes (rounded rectangles, circles, etc.)

attribute float ImGuiStyle.CurveTessellationTol

Tessellation tolerance when using PathBezierCurveTo() without a specific number of segments. Decrease for highly tessellated curves (higher quality, more polygons), increase to reduce quality.

attribute float ImGuiStyle.CircleSegmentMaxError

Maximum error (in pixels) allowed when using AddCircle()/AddCircleFilled() or drawing rounded corner rectangles with no explicit segment count specified. Decrease for higher quality but more geometry.

attribute ImVec4* ImGuiStyle.Colors[]

Use to configure the colors used in varied parts of the ImGui theme. Check the enum ImGuiCol_ for all possible colors available in a ImGuiStyle object. An example usage would be:

ImGuiStyle* style = ImGui.GetStyle();
style.Colors[eImGuiCol_TextDisabled] = ImVec4.Create(0.5, 0.5, 0.5, 0.5);
ImGui.SetStyle(style);

• eImGuiCond_Always, used when condition should always trigger, is usually the default when the AgImGui API requires conditions.

• eImGuiCond_Once, Set the variable once per runtime session (only the first call with succeed).

• eImGuiCond_FirstUseEver, Set the variable if the object/window has no persistently saved data (no entry in .ini file).

• eImGuiCond_Appearing, Set the variable if the object/window is appearing after being hidden/inactive (or the first time).

• eImGuiDir_Left, left direction.

• eImGuiDir_Right, right direction.

• eImGuiDir_Up, up direction.

• eImGuiDir_Down, down direction.

obs: This is exclusive to AgsImGui implementation because in AGS we don’t have pointers to primitive types.

In any cases below, you still have to call AgsImGui.EndWindow().

• eImGuiBeginWindow_OK, the window is open.

• eImGuiBeginWindow_Collapsed, the window is collapsed (using the arrow at top left).

• eImGuiBeginWindow_OK_Closed the window is closed. This value is only returned at mouse release frame, after clicking on close button!

• eImGuiBeginWindow_Collapsed_Closed the window is both collapsed and closed, rare but theoretically possible.

• eImGuiWindowFlags_None (= 0),

• eImGuiWindowFlags_NoTitleBar, Disable title-bar

• eImGuiWindowFlags_NoResize, Disable user resizing with the lower-right grip

• eImGuiWindowFlags_NoMove, Disable user moving the window

• eImGuiWindowFlags_NoScrollbar, Disable scrollbars (window can still scroll with mouse or programmatically)

• eImGuiWindowFlags_NoScrollWithMouse, Disable user vertically scrolling with mouse wheel. On child window, mouse wheel will be forwarded to the parent unless NoScrollbar is also set.

• eImGuiWindowFlags_NoCollapse, Disable user collapsing window by double-clicking on it

• eImGuiWindowFlags_AlwaysAutoResize, Resize every window to its content every frame

• eImGuiWindowFlags_NoBackground,Disable drawing background color (WindowBg, etc.) and outside border. Similar as using SetNextWindowBgAlpha(0.0f).

• eImGuiWindowFlags_NoSavedSettings, Never load/save settings in .ini file

• eImGuiWindowFlags_NoMouseInputs, Disable catching mouse, hovering test with pass through.

• eImGuiWindowFlags_MenuBar, Has a menu-bar

• eImGuiWindowFlags_HorizontalScrollbar, Allow horizontal scrollbar to appear (off by default).

• eImGuiWindowFlags_NoFocusOnAppearing, Disable taking focus when transitioning from hidden to visible state

• eImGuiWindowFlags_NoBringToFrontOnFocus, Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)

• eImGuiWindowFlags_AlwaysVerticalScrollbar, Always show vertical scrollbar (even if ContentSize.y < Size.y)

• eImGuiWindowFlags_AlwaysHorizontalScrollbar, Always show horizontal scrollbar (even if ContentSize.x < Size.x)

• eImGuiWindowFlags_AlwaysUseWindowPadding, Ensure child windows without border uses style.WindowPadding (ignored by default for non-bordered child windows, because more convenient)

• eImGuiWindowFlags_NoNavInputs, No gamepad/keyboard navigation within the window

• eImGuiWindowFlags_NoNavFocus, No focusing toward this window with gamepad/keyboard navigation (e.g. skipped by CTRL+TAB)

• eImGuiWindowFlags_UnsavedDocument, Append ‘*’ to title without affecting the ID, as a convenience to avoid using the ### operator.

• eImGuiWindowFlags_NoNav,

• eImGuiWindowFlags_NoDecoration,

• eImGuiWindowFlags_NoInputs,

The enums of this type can be combined with bitwise operators.

• eImGuiInputTextFlags_None, (=0) default

• eImGuiInputTextFlags_CharsDecimal, Allow 0123456789.+-*/

• eImGuiInputTextFlags_CharsHexadecimal, Allow 0123456789ABCDEFabcdef

• eImGuiInputTextFlags_CharsUppercase, Turn a..z into A..Z

• eImGuiInputTextFlags_CharsNoBlank, Filter out spaces, tabs

• eImGuiInputTextFlags_AutoSelectAll, Select entire text when first taking mouse focus

• eImGuiInputTextFlags_EnterReturnsTrue, Return ‘true’ when Enter is pressed (as opposed to every time the value was modified).

• eImGuiInputTextFlags_CallbackCompletion, Callback on pressing TAB (for completion handling)

• eImGuiInputTextFlags_CallbackHistory, Callback on pressing Up/Down arrows (for history handling)

• eImGuiInputTextFlags_CallbackAlways, Callback on each iteration. User code may query cursor position, modify text buffer.

• eImGuiInputTextFlags_CallbackCharFilter, Callback on character inputs to replace or discard them. Modify ‘EventChar’ to replace or discard, or return 1 in callback to discard.

• eImGuiInputTextFlags_AllowTabInput, Pressing TAB input a ‘t’ character into the text field

• eImGuiInputTextFlags_CtrlEnterForNewLine, In multi-line mode, unfocus with Enter, add new line with Ctrl+Enter (default is opposite: unfocus with Ctrl+Enter, add line with Enter).

• eImGuiInputTextFlags_NoHorizontalScroll, Disable following the cursor horizontally

• eImGuiInputTextFlags_AlwaysInsertMode, Insert mode

• eImGuiInputTextFlags_ReadOnly, Read-only mode

• eImGuiInputTextFlags_Password, Password mode, display all characters as ‘*’

• eImGuiInputTextFlags_NoUndoRedo, Disable undo/redo. Note that input text owns the text data while active, if you want to provide your own undo/redo stack you need e.g. to call ClearActiveID().

• eImGuiInputTextFlags_CharsScientific, Allow 0123456789.+-*/eE (Scientific notation input)

• eImGuiInputTextFlags_CallbackResize, Callback on buffer capacity changes request (beyond ‘buf_size’ parameter value), allowing the string to grow.

Flags for AgsImGui.TreeNodeEx(), AgsImGui.CollapsingHeader().

–eImGuiTreeNodeFlags_None, (=0) default

–eImGuiTreeNodeFlags_Selected, Draw as selected

–eImGuiTreeNodeFlags_Framed, Full colored frame (e.g. for CollapsingHeader)

–eImGuiTreeNodeFlags_AllowItemOverlap, Hit testing to allow subsequent widgets to overlap this one

–eImGuiTreeNodeFlags_NoTreePushOnOpen, Don’t do a TreePush() when open (e.g. for CollapsingHeader) = no extra indent nor pushing on ID stack

–eImGuiTreeNodeFlags_NoAutoOpenOnLog, Don’t automatically and temporarily open node when Logging is active (by default logging will automatically open tree nodes)

–eImGuiTreeNodeFlags_DefaultOpen, Default node to be open

–eImGuiTreeNodeFlags_OpenOnDoubleClick, Need double-click to open node

–eImGuiTreeNodeFlags_OpenOnArrow, Only open when clicking on the arrow part. If ImGuiTreeNodeFlags_OpenOnDoubleClick is also set, single-click arrow or double-click all box to open.

–eImGuiTreeNodeFlags_Leaf, No collapsing, no arrow (use as a convenience for leaf nodes).

–eImGuiTreeNodeFlags_Bullet, Display a bullet instead of arrow

–eImGuiTreeNodeFlags_FramePadding, Use FramePadding (even for an unframed text node) to vertically align text baseline to regular widget height. Equivalent to calling AlignTextToFramePadding().

–eImGuiTreeNodeFlags_SpanAvailWidth, Extend hit box to the right-most edge, even if not framed. This is not the default in order to allow adding other items on the same line. In the future we may refactor the hit system to be front-to-back, allowing natural overlaps and then this can become the default.

–eImGuiTreeNodeFlags_SpanFullWidth, Extend hit box to the left-most and right-most edges (bypass the indented area).

–eImGuiTreeNodeFlags_NavLeftJumpsBackHere, (WIP) Nav: left direction may move to this TreeNode() from any of its child (items submitted between TreeNode and TreePop)

–eImGuiTreeNodeFlags_NoScrollOnOpen, FIXME: TODO: Disable automatic scroll on TreePop() if node got just open and contents is not visible

–eImGuiTreeNodeFlags_CollapsingHeader, Framed, NoTreePushOpen and NoAutoOpenOnLog.

Used for selecting a specific color from the ImGuiStyle.Colors[] property.

An example usage would be:

ImGuiStyle* style = ImGui.GetStyle();
style.Colors[eImGuiCol_WindowBg] = ImVec4.Create(1.0, 0.0, 0.0, 0.0);
ImGui.SetStyle(style);

This would use the enum eImGuiCol_WindowBg to access the desired color you want to modify, which in the example sets to a red color.

• eImGuiCol_Text,

• eImGuiCol_TextDisabled,

• eImGuiCol_WindowBg, Background of normal windows

• eImGuiCol_ChildBg, Background of child windows

• eImGuiCol_PopupBg, Background of popups, menus, tooltips windows

• eImGuiCol_Border,

• eImGuiCol_BorderShadow,

• eImGuiCol_FrameBg, Background of checkbox, radio button, plot, slider, text input

• eImGuiCol_FrameBgHovered,

• eImGuiCol_FrameBgActive,

• eImGuiCol_TitleBg,

• eImGuiCol_TitleBgActive,

• eImGuiCol_TitleBgCollapsed,

• eImGuiCol_MenuBarBg,

• eImGuiCol_ScrollbarBg,

• eImGuiCol_ScrollbarGrab,

• eImGuiCol_ScrollbarGrabHovered,

• eImGuiCol_ScrollbarGrabActive,

• eImGuiCol_CheckMark,

• eImGuiCol_SliderGrab,

• eImGuiCol_SliderGrabActive,

• eImGuiCol_Button,

• eImGuiCol_ButtonHovered,

• eImGuiCol_ButtonActive,

• eImGuiCol_Header, Header* colors are used for CollapsingHeader, TreeNode, Selectable, MenuItem

• eImGuiCol_HeaderHovered,

• eImGuiCol_HeaderActive,

• eImGuiCol_Separator,

• eImGuiCol_SeparatorHovered,

• eImGuiCol_SeparatorActive,

• eImGuiCol_ResizeGrip,

• eImGuiCol_ResizeGripHovered,

• eImGuiCol_ResizeGripActive,

• eImGuiCol_Tab,

• eImGuiCol_TabHovered,

• eImGuiCol_TabActive,

• eImGuiCol_TabUnfocused,

• eImGuiCol_TabUnfocusedActive,

• eImGuiCol_PlotLines,

• eImGuiCol_PlotLinesHovered,

• eImGuiCol_PlotHistogram,

• eImGuiCol_PlotHistogramHovered,

• eImGuiCol_TextSelectedBg,

• eImGuiCol_DragDropTarget,

• eImGuiCol_NavHighlight, Gamepad/keyboard: current highlighted item;

• eImGuiCol_NavWindowingHighlight, Highlight window when using CTRL+TAB;

• eImGuiCol_NavWindowingDimBg, Darken/colorize entire screen behind the CTRL+TAB window list, when active;

• eImGuiCol_ModalWindowDimBg, Darken/colorize entire screen behind a modal window, when one is active;

• eImGuiCol_COUNT, The total numbers of items in ImGuiStyle.Colors attribute array. Useful for iterating all colors.

First, make sure you have mouse wheel support enabled in Global Settings.

Then, in some script, add the code below. Note: If the script is a Room script, it will only work in that room.

void on_mouse_click (int btn){
  if(btn == eMouseWheelNorth){
    AgsImGui.DoMouseWheel(eImGuiDir_Down);
  } else if(btn == eMouseWheelSouth){
    AgsImGui.DoMouseWheel(eImGuiDir_Up);    
  }  
}

For now, mouse wheel events are not exposed in the AGS Plugin API, so you have to do it through script. In the future, if this changes, it will be integrated in the plugin.

Never doubt how to pronounce a word. Double-click it and your browser will read it out loud for you! (Works on Firefox and Chrome).

Some people use double click to select a word and to then expand the selection to other words, as it would be terrible for you to listen to any selection out loud, double click pronounce will only read out loud when you double-click a single word.

• ✅ Works on Firefox
• ✅ Works on Chrome
• ✅ Language locale selection
• ✅ Toggle on/off
• ✅ Blacklist to turn off in certain webpages

All throughout middle school and high school I was a pretty good english student, but ever since I started college I began to lose confidence over my pronounciation (as I didn’t have english lessons or anyone to talk to in english). I find this really frustrating because 99.9% of my time online is me reading in english… So the goal of this extension is to practice my pronounciation english.

This repo was featured in the 138th issue of Ruan YiFeng’s blog: https://ruanyifeng.com/blog/2020/12/weekly-issue-138.html

You can download the extension here.

You can download the extension here.

Feel free to Contribute to this project!

• @filipeisho
• @guimcaballero
• @boncom99

The MIT License (MIT).

Hello fellow Godot users! Have you ever come across this problem before?

Ugh! 😫 Look at all of that distracting tiling pattern in the terrain. Unless you’re making a world of quilt, I doubt that you want this showing in your scenery. Well fear not! With this plugin, you’ll be able to turn that, into this!

Much better. 😄 Here’s a side by side comparison of this feature. Amazing, isn’t it?

After downloading this repository, take the folder inside the addons folder, and put it into your project’s addons folder. Don’t have one? Make one. After that, you enable the plugin in the ProjectSettings in the Plugin section. It’s that easy.

This plugin currently is supported for SpatialMaterials and ShaderMaterials that use a VisualShader.

For SpatialMaterials, just select the material, press the SpatialMaterial button that shows up in the 3D editor, then press Add Tile Breaker. You remove the feature from the material the same way you add it.

Once you add the tile breaker, the SpatialMaterial will have new options.

• Variation Texture :- A texture used by the shader to randomize the offset patterns. This option only appears when the plugin quality is set to Low.
• Break Tiling :- Whether to enable tile breaking for a certain UV layer.
• Random Rotation :- How much the texture is randomly rotated for a certain UV layer.
• Blending :- How much texture samples are blended with each other for a certain UV layer. No blending will cause seams to show up in the material, unless the plugin quality is set to High.

As for visual shaders, a custom visual shader node has been created for them.

The parameters act the same way they do in SpatialMaterials. One thing to note however. If the plugin quality is set to Low, then you have to set the variation texture uniform manually. You can find the default variation texture in the plugin’s folder.

I’ve been talking about plugin quality for a while now. You will find that in the ProjectSettings under Rendering -> Quality. A low quality uses only 2 texture samples, medium uses 4, and high uses 9. As expected, each one looks better, but is also more performance heavy. If you have any VisualShaders that use the tile breaker, then you’ll have to restart the project when you have set your desired quality.

This plugin is best suited for projects running GLES 3, but it can run on GLES 2 just fine. There’s just one problem. Artifacts will start showing up in that version. The only way to get rid of said artifacts is by disabling mipmapping for the texture being used. It’s a trade-off you’ll have to think about. 🤔

The textures used in the demo scene were provided by https://www.cgbookcase.com/. 🙂

And the shaders that this plugin uses are based off the ones from https://www.iquilezles.org/www/articles/texturerepetition/texturerepetition.htm. You can find some excellent shaders from this place.

A simple and effective extension to download songs, albums, or playlists from 🎧 jiosaavn.com with just one click. It also hides ads 🚫 and promotions from the JioSaavn website and slightly tweaks the UI. Last but not least, it implements a long-awaited dark mode.

If you like the extension, please ⭐ the repo.
Follow me to stay updated on similar projects.

You can download the extension from the following link, or visit the changelog.
If you’re having trouble installing it, refer to the installation guide below.

The extension fetches data from JioSaavn’s API endpoints and organizes it in a user-friendly manner. This process occurs entirely within the browser and does not rely on external servers.

Once the data is fetched, it retrieves the URL for the song, album, or playlist in your preferred quality settings. The extension then sends an HTTP request to the server to fetch the M4A file. This step requires CORS to be enabled in your browser. In previous versions, this required an additional extension, but it is now integrated.

For playlists or albums, the extension fetches the individual songs and downloads them individually, placing them inside a ZIP file for easy download.

• Dark mode based on system theme.
• Download in various qualities: HD 320kbps, Default 160kbps.
• Download songs.
• Download top songs from artists.
• Download albums and playlists as ZIP files.
• Download podcasts.
• Blocks ads and promotions.
• Modifies certain UI elements.

You can access JioSaavn directly by single-clicking the extension icon—no need to add bookmarks. Double-click the extension icon to open the extension options.

• Developer Mode: Enable developer mode in your browser.
  Go to chrome://extensions and check the Developer Mode checkbox.

1. Download the extension here: Download and extract the contents.
   You can also visit the release page to check for other versions.
2. Go to the Chrome Extensions page: chrome://extensions.
3. Click the Load unpacked button.
4. Select the extracted folder and click Open.

Note: If you downloaded the source code, install it by running the following commands in your terminal (ensure that Node.js and npm are installed):

npm install
npm run build

This will build the extension in the build folder. You can then manually install it from there.

WORK IN PROGRESS❗

The extension includes an options page for customization. To access it, right-click the extension icon and select Extension Options. You can also open the options page by double-clicking the extension icon in the toolbar.

• Quality Settings: Choose the quality of songs to download.
    > Default: 320kbps
• Name Format: Customize the naming format of downloaded songs.
    > Default: $title - $album_artist
    > Params: $title, $album_artist, $artists, $album, $year, $track, $genre, $bitrate

The following projects were instrumental in the development of this extension:

• sumitkolhe / jiosaavn-api
• naqushab / saavn-downloader-extension
• tehhs / chrome-localhost-cors-unblocker

↑ Back to top

In this project, I created a resume from a sample .HTML and .CSS file, hosted in a S3 bucket with AWS. However, using just an S3 bucket alone will generate an insecure, non-customizable and undesired domain. (e.g http://awsresume.online.s3-website-us-east-1.amazonaws.com/)

We need to implement a secure and compliant domain over the internet that can allow our domain to generate a secure certificate (https). For this, Cloudfront enters the fray. It will generate an https environment allowing our domain to be secure. This will also allow seamless access and connection across multiple edge locations for faster query response. The problem, is that it will still create a fixed domain. (e.g https://d2ygp4l15ss99c.cloudfront.net)

To solve the final piece of the puzzle, we deploy Route53. This application will allow us to communicate our cloudfront distribution with a third party domain or a domain create within Route53 on AWS. With this solution, we will be able to utilize any domain we choose or need. We will also use Amazon Certificate Manager (ACM) to generate a valid HTTPS certificate that can allow the cloudfront distribution route the traffic with the custom domain.

This is a perfect real-world example to host a Resume in a secure, easily manageable static website that can be displayed with a third party custom domain or domain generated by AWS through Route53.

• Amazon Web Services (AWS)
• S3
• Cloudfront
• Route 53
• Amazon Certificate Manager
• Godaddy (for custom domain, route 53 can also accomplish the same goal.)
• HTML
• CSS
• JSON

• Windows 11

1. Create a S3 Bucket

When we create a S3 bucket, we want to make sure we allow public access so that the bucket is accessible publicly. However, we need to determine which object or resource is going to be allowed for public access, which is why we implement a S3 Bucket Policy in a json file. (file has been provided at the repository. Make sure the value of “Resource” is renamed to the S3 bucket you are using. It will display above the bucket policy box or by browsing the S3 bucket, as show in this video:

2. Upload files to S3 Bucket

After creation, it will create a S3 webpoint. In this case, it would be http://awsresume.online.s3-website-us-east-1.amazonaws.com/

3. Create a Cloudfront Distribution

After creation, a cloudfrount domain name will be created with an HTTPS resolver. In this case, the address would be https://d2ygp4l15ss99c.cloudfront.net

4. Create a hosted zone with Route 53 for a custom domain and create an alias record with Cloudfront

Even after creating the zone and alias record for the custom domain, it will show a 443 request error. We still need to request a certificate for our new domain, as shown below:

5. Requesting a Public Certificate with Amazon Certificate Manager in order to resolve a HTTPS request with the custom domain

After it’s said and done, we can test our custom domain now with no errors. Wooho!

The final result is our custom domain (fully accessible): https://awsresume.online

This sample demonstrates a few approaches for creating ChatGPT-like experiences over your own data using the Retrieval Augmented Generation pattern. It utilises ChatGPT model (gpt-35-turbo) in Azure OpenAI Service as a Generative AI platform, and Azure Cognitive Search for data indexing and retrieval.

======>> Original source code can be found here <<======.

The repo includes sample data so it’s ready to try end to end. In this sample application we use a fictitious company called Contoso Electronics, and the experience allows its employees to ask questions about the benefits, internal policies, as well as job descriptions and roles.

Note from Laziz: I’m currently updating this repo to migrate from ChatML syntax (used in OpenAI API v2022-12-03) to newer Chat Completion (with OpenAI API v2023-05-15), as it’s required for the interactions with GPT4 models.

• Chat and Q&A interfaces
• Explores various options to help users evaluate the trustworthiness of responses with citations, tracking of source content, etc.
• Shows possible approaches for data preparation, prompt construction, and orchestration of interaction between model (ChatGPT) and retriever (Cognitive Search)
• Settings directly in the UX to tweak the behavior and experiment with options

1. Create a new folder and switch to it in the terminal
2. Run azd auth login
3. Run azd init -t azure-search-openai-demo
   • For the target location, the regions that currently support the models used in this sample are East US or South Central US. For an up-to-date list of regions and models, check here

Execute the following command, if you don’t have any pre-existing Azure services and want to start from a fresh deployment.

1. Run azd up – This will provision Azure resources and deploy this sample to those resources, including building the search index based on the files found in the ./data folder.
2. After the application has been successfully deployed you will see a URL printed to the console. Click that URL to interact with the application in your browser.

It will look like the following:

NOTE: It may take a minute for the application to be fully deployed. If you see a “Python Developer” welcome screen, then wait a minute and refresh the page.

1. Run azd env set AZURE_OPENAI_SERVICE {Name of existing OpenAI service}
2. Run azd env set AZURE_OPENAI_RESOURCE_GROUP {Name of existing resource group that OpenAI service is provisioned to}
3. Run azd env set AZURE_OPENAI_CHATGPT_DEPLOYMENT {Name of existing ChatGPT deployment}. Only needed if your ChatGPT deployment is not the default ‘chat’.
4. Run azd env set AZURE_OPENAI_GPT_DEPLOYMENT {Name of existing GPT deployment}. Only needed if your ChatGPT deployment is not the default ‘davinci’.
5. Run azd up

NOTE: You can also use existing Search and Storage Accounts. See ./infra/main.parameters.json for list of environment variables to pass to azd env set to configure those existing resources.

• Simply run azd up

1. Run azd login
2. Change dir to app
3. Run ./start.ps1 or ./start.sh or run the “VS Code Task: Start App” to start the project locally.

Run the following if you want to give someone else access to completely deployed and existing environment.

1. Install the Azure CLI
2. Run azd init -t azure-search-openai-demo
3. Run azd env refresh -e {environment name} – Note that they will need the azd environment name, subscription Id, and location to run this command – you can find those values in your ./azure/{env name}/.env file. This will populate their azd environment’s .env file with all the settings needed to run the app locally.
4. Run pwsh ./scripts/roles.ps1 – This will assign all of the necessary roles to the user so they can run the app locally. If they do not have the necessary permission to create roles in the subscription, then you may need to run this script for them. Just be sure to set the AZURE_PRINCIPAL_ID environment variable in the azd .env file or in the active shell to their Azure Id, which they can get with az account show.

• In Azure: navigate to the Azure WebApp deployed by azd. The URL is printed out when azd completes (as “Endpoint”), or you can find it in the Azure portal.
• Running locally: navigate to 127.0.0.1:5000

Once in the web app:

• Try different topics in chat or Q&A context. For chat, try follow up questions, clarifications, ask to simplify or elaborate on answer, etc.
• Explore citations and sources
• Click on “settings” to try different options, tweak prompts, etc.

• Revolutionize your Enterprise Data with ChatGPT: Next-gen Apps w/ Azure OpenAI and Cognitive Search
• Azure Cognitive Search
• Azure OpenAI Service

Note: The PDF documents used in this demo contain information generated using a language model (Azure OpenAI Service). The information contained in these documents is only for demonstration purposes and does not reflect the opinions or beliefs of Microsoft. Microsoft makes no representations or warranties of any kind, express or implied, about the completeness, accuracy, reliability, suitability or availability with respect to the information contained in this document. All rights reserved to Microsoft.

Nodejs Backend of the Yokubo App, a project tracking tool, and the corresponding Yokubo Landing Page.

With Yokubo you can track your projects, record the time you spent on them and make notes about certain metrics defined by yourself. The app automatically calculates valuable statistics and gives you insights on your overall performance.

• Node 8
• Yarn 1.3+
• PostgreSQL 9.4+

• ImageMagick

$ yarn install

In the root directory of your project create an env folder and change into this folder

$ mkdir env && cd env

Create a file named test.env

$ touch test.env

Add the following environment variables to that file

NODE_ENV=test

# HAPI server settings
SERVER_HOST=127.0.0.1
SERVER_PORT=8080

# Database settings
PGHOST=127.0.0.1
PGPORT=5432
PGUSER=postgres
PGPASSWORD=password
PGDATABASE=yokubo-test

# Logger settings
FILE_SEVERITY=error
FILE_PATH=./logs/yokubo-backend.log
CONSOLE_SEVERITY=error
MAIL_RECEIVER=mail@example.com

# Assets
EXTERNAL_ASSETS_URL_HOST=http://127.0.0.1:8080

# Static pages
STATIC_WEBPAGES_URL_HOST=http://127.0.0.1:8080

# Mailing (Sparkpost)
MAIL_API_KEY=<your api key>
MAIL_FROM=mail@example.com

# Tests
# SEND_TEST_MAILS --> set for yarn:test cmd in package.json
TESTUSER_1_EMAIL=mail@example.com
TESTUSER_2_EMAIL=mail@example.com

# Admin user
ADMIN_USERNAME=admin
ADMIN_PWD=whatever
ADMIN_NAME=Administrator

# Legal disclosure
LEGAL_DISCLOSURE_NAME=Your name
LEGAL_DISCLOSURE_ADDRESS=Your addres
LEGAL_DISCLOSURE_PLZ=Your plz
LEGAL_DISCLOSURE_CITY=_Your city
LEGAL_DISCLOSURE_STATE=Your state
LEGAL_DISCLOSURE_EMAIL=mail@example.com

Create a file named prod.env

$ touch prod.env

Add the following environment variables to that file

NODE_ENV=development

# HAPI server settings 
SERVER_HOST=0.0.0.0
SERVER_PORT=8080

# Database settings
PGHOST=127.0.0.1
PGPORT=5432
PGUSER=postgres
PGPASSWORD=password
PGDATABASE=yokubo

# Logger settings
FILE_SEVERITY=error
FILE_PATH=./logs/yokubo-backend.log
CONSOLE_SEVERITY=info
MAIL_RECEIVER=mail@example.com

# Assets
EXTERNAL_ASSETS_URL_HOST=http://127.0.0.1:8080

# Static pages
STATIC_WEBPAGES_URL_HOST=http://127.0.0.1:8080

# Mailing (Sparkpost)
MAIL_API_KEY=<your api key>
MAIL_FROM=mail@example.com

# Admin user
ADMIN_USERNAME=admin
ADMIN_PWD=whatever
ADMIN_NAME=Administrator

# Legal disclosure
LEGAL_DISCLOSURE_NAME=Your name
LEGAL_DISCLOSURE_ADDRESS=Your addres
LEGAL_DISCLOSURE_PLZ=Your plz
LEGAL_DISCLOSURE_CITY=_Your city
LEGAL_DISCLOSURE_STATE=Your state
LEGAL_DISCLOSURE_EMAIL=mail@example.com

$ yarn build

$ yarn db:migrate

$ yarn test

$ yarn start

MIT

yokubo-app, the corresponding React-Native app.

Tianrun Chen, Chaotao Ding, Lanyun Zhu, Tao Xu, Deyi Ji, Ying Zang, Zejian Li

KOKONI, Moxin Technology (Huzhou) Co., LTD , Zhejiang University, Singapore University of Technology and Design, Huzhou University, University of Science and Technology of China.

Requirements: Ubuntu 20.04, CUDA 11.8

1. Create a virtual environment: conda create -n uxlstm python=3.10 -y and conda activate uxlstm
2. Install Pytorch 2.0.1: pip install torch==2.0.1 torchvision==0.15.2 --index-url https://download.pytorch.org/whl/cu118
3. Download code: git clone https://github.com/tianrun-chen/xLSTM-UNet-PyTorch.git
4. cd xLSTM-UNet-PyTorch/UxLSTM and run pip install -e .

The dataset used in this project is derived from the following research paper:

Jun Ma, Feifei Li, Bo Wang. “U-Mamba: Enhancing Long-range Dependency for Biomedical Image Segmentation.” arXiv preprint arXiv:2401.04722, 2024.

Download dataset here and put them into the data folder. U-xLSTM is built on the popular nnU-Net framework.

Our data processing approach strictly follows the methods outlined in the U-Mamba study. This includes steps such as data normalization, augmentation techniques, and segmentation algorithms detailed in their publication.

nnUNetv2_plan_and_preprocess -d DATASET_ID --verify_dataset_integrity

nnUNetv2_train DATASET_ID {dataset_type} {exp_name} -tr {trainer_type} -lr {learning_rate} -bs {batch_size}

• {dataset_type}: Specifies the type of dataset to be used. There are two options:

  • 2d: For datasets that are 2-dimensional.
  • 3d_fullres: For full-resolution 3-dimensional datasets.

• {exp_name}: Defines the name or identifier for the experiment. It can be:

  • all: Use this option to include all available configurations.
  • An integer: Specify a particular configuration number to use a specific setup.

• {trainer_type}: Indicates the type of trainer to use for the training process. Options include:

  • nnUNetTrainerUxLSTMBot: A trainer tailored for the UxLSTMBot model.
  • nnUNetTrainerUxLSTMEnc: A trainer designed for the UxLSTMEnc model architecture.

• {learning_rate}: Specifies the learning rate for the training process. This should be a floating-point number.

• {batch_size}: Defines the number of samples to process before the model’s internal parameters are updated.

• Train 2D U-xLSTM_Bot model

nnUNetv2_train DATASET_ID 2d all -tr nnUNetTrainerUxLSTMBot -lr {learning_rate} -bs {batch_size}

• Train 2D U-xLSTM_Enc model

nnUNetv2_train DATASET_ID 2d all -tr nnUNetTrainerUxLSTMEnc -lr {learning_rate} -bs {batch_size}

• Train 3D U-xLSTM_Bot model

nnUNetv2_train DATASET_ID 3d_fullres all -tr nnUNetTrainerUxLSTMBot -lr {learning_rate} -bs {batch_size}

• Train 3D U-xLSTM_Enc model

nnUNetv2_train DATASET_ID 3d_fullres all -tr nnUNetTrainerUxLSTMEnc -lr {learning_rate} -bs {batch_size}

• Predict testing cases with U-xLSTM_Bot model

nnUNetv2_predict -i INPUT_FOLDER -o OUTPUT_FOLDER -d DATASET_ID -c DATASET_TYPE -f all -tr nnUNetTrainerUxLSTMBot --disable_tta

• Predict testing cases with U-xLSTM_Enc model

nnUNetv2_predict -i INPUT_FOLDER -o OUTPUT_FOLDER -d DATASET_ID -c DATASET_TYPE -f all -tr nnUNetTrainerUxLSTMEnc --disable_tta

DATASET_TYPE can be 2d and 3d_fullres for 2D and 3D models, respectively.

• We provide pretrained models that you can download from this link. Please ensure you save them in the pretrained_model folder. Then, run process_weight.py to verify that the weights are correctly placed in the appropriate file path

python process_weight.py

We also provide additional shell scripts for evaluating our provided pretrained model.

bash metric_bot.sh
bash metric_enc.sh

If you wish to evaluate your own trained model, be sure to change the -f parameter to the {exp_name} used during training. This could be ‘all’ or a specific integer identifier.

Please cite this work if you find it inspiring or helpful!

@misc{chen2024xlstmuneteffective2d,
      title={xLSTM-UNet can be an Effective 2D \& 3D Medical Image Segmentation Backbone with Vision-LSTM (ViL) better than its Mamba Counterpart}, 
      author={Tianrun Chen and Chaotao Ding and Lanyun Zhu and Tao Xu and Deyi Ji and Ying Zang and Zejian Li},
      year={2024},
      eprint={2407.01530},
      archivePrefix={arXiv},
      primaryClass={eess.IV},
      url={https://arxiv.org/abs/2407.01530}, 
}

You are also welcomed to check our Segment Anything Adapter (SAM-Adapter)

@misc{chen2023sam,
      title={SAM Fails to Segment Anything? -- SAM-Adapter: Adapting SAM in Underperformed Scenes: Camouflage, Shadow, and More}, 
      author={Tianrun Chen and Lanyun Zhu and Chaotao Ding and Runlong Cao and Shangzhan Zhang and Yan Wang and Zejian Li and Lingyun Sun and Papa Mao and Ying Zang},
      year={2023},
      eprint={2304.09148},
      archivePrefix={arXiv},
      primaryClass={cs.CV}
}

The code is based on Jun Ma, Feifei Li, Bo Wang. “U-Mamba: Enhancing Long-range Dependency for Biomedical Image Segmentation.” arXiv preprint arXiv:2401.04722, 2024.

Here is the official Python client for Crowlingo. Access to all NLP and NLU services that analyze texts regardless of the language.

You can use pip to install the library:

$ pip install PyCrowlingo

Alternatively, you can just clone the repository and run the setup.py script:

$ python setup.py install

First of all, you will need to instantiate a client of Crowlingo. You can do it using your API token:

from PyCrowlingo import Client
client = Client('<TOKEN>')

Or using your account credentials:

from PyCrowlingo import Client
client = Client(username='<EMAIL>', password='<PASSWORD>')

You can call all the endpoints available on Crowlingo. All of them are detailed with examples on the documentation.

text = "Est-il recommandé d'utiliser MongoDb pour indexer mes documents ?"
res = client.languages.detect(text)
print(res)
# => Detect(sentences=[Sentence(start=0, end=65, languages_confidence=[ConfidenceLang(name='French', code='fr', confidence=98.0)], text="Est-il recommandé d'utiliser MongoDb pour indexer mes documents ?")], languages_confidence=[ConfidenceLang(name='French', code='fr', confidence=98.0)])

The response will be Pydantic object.
So, you can get the values with the response’s attributes:

print(client.languages.detect(text).languages_confidence)
# =>  '[ConfidenceLang(name='French', code='fr', confidence=98.0)]'

If you need to analyze texts through different services, it can be cumbersome to call the API for every step of processing.
Gain some speed and productivity by using a Pipeline. It allows you to create a workflow of processing for your data.
To do so, you have to use the ApiModels instead of the client function.

from PyCrowlingo import Pipeline
from PyCrowlingo.ApiModels import *
text = "On 26 April 1986, Chernobyl suffered the world’s worst nuclear disaster. An experiment designed to test the safety of the power plant went wrong and caused a fire which spewed radiation for 10 days. Clouds carrying radioactive particles drifted for thousands of miles, releasing toxic rain all over Europe. Those living close to Chernobyl - about 116,000 people - were immediately evacuated. A 30 km exclusion zone was imposed around the damaged reactor. This was later expanded to cover more affected areas."
pipeline = Pipeline(client, text=text) 
# Put the client on the pipeline and the common variables using keywords arguments
pipeline.add(Concepts.Extract, precision=0.9).add(Entities.Extract, visualize=True).add(Entities.Duckling)
# Add each step using pipeline.add(EndpointModel, *individuals arguments)
res = pipeline.call()
# Execute the pipeline
print(res)
# => responses={'[POST] /entities/duckling': {'duckling': [{'body': 'On 26 April 1986', 'start': 0, 'value': {'values': [{'value': '1986-04-26T00:00:00.000-08:00', 'grain': 'day', 'type': 'value'}], 'value': '1986-04-26T00:00:00.000-08:00', 'grain': 'day', 'type': 'value'}, 'end': 16, 'dim': 'time', 'latent': False}, {'body': '10 days', 'start': 190, 'value': {'value': 10, 'day': 10, 'type': 'value', 'unit': 'day', 'normalized': {'value': 864000, 'unit': 'second'}}, 'end': 197, 'dim': 'duration', 'latent': False}, {'body': 'thousands', 'start': 249, 'value': {'value': 1000, 'type': 'value'}, 'end': 258, 'dim': 'number', 'latent': False}, {'body': '116,000', 'start': 347, 'value': {'value': 116000, 'type': 'value'}, 'end': 354, 'dim': 'number', 'latent': False}, {'body': 'immediately', 'start': 369, 'value': {'values': [{'value': '2020-05-25T15:57:30.724-07:00', 'grain': 'second', 'type': 'value'}], 'value': '2020-05-25T15:57:30.724-07:00', 'grain': 'second', 'type': 'value'}, 'end': 380, 'dim': 'time', 'latent': False}, {'body': '30 km', 'start': 394, 'value': {'value': 30, 'type': 'value', 'unit': 'kilometre'}, 'end': 399, 'dim': 'distance', 'latent': False}]}, '[POST] /entities/extract': {'entities': [{'start': 3, 'end': 16, 'ent_type': 'DATE', 'text': '26 April 1986'}, {'start': 18, 'end': 27, 'ent_type': 'GPE', 'text': 'Chernobyl'}, {'start': 190, 'end': 197, 'ent_type': 'DATE', 'text': '10 days'}, {'start': 249, 'end': 267, 'ent_type': 'QUANTITY', 'text': 'thousands of miles'}, {'start': 299, 'end': 305, 'ent_type': 'LOC', 'text': 'Europe'}, {'start': 329, 'end': 338, 'ent_type': 'GPE', 'text': 'Chernobyl'}, {'start': 341, 'end': 354, 'ent_type': 'CARDINAL', 'text': 'about 116,000'}, {'start': 394, 'end': 399, 'ent_type': 'QUANTITY', 'text': '30 km'}], 'visualization': '<div class="entities" style="line-height: 2.5; direction: ltr">On \n<mark class="entity" style="background: #bfe1d9; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    26 April 1986\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">DATE</span>\n</mark>\n, \n<mark class="entity" style="background: #feca74; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    Chernobyl\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">GPE</span>\n</mark>\n suffered the world’s worst nuclear disaster. An experiment designed to test the safety of the power plant went wrong and caused a fire which spewed radiation for \n<mark class="entity" style="background: #bfe1d9; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    10 days\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">DATE</span>\n</mark>\n. Clouds carrying radioactive particles drifted for \n<mark class="entity" style="background: #e4e7d2; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    thousands of miles\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">QUANTITY</span>\n</mark>\n, releasing toxic rain all over \n<mark class="entity" style="background: #ff9561; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    Europe\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">LOC</span>\n</mark>\n. Those living close to \n<mark class="entity" style="background: #feca74; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    Chernobyl\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">GPE</span>\n</mark>\n - \n<mark class="entity" style="background: #e4e7d2; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    about 116,000\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">CARDINAL</span>\n</mark>\n people - were immediately evacuated. A \n<mark class="entity" style="background: #e4e7d2; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    30 km\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">QUANTITY</span>\n</mark>\n exclusion zone was imposed around the damaged reactor. This was later expanded to cover more affected areas.</div>'}, '[POST] /concepts/extract': {'concepts': [{'id': 'Q129677', 'weight': 0.19254024269693001, 'labels': [{'text': 'Chernobyl', 'mentions': [{'start': 18, 'end': 27}, {'start': 329, 'end': 338}]}]}, {'id': 'Q11448', 'weight': 0.13384788867053848, 'labels': [{'text': 'radioactive', 'mentions': [{'start': 215, 'end': 226}]}, {'text': 'radiation', 'mentions': [{'start': 176, 'end': 185}]}]}, {'id': 'Q46', 'weight': 0.11258210752213413, 'labels': [{'text': 'Europe', 'mentions': [{'start': 299, 'end': 305}]}]}, {'id': 'Q274160', 'weight': 0.07002172766602058, 'labels': [{'text': 'toxic', 'mentions': [{'start': 279, 'end': 284}]}]}, {'id': 'Q7925', 'weight': 0.06886892370214791, 'labels': [{'text': 'rain', 'mentions': [{'start': 285, 'end': 289}]}]}, {'id': 'Q101965', 'weight': 0.06562043143894636, 'labels': [{'text': 'experiment', 'mentions': [{'start': 76, 'end': 86}]}]}, {'id': 'Q3196', 'weight': 0.06482017292518794, 'labels': [{'text': 'fire', 'mentions': [{'start': 158, 'end': 162}]}]}, {'id': 'Q356936', 'weight': 0.06390318225879862, 'labels': [{'text': 'exclusion zone', 'mentions': [{'start': 400, 'end': 414}]}]}, {'id': 'Q486', 'weight': 0.06317545950269358, 'labels': [{'text': 'nuclear disaster', 'mentions': [{'start': 55, 'end': 71}]}, {'text': 'disaster', 'mentions': []}]}, {'id': 'Q11369', 'weight': 0.057931103203040506, 'labels': [{'text': 'particles', 'mentions': [{'start': 227, 'end': 236}]}]}, {'id': 'Q8074', 'weight': 0.05530684102502764, 'labels': [{'text': 'Clouds', 'mentions': [{'start': 199, 'end': 205}]}]}, {'id': 'Q11573', 'weight': 0.05138191938853427, 'labels': [{'text': 'km', 'mentions': [{'start': 397, 'end': 399}]}]}]}}
print(res.responses[Entities.Extract.eid()])
# => {'entities': [{'start': 3, 'end': 16, 'ent_type': 'DATE', 'text': '26 April 1986'}, {'start': 18, 'end': 27, 'ent_type': 'GPE', 'text': 'Chernobyl'}, {'start': 190, 'end': 197, 'ent_type': 'DATE', 'text': '10 days'}, {'start': 249, 'end': 267, 'ent_type': 'QUANTITY', 'text': 'thousands of miles'}, {'start': 299, 'end': 305, 'ent_type': 'LOC', 'text': 'Europe'}, {'start': 329, 'end': 338, 'ent_type': 'GPE', 'text': 'Chernobyl'}, {'start': 341, 'end': 354, 'ent_type': 'CARDINAL', 'text': 'about 116,000'}, {'start': 394, 'end': 399, 'ent_type': 'QUANTITY', 'text': '30 km'}], 'visualization': '<div class="entities" style="line-height: 2.5; direction: ltr">On \n<mark class="entity" style="background: #bfe1d9; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    26 April 1986\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">DATE</span>\n</mark>\n, \n<mark class="entity" style="background: #feca74; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    Chernobyl\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">GPE</span>\n</mark>\n suffered the world’s worst nuclear disaster. An experiment designed to test the safety of the power plant went wrong and caused a fire which spewed radiation for \n<mark class="entity" style="background: #bfe1d9; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    10 days\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">DATE</span>\n</mark>\n. Clouds carrying radioactive particles drifted for \n<mark class="entity" style="background: #e4e7d2; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    thousands of miles\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">QUANTITY</span>\n</mark>\n, releasing toxic rain all over \n<mark class="entity" style="background: #ff9561; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    Europe\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">LOC</span>\n</mark>\n. Those living close to \n<mark class="entity" style="background: #feca74; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    Chernobyl\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">GPE</span>\n</mark>\n - \n<mark class="entity" style="background: #e4e7d2; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    about 116,000\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">CARDINAL</span>\n</mark>\n people - were immediately evacuated. A \n<mark class="entity" style="background: #e4e7d2; padding: 0.45em 0.6em; margin: 0 0.25em; line-height: 1; border-radius: 0.35em;">\n    30 km\n    <span style="font-size: 0.8em; font-weight: bold; line-height: 1; border-radius: 0.35em; text-transform: uppercase; vertical-align: middle; margin-left: 0.5rem">QUANTITY</span>\n</mark>\n exclusion zone was imposed around the damaged reactor. This was later expanded to cover more affected areas.</div>'}

# EndpointModel.ied() returns the id of endpoint which is used in the response 

Most of the time, you will need to apply this process on a dataset. Again, you will gain speed by using bulk request. It allows to perform many operations in the same time.
Here is an example on how to do it:

from PyCrowlingo import Bulk, Pipeline
from PyCrowlingo.ApiModels import *
text = "Est-il recommandé d'utiliser MongoDb pour indexer mes documents ?"
pipelines = [Pipeline().add(Languages.Detect, text=text)] * 300
res = Bulk(client, pipelines).call()
assert len(res.responses) == 300 # True

You can also do it in an iterative way:

from PyCrowlingo import Bulk, Pipeline
from PyCrowlingo.ApiModels import *
text = "Est-il recommandé d'utiliser MongoDb pour indexer mes documents ?"
bulk = Bulk(client)
for i in range(300):
    bulk.add(Pipeline().add(Languages.Detect, text=text))
res = bulk.call()
assert len(res.responses) == 300 # True

Using a bulk will automatically make API requests using batch (you can controle its size using batch_size argument). So that, you don’t have to worry about the management of the query size.

Sometimes, you may face error when you call an endpoint. Every errors are identifiable by their ID.
It can be easily managed on a pythonic way:

from PyCrowlingo.Errors import ModelNotFound, CrowlingoException

model_id = "AskUbuntu"
try:
    client.classifier.clear_model(model_id)
except ModelNotFound:
    client.classifier.create_model(model_id)
except CrowlingoException as e:
    print(e)

Here is the list of available exceptions:

If you want to build custom models, you will have to upload your dataset. You can do it automatically on a CSV by using the function classifier.upload_documents.

client.classifier.upload_csv(model_id, "data.csv", fieldnames=["text", "class_id"], delimiter="\t")

It will split the dataset in several parts to avoid exceed the payload size limit.
If you have a more specific dataset format, you can do it by using the functions listed on the API documentation.

Some functions of Crowlingo might be long, so they are asynchronous. that means it will send you a response before the end of the process. For each one, you have a function to watch the progression and wait until the end of the task.
Here are the functions to wait for each task:

For example, use these lines to train, and wait until the model is deployed:

client.model.train(model_id)
client.model.wait_training(model_id)
client.model.deploy(model_id)
client.model.wait_deploying(model_id)

Crowlingo services can be very useful to create a polyglot chatbot using an existing one. The easiest way is to do it through Rasa.
PyCrowlingo provides packages to easily integrate on Rasa.

To install rasa dependencies, simply enter the following command:

pip install PyCrowlingo[rasa]

Follow the Rasa quick start guide to build your chatbot.

Open the file config.yml and modify the pipeline to integrate Crowlingo NLU components.

Here is an example of a chatbot created with Rasa quick start guide:

language: en
pipeline:
  - name: PyCrowlingo.Rasa.EntitiesExtractor
    token: "<TOKEN>"
  - name: PyCrowlingo.Rasa.IntentClassifier
    token: "<TOKEN>"
    model_id: "intent_rasa"

Train the model:

rasa train

And now, enjoy your multilingual chatbot:

rasa shell
>>> Your input -> Bonjour !
<<< Hey! How are you ?
>>> Your input -> Va bene :)
<<< Great! Carry on!
>>> Your input -> Bist du ein Roboter oder ein Mensch?
<<< I am a bot powered by Rasa