Get Started
Indexing
- Get Started
- Guides
- Authentication
- Datasources
- Documents
- Debugging
- OpenAPI Spec
Client
- Get Started
- Guides
- Search
- OpenAPI Spec
Web SDK
- Get Started
- Components
- Guides
Actions
- Get Started
- Examples
- OpenAPI Spec
FAQ
Frequently asked questions about implementing and using Actions on Glean’s platform
Common Questions
The “Unique Identifier” and “Trigger Condition (including Example Queries)” fields are used by the LLM to identify which action it should invoke/use for a user’s query.
Make sure to give a detailed trigger condition and example queries, to ensure LLM knows exactly what user queries this action should be used for.
Please follow the steps described on this page to setup authentication for Jira.
Type hints are like instructions that help the Glean AI understand and work with different actions better. They’re clues that tell the AI what each part of an action does, making it easier for the AI to get the right information or do the right thing with those actions.
Benefits of Implementing Type Hints
Type hints provide two key advantages:
- Simplified Action Creation: Type hints make it easier for developers to describe their actions’ capabilities and requirements.
- Better at Getting Information and Doing Tasks: Type hints give clear instructions on gathering data or performing actions, leading to more accurate and relevant results from the AI.
How to Use Type Hints
To use type-hints, consider the following steps:
- Identify Relevant Type Hints: Review the list of supported type hints to determine which ones align with your action’s functionality.
- Incorporate Type Hints into Your API Specs: Add the selected type hints as structured details in your action’s API specifications.
Supported Type Hints
Here are the type hints currently supported by Glean:
Content
Applied to fields that deal with large amounts of text or content. Ideal for tools that generate, modify, or display content.
description:
x-glean-typehint: 'Content'
type: string
description: Rich description.
EmailAddress
Used for fields that capture the email address of the user.
assignee:
x-glean-typehint: 'EmailAddress'
type: string
description: User to which the issue is assigned.
JiraComponentId
Designated for fields involving a JIRA component ID.
components:
x-glean-typehint: 'JiraComponentId'
type: string
description: Component Id where the ticket should be filed.
JiraIssueId
Used for fields that interact with a specific JIRA issue.
issue:
x-glean-typehint: 'JiraIssueId'
type: string
description: Issue Id on which comment should be posted.
JiraIssuePriority
For fields that denote the priority of a Jira issue.
priority:
x-glean-typehint: 'JiraIssuePriority'
type: integer
description: Numeric priority. 1 (Highest) to 5 (Lowest)
minimum: 1
maximum: 5
JiraIssueType
For fields that denote a Jira issue type.
issue_type:
x-glean-typehint: 'JiraIssueType'
type: integer
description: Issue type. 10000 refers to Epic, 10001 to Story, 10002 to Task, 10003 to Sub-Task, 10004 to Bug.
JiraProjectID
For fields requiring a JIRA project ID.
pid:
x-glean-typehint: 'JiraProjectID'
type: string
description: Project ID where the ticket is created.
ResultUrl
For fields containing the URL of created objects from write actions.
jiraTicketUrl:
x-glean-typehint: 'ResultUrl'
type: string
description: Url of the created object.
Yes, please contact our team for information on how to do this.
The response from the service you’re connecting to retrieve content using your retrieval action will be sent to the LLM to create the final response. Hence, please ensure that the data returned is not larger than ~8000 characters. Depending on the LLM model being used, larger responses will be truncated from the end.