Frequently Asked Questions (FAQs)

The "Unique Identifier" and "Trigger Condition (including Example Queries)" fields are used by the LLM to identify which tool 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 should this tool be used for.

Please follow the steps described on this page to setup authentication for Jira: (https://help.glean.com/en/articles/9006099-authenticate-actions-in-jira)

Type hints are like instructions that help the Glean AI understand and work with different tools better. They're clues that tell the AI what each part of a tool does, making it easier for the AI to get the right information or do the right thing with those tools.

Benefits of Implementing Type Hints

• Simplified Tool Creation: Type hints make it easier for developers to describe their tools' 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 tool's functionality.
• Incorporate Type Hints into Your API Specs:
• Add the selected type hints as structured details in your tool's API specifications.

Supported Type Hints

Below are the type hints currently supported by Glean:

• EmailAddress

This type hint is used for fields that are intended to capture the email address of the user. Example usage:

assignee:
  x-glean-typehint: 'EmailAddress'
  type: string
  description: User to which the issue is assigned.

• Content

This hint is applied to fields that deal with large amounts of text or content. It's ideal for tools that generate, modify, or display content, ensuring that the information is handled appropriately. Example usage:

description:
  x-glean-typehint: 'Content'
  type: string
  description: Rich description.

• JiraProjectId

This type hint is for fields that require a JIRA project ID. It's used in contexts where actions or information are specific to a particular JIRA project, helping to ensure that operations are correctly scoped. Example usage:

pid:
  x-glean-typehint: 'JiraProjectID'
  type: string
  description: Project ID where the ticket is created.

• JiraComponentId

This hint is designated for fields that involve a JIRA component ID. It's useful for tools that need to interact with specific components within a JIRA project, facilitating precise and relevant operations. Example usage:

components:
  x-glean-typehint: 'JiraComponentId'
  type: string
  description: Component Id where the ticket should be filed.

By incorporating these type hints into your tool's API specifications, you can enhance the Glean AI assistant's understanding and handling of your tool, leading to a more seamless integration and a better overall user experience. If you have any further questions or require assistance, our developer support team is here to help.

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 tool 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.