96 lines
3.1 KiB
Text
96 lines
3.1 KiB
Text
import Admonition from "@theme/Admonition";
|
||
|
||
# Utilities
|
||
|
||
<Admonition type="caution" icon="🚧" title="ZONE UNDER CONSTRUCTION">
|
||
<p>
|
||
We appreciate your understanding as we polish our documentation – it may
|
||
contain some rough edges. Share your feedback or report issues to help us
|
||
improve! 🛠️📝
|
||
</p>
|
||
</Admonition>
|
||
|
||
Utilities are a set of actions that can be used to perform common tasks in a flow. They are available in the **Utilities** section in the sidebar.
|
||
|
||
---
|
||
|
||
### GET Request
|
||
|
||
Make a GET request to the given URL.
|
||
|
||
**Params**
|
||
|
||
- **URL:** The URL to make the request to. There can be more than one URL, in which case the request will be made to each URL in order.
|
||
- **Headers:** A dictionary of headers to send with the request.
|
||
|
||
**Output**
|
||
|
||
- **List of Documents:** A list of Documents containing the JSON response from each request.
|
||
|
||
---
|
||
|
||
### POST Request
|
||
|
||
Make a POST request to the given URL.
|
||
|
||
**Params**
|
||
|
||
- **URL:** The URL to make the request to.
|
||
- **Headers:** A dictionary of headers to send with the request.
|
||
- **Document:** The Document containing a JSON object to send with the request.
|
||
|
||
**Output**
|
||
|
||
- **Document:** The JSON response from the request as a Document.
|
||
|
||
---
|
||
|
||
### Update Request
|
||
|
||
Make a PATCH or PUT request to the given URL.
|
||
|
||
**Params**
|
||
|
||
- **URL:** The URL to make the request to.
|
||
- **Headers:** A dictionary of headers to send with the request.
|
||
- **Document:** The Document containing a JSON object to send with the request.
|
||
- **Method:** The HTTP method to use for the request. Can be either `PATCH` or `PUT`.
|
||
|
||
**Output**
|
||
|
||
- **Document:** The JSON response from the request as a Document.
|
||
|
||
---
|
||
|
||
### JSON Document Builder
|
||
|
||
Build a Document containing a JSON object using a key and another Document page content.
|
||
|
||
**Params**
|
||
|
||
- **Key:** The key to use for the JSON object.
|
||
- **Document:** The Document page to use for the JSON object.
|
||
|
||
**Output**
|
||
|
||
- **List of Documents:** A list containing the Document with the JSON object.
|
||
|
||
## Unique ID Generator
|
||
|
||
Generates a unique identifier (UUID) for each instance it is invoked, providing a distinct and reliable identifier suitable for a variety of applications.
|
||
|
||
**Params**
|
||
|
||
- **Value:** This field displays the generated unique identifier (UUID). The UUID is generated dynamically for each instance of the component, ensuring uniqueness across different uses.
|
||
|
||
**Output**
|
||
|
||
- Returns a unique identifier (UUID) as a string. This UUID is generated using Python's `uuid` module, ensuring that each identifier is unique and can be used as a reliable reference in your application.
|
||
|
||
<Admonition type="note" title="Note">
|
||
<p>
|
||
The Unique ID Generator is crucial for scenarios requiring distinct identifiers, such as session management, transaction tracking, or any context where different instances or entities must be uniquely identified. The generated UUID is provided as a hexadecimal string, offering a high level of uniqueness and security for identification purposes.
|
||
</p>
|
||
</Admonition>
|
||
|
||
For additional information and examples, please consult the [Langflow Components Custom Documentation](http://docs.langflow.org/components/custom).
|