# OpenAI Assistant

## Method Input

| Tab           | Parameter                  | Value                                                                                                                                                                                            |
| ------------- | -------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Method Inputs | Method Name                | OpenAIAssistantMethod                                                                                                                                                                            |
|               | Request Type               | openai-assistant                                                                                                                                                                                 |
|               | Parameters: model          | A suitable model of gpt as per the app requirement                                                                                                                                               |
|               | Parameters: systemMessage  | This defines the guardrail for the app. In the example below, it's taking from a internal content JSON file and managed parameters.{{Session.StoreDescription}} ,{{App.AIContent.SystemMessage}} |
|               | Parameters: userQuestion   | The input query from the user. It could also be plain text or it could be derived from input parameters.e.g. 'what services does ACME provide?' or {{UserInput}                                  |
|               | Parameters: streaming      | False                                                                                                                                                                                            |
|               | Parameters: sessionTime    | 10 ( Time inminutes which will be used to maintain conversation history)                                                                                                                         |
|               | Parameters: OrganizationID | {{Context.OrganizationID}}                                                                                                                                                                       |
|               | Parameters: EmployeeID     | {{Context.EmployeeID}}                                                                                                                                                                           |

<figure><img src="/files/mWVl4yhxJTJ5BUTaauOe" alt=""><figcaption></figcaption></figure>


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://docs.ixhello.com/ixhc/general/edit-custom-apps/methods/data-source-generative-ai/open-ai/openai-assistant.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
