GPortal Query Vector Embedding icon

GPortal Query Vector Embedding

Query vector embedding from GPortal API

GPortal Query Vector Embedding

AI-generated

Overview

This node queries vector embeddings from the GPortal API based on a provided query string. It is useful for scenarios where you need to retrieve vector representations of text for tasks such as semantic search, similarity matching, or machine learning applications. For example, you can input a search phrase and get back vector embeddings that represent the semantic meaning of the phrase, which can then be used to find similar entities or documents.

Use Case Examples

  1. Input a query string to get its vector embedding and use it to find similar items in a database.
  2. Retrieve vector embeddings filtered by entity name and version to narrow down search results.

Properties

Name Meaning
Query String The text query for which the vector embedding is requested.
Num Candidates The number of candidate embeddings to consider in the query.
Limit The maximum number of results to return from the query.
Entity Name Optional filter to specify the entity name to narrow down the query results.
Version Optional version number to filter the query results.

Output

JSON

  • json - The JSON response from the GPortal API containing the vector embedding results.

Dependencies

  • Requires GPortal API credentials with a domain URL for authentication and API access.

Troubleshooting

  • If the node fails, check that the GPortal API credentials are correctly configured and the domain URL is valid.
  • Ensure the query string is not empty as it is required.
  • If the API returns an error, the node will throw unless 'Continue On Fail' is enabled, in which case the error message will be included in the output JSON.
  • Verify network connectivity to the GPortal API endpoint.

Discussion