@qlik/api 1.41.0 → 1.43.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/api-keys.d.ts +2 -2
- package/api-keys.js +3 -3
- package/apps.d.ts +2 -2
- package/apps.js +3 -3
- package/assistants.d.ts +2 -2
- package/assistants.js +3 -3
- package/audits.d.ts +3 -3
- package/audits.js +17 -4
- package/auth-types.d.ts +1 -1
- package/auth-types.js +1 -1
- package/auth.d.ts +2 -2
- package/auth.js +2 -2
- package/automation-connections.d.ts +2 -2
- package/automation-connections.js +3 -3
- package/automations.d.ts +3 -3
- package/automations.js +3 -3
- package/automl-deployments.d.ts +2 -2
- package/automl-deployments.js +5 -3
- package/automl-predictions.d.ts +2 -2
- package/automl-predictions.js +15 -3
- package/brands.d.ts +2 -2
- package/brands.js +3 -3
- package/chunks/{api-keys-CI44OuNR.d.ts → api-keys-C-ZqA-wl.d.ts} +1 -1
- package/chunks/{apps-BiGof9WJ.d.ts → apps-CJH5JjKB.d.ts} +1 -1
- package/chunks/{assistants-CDtI99Yr.d.ts → assistants-BsDbpzl4.d.ts} +7 -1
- package/chunks/{audits-C-UDFprK.d.ts → audits-5CBpwcdx.d.ts} +24 -2
- package/chunks/{auth-DhI7LQIw.js → auth-CCj082fh.js} +4 -4
- package/chunks/{auth-B5Hx9GeQ.d.ts → auth-DFOXWfqh.d.ts} +3 -3
- package/chunks/{auth-DBrXfv7D.js → auth-IDN6Z4Nr.js} +2 -2
- package/chunks/{auth-functions-DHRxWU6t.js → auth-functions-CZbgZARw.js} +72 -24
- package/chunks/{auth-types-BlCWK0FP.d.ts → auth-types-B1c_1Nca.d.ts} +4 -1
- package/chunks/{automation-connections-keN9CuNO.d.ts → automation-connections-DRQDgw7Q.d.ts} +1 -1
- package/chunks/{automations-CFRnQ8sX.d.ts → automations-arVbySrW.d.ts} +13 -4
- package/chunks/{automl-deployments-D05clUGa.d.ts → automl-deployments-B-WuR_zE.d.ts} +5 -1
- package/chunks/{automl-predictions-Ddp6PdpE.d.ts → automl-predictions-CewW0eZn.d.ts} +25 -1
- package/chunks/{brands-hEcnkdfg.d.ts → brands-C4eALPrs.d.ts} +1 -1
- package/chunks/{collections-CuX8Cp8Z.d.ts → collections-Djmd9gof.d.ts} +1 -1
- package/chunks/{conditions-DUmPB4Ej.d.ts → conditions-BRDxUbgu.d.ts} +1 -1
- package/chunks/{consumption-CSptDhk9.d.ts → consumption-UNw8R7jN.d.ts} +1 -1
- package/chunks/{csp-origins-v_UyOSK9.d.ts → csp-origins-_4HBSdgU.d.ts} +1 -1
- package/chunks/{csrf-token-DZK6GX6Z.d.ts → csrf-token-CsvbqXyY.d.ts} +1 -1
- package/chunks/{data-alerts-DwPcCvHP.d.ts → data-alerts-DSV3VOnW.d.ts} +1 -1
- package/chunks/{data-assets-BPMOGSO7.d.ts → data-assets-C3U3T_lj.d.ts} +1 -1
- package/chunks/{data-connections-DK1AhSi4.d.ts → data-connections-BYNfX1Fl.d.ts} +1 -1
- package/chunks/{data-credentials-BDCHbRwM.d.ts → data-credentials-CgCjw_Cn.d.ts} +1 -1
- package/chunks/{data-files-D7mlQnrw.d.ts → data-files-DH19MfYE.d.ts} +1 -1
- package/chunks/{data-qualities-Z554f_p6.d.ts → data-qualities-BogHQw4I.d.ts} +1 -1
- package/chunks/{data-sets-AcCLu1zw.d.ts → data-sets-B27GmshO.d.ts} +1 -1
- package/chunks/{data-sources-DNnmr1Qi.d.ts → data-sources-D_TRdWV-.d.ts} +5 -1
- package/chunks/{data-stores-Bofu7fl5.d.ts → data-stores-BjfzMp9W.d.ts} +1 -1
- package/chunks/{dcaas-DK4f7Rrs.d.ts → dcaas-A7hfpAI5.d.ts} +1 -1
- package/chunks/{di-projects-uem8xKkX.d.ts → di-projects-mdshgyFv.d.ts} +70 -13
- package/chunks/{direct-access-agents-BbSiWlMD.d.ts → direct-access-agents-CfUpbi73.d.ts} +74 -5
- package/chunks/{dist-CjqdvDf3.js → dist-UZqmL_Q6.js} +15 -10
- package/chunks/{encryption-CMJWtMcm.d.ts → encryption-CjBmNQDZ.d.ts} +1 -1
- package/chunks/{extensions-Ct2JAsbk.d.ts → extensions-D05y2FWk.d.ts} +1 -1
- package/chunks/global-types-BGMD2sDY.js +1 -0
- package/chunks/{glossaries-Drx-EwiU.d.ts → glossaries-vYbykU3r.d.ts} +1 -1
- package/chunks/{groups-C-R5oUEa.d.ts → groups-BapgngJf.d.ts} +1 -1
- package/chunks/{identity-providers-Bj88evsO.d.ts → identity-providers-CAxsp9hP.d.ts} +1 -1
- package/chunks/{interceptors-e6hoYE8W.d.ts → interceptors-BF556LaK.d.ts} +1 -1
- package/chunks/{interceptors-DD0vKL8_.js → interceptors-DBoV6UkN.js} +1 -1
- package/chunks/{invoke-fetch-B-ZucHu9.js → invoke-fetch-09EW5w1d.js} +3 -3
- package/chunks/{invoke-fetch-NdtGGVxy.js → invoke-fetch-fXOUPARi.js} +4 -4
- package/chunks/{items-BnN6gI0J.d.ts → items-CjVrNg57.d.ts} +1 -1
- package/chunks/{knowledgebases-tmPZVD6i.d.ts → knowledgebases-BFiV7Fwh.d.ts} +1 -1
- package/chunks/{licenses-DAPVQuFJ.d.ts → licenses-yZKgQ2k6.d.ts} +1 -1
- package/chunks/{lineage-graphs-Q4LiGGtL.d.ts → lineage-graphs-Bkc04N-t.d.ts} +1 -1
- package/chunks/{ml-C80TkK1J.d.ts → ml-CABYvU_L.d.ts} +8 -14
- package/chunks/{notes-CHvadRai.d.ts → notes-C5HjmBeI.d.ts} +1 -1
- package/chunks/{notifications-BhS8s4Eo.d.ts → notifications-DfP7aWPH.d.ts} +1 -1
- package/chunks/{oauth-clients-D1f8xiFC.d.ts → oauth-clients-BmMEDuET.d.ts} +1 -1
- package/chunks/{oauth-tokens-DteoDifd.d.ts → oauth-tokens-Dimf19DE.d.ts} +1 -1
- package/chunks/{public-runtime-modules-lsJEDVxt.js → public-runtime-modules-P9LEbn8i.js} +3 -3
- package/chunks/{qix-J4MO8SAa.d.ts → qix-C1WaB-67.d.ts} +3 -18
- package/chunks/{qix-CwYrlHFT.js → qix-C86sBDw3.js} +1 -1
- package/chunks/{qix-bnv1_Kxc.js → qix-Ds6X5svJ.js} +6 -6
- package/chunks/{qix-chunk-entrypoint-ByJzCY0D.js → qix-chunk-entrypoint-CpkRq84_.js} +427 -90
- package/chunks/{questions-BiR5-mZ4.d.ts → questions-CFN7BgWt.d.ts} +1 -1
- package/chunks/{quotas-GTQL9uPt.d.ts → quotas-BUH2e2K_.d.ts} +1 -1
- package/chunks/{reload-tasks-CmXJp5va.d.ts → reload-tasks-DN3X2-30.d.ts} +1 -1
- package/chunks/{reloads-3XgvVnbq.d.ts → reloads-ClLQO7Vt.d.ts} +1 -1
- package/chunks/{report-templates-BowaTti4.d.ts → report-templates-D5KOFkRi.d.ts} +1 -1
- package/chunks/{reports-oosnUaFo.d.ts → reports-CRwCogRL.d.ts} +94 -3
- package/chunks/{roles-D93ENaRt.d.ts → roles-DCzyiLdU.d.ts} +1 -1
- package/chunks/{sharing-tasks-BMDAjWTj.d.ts → sharing-tasks-DsxFrADQ.d.ts} +1 -1
- package/chunks/{spaces-DZI6zKZi.d.ts → spaces-B0cx23Nc.d.ts} +4 -4
- package/chunks/{tasks-BWmS6L8Y.d.ts → tasks-DWfE5JM_.d.ts} +1 -1
- package/chunks/{temp-contents-CZVb5P0V.d.ts → temp-contents-CU94UTZU.d.ts} +1 -1
- package/chunks/{tenants-BDH4DmcO.d.ts → tenants-DvtbiwAP.d.ts} +1 -1
- package/chunks/{themes-BkubWfOE.d.ts → themes-BPkyCLWS.d.ts} +1 -1
- package/chunks/{transports-CO9kRJg5.d.ts → transports-DlRmSWLj.d.ts} +1 -1
- package/chunks/{ui-config-DIOnLEV9.d.ts → ui-config-BqX-bPjf.d.ts} +1 -1
- package/chunks/{users-DM-ZfzQB.d.ts → users-CuQ0nboa.d.ts} +1 -1
- package/chunks/{utils-qEQ6sEXX.js → utils-CAGXTaqJ.js} +14 -1
- package/chunks/{web-integrations-BjVMC88M.d.ts → web-integrations-D54LCd0Z.d.ts} +1 -1
- package/chunks/{web-notifications-D-eA8h1I.d.ts → web-notifications-sUlHGnmy.d.ts} +1 -1
- package/chunks/{webhooks-Dytyr5nk.d.ts → webhooks-Dw0FIeFq.d.ts} +1 -1
- package/collections.d.ts +2 -2
- package/collections.js +3 -3
- package/conditions.d.ts +2 -2
- package/conditions.js +3 -3
- package/consumption.d.ts +2 -2
- package/consumption.js +3 -3
- package/csp-origins.d.ts +2 -2
- package/csp-origins.js +3 -3
- package/csrf-token.d.ts +2 -2
- package/csrf-token.js +3 -3
- package/data-alerts.d.ts +2 -2
- package/data-alerts.js +3 -3
- package/data-assets.d.ts +2 -2
- package/data-assets.js +3 -3
- package/data-connections.d.ts +2 -2
- package/data-connections.js +3 -3
- package/data-credentials.d.ts +2 -2
- package/data-credentials.js +3 -3
- package/data-files.d.ts +2 -2
- package/data-files.js +3 -3
- package/data-qualities.d.ts +2 -2
- package/data-qualities.js +3 -3
- package/data-sets.d.ts +2 -2
- package/data-sets.js +3 -3
- package/data-sources.d.ts +2 -2
- package/data-sources.js +4 -3
- package/data-stores.d.ts +2 -2
- package/data-stores.js +3 -3
- package/dcaas.d.ts +2 -2
- package/dcaas.js +3 -3
- package/di-projects.d.ts +3 -3
- package/di-projects.js +4 -4
- package/direct-access-agents.d.ts +3 -3
- package/direct-access-agents.js +46 -5
- package/docs/authentication.md +65 -1
- package/docs/rest.md +1 -1
- package/encryption.d.ts +2 -2
- package/encryption.js +3 -3
- package/extensions.d.ts +2 -2
- package/extensions.js +3 -3
- package/global-types.d.ts +1 -1
- package/global-types.js +3 -1
- package/glossaries.d.ts +2 -2
- package/glossaries.js +3 -3
- package/groups.d.ts +2 -2
- package/groups.js +3 -3
- package/identity-providers.d.ts +2 -2
- package/identity-providers.js +3 -3
- package/index.d.ts +63 -63
- package/index.js +74 -69
- package/interceptors.d.ts +2 -2
- package/interceptors.js +2 -2
- package/invoke-fetch-types.d.ts +1 -1
- package/items.d.ts +2 -2
- package/items.js +3 -3
- package/knowledgebases.d.ts +2 -2
- package/knowledgebases.js +3 -3
- package/licenses.d.ts +2 -2
- package/licenses.js +3 -3
- package/lineage-graphs.d.ts +2 -2
- package/lineage-graphs.js +3 -3
- package/ml.d.ts +3 -3
- package/ml.js +4 -4
- package/notes.d.ts +2 -2
- package/notes.js +3 -3
- package/notifications.d.ts +2 -2
- package/notifications.js +3 -3
- package/oauth-clients.d.ts +2 -2
- package/oauth-clients.js +3 -3
- package/oauth-tokens.d.ts +2 -2
- package/oauth-tokens.js +3 -3
- package/package.json +2 -2
- package/qix.d.ts +4 -4
- package/qix.js +2 -2
- package/questions.d.ts +2 -2
- package/questions.js +3 -3
- package/quotas.d.ts +2 -2
- package/quotas.js +3 -3
- package/reload-tasks.d.ts +2 -2
- package/reload-tasks.js +3 -3
- package/reloads.d.ts +2 -2
- package/reloads.js +3 -3
- package/report-templates.d.ts +2 -2
- package/report-templates.js +3 -3
- package/reports.d.ts +3 -3
- package/reports.js +22 -4
- package/roles.d.ts +2 -2
- package/roles.js +3 -3
- package/sharing-tasks.d.ts +2 -2
- package/sharing-tasks.js +3 -3
- package/spaces.d.ts +2 -2
- package/spaces.js +3 -3
- package/tasks.d.ts +2 -2
- package/tasks.js +3 -3
- package/temp-contents.d.ts +2 -2
- package/temp-contents.js +3 -3
- package/tenants.d.ts +2 -2
- package/tenants.js +3 -3
- package/themes.d.ts +2 -2
- package/themes.js +3 -3
- package/transports.d.ts +2 -2
- package/transports.js +3 -3
- package/ui-config.d.ts +2 -2
- package/ui-config.js +3 -3
- package/users.d.ts +2 -2
- package/users.js +3 -3
- package/web-integrations.d.ts +2 -2
- package/web-integrations.js +3 -3
- package/web-notifications.d.ts +2 -2
- package/web-notifications.js +3 -3
- package/webhooks.d.ts +2 -2
- package/webhooks.js +3 -3
- package/website/assets/navigation.js +1 -1
- package/website/assets/search.js +1 -1
- package/website/functions/audits.fetchConsumptionAppAudits.html +3 -0
- package/website/functions/auth.setDefaultHostConfig.html +1 -1
- package/website/functions/automations.getAutomationsUsageMetrics.html +5 -1
- package/website/functions/automations.updateAutomation.html +2 -2
- package/website/functions/automl-deployments.createAutomlDeploymentRealtimePrediction.html +3 -3
- package/website/functions/automl-predictions.createAutomlPredictionJob.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionCoordinateShap.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionNotPredictedReasons.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionPredictions.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionShap.html +3 -3
- package/website/functions/automl-predictions.getAutomlPredictionSource.html +3 -3
- package/website/functions/data-sources.getDataSources.html +4 -3
- package/website/functions/di-projects.getDiProjectDiTaskRuntimeState.html +1 -1
- package/website/functions/direct-access-agents.getDirectAccessAgentConnectorCustomDataTypeMappings.html +1 -1
- package/website/functions/direct-access-agents.getDirectAccessAgentConnectorFilesAllowedPaths.html +5 -0
- package/website/functions/direct-access-agents.putDirectAccessAgentConnectorFilesAllowedPaths.html +6 -0
- package/website/functions/ml.getMlDeploymentAliases.html +2 -1
- package/website/functions/reports.getReportOutputs.html +13 -0
- package/website/interfaces/api-keys.ApiKeysAPI.html +8 -8
- package/website/interfaces/apps.AppsAPI.html +45 -45
- package/website/interfaces/assistants.AssistantsAPI.html +29 -29
- package/website/interfaces/audits.AuditsAPI.html +27 -22
- package/website/interfaces/auth.AuthAPI.html +7 -7
- package/website/interfaces/automation-connections.AutomationConnectionsAPI.html +9 -9
- package/website/interfaces/automations.AutomationsAPI.html +29 -25
- package/website/interfaces/automl-deployments.AutomlDeploymentsAPI.html +7 -7
- package/website/interfaces/automl-predictions.AutomlPredictionsAPI.html +37 -37
- package/website/interfaces/brands.BrandsAPI.html +13 -13
- package/website/interfaces/collections.CollectionsAPI.html +12 -12
- package/website/interfaces/conditions.ConditionsAPI.html +12 -12
- package/website/interfaces/consumption.ConsumptionAPI.html +2 -2
- package/website/interfaces/csp-origins.CspOriginsAPI.html +7 -7
- package/website/interfaces/csrf-token.CsrfTokenAPI.html +2 -2
- package/website/interfaces/data-alerts.DataAlertsAPI.html +17 -17
- package/website/interfaces/data-assets.DataAssetsAPI.html +6 -6
- package/website/interfaces/data-connections.DataConnectionsAPI.html +10 -10
- package/website/interfaces/data-credentials.DataCredentialsAPI.html +6 -6
- package/website/interfaces/data-files.DataFilesAPI.html +13 -13
- package/website/interfaces/data-qualities.DataQualitiesAPI.html +4 -4
- package/website/interfaces/data-sets.DataSetsAPI.html +7 -7
- package/website/interfaces/data-sources.DataSourcesAPI.html +10 -9
- package/website/interfaces/data-stores.DataStoresAPI.html +11 -11
- package/website/interfaces/dcaas.DcaasAPI.html +4 -4
- package/website/interfaces/di-projects.DiProjectsAPI.html +18 -18
- package/website/interfaces/direct-access-agents.DirectAccessAgentsAPI.html +58 -38
- package/website/interfaces/encryption.EncryptionAPI.html +11 -11
- package/website/interfaces/extensions.ExtensionsAPI.html +8 -8
- package/website/interfaces/glossaries.GlossariesAPI.html +25 -25
- package/website/interfaces/groups.GroupsAPI.html +9 -9
- package/website/interfaces/identity-providers.IdentityProvidersAPI.html +9 -9
- package/website/interfaces/interceptors.InterceptorsAPI.html +3 -3
- package/website/interfaces/items.ItemsAPI.html +9 -9
- package/website/interfaces/knowledgebases.KnowledgebasesAPI.html +18 -18
- package/website/interfaces/licenses.LicensesAPI.html +10 -10
- package/website/interfaces/lineage-graphs.LineageGraphsAPI.html +9 -9
- package/website/interfaces/ml.MlAPI.html +48 -46
- package/website/interfaces/notes.NotesAPI.html +3 -3
- package/website/interfaces/notifications.NotificationsAPI.html +2 -2
- package/website/interfaces/oauth-clients.OauthClientsAPI.html +12 -12
- package/website/interfaces/oauth-tokens.OauthTokensAPI.html +3 -3
- package/website/interfaces/qix.GenericObject.html +1 -1
- package/website/interfaces/questions.QuestionsAPI.html +3 -3
- package/website/interfaces/quotas.QuotasAPI.html +3 -3
- package/website/interfaces/reload-tasks.ReloadTasksAPI.html +6 -6
- package/website/interfaces/reloads.ReloadsAPI.html +5 -5
- package/website/interfaces/report-templates.ReportTemplatesAPI.html +8 -8
- package/website/interfaces/reports.ReportsAPI.html +26 -8
- package/website/interfaces/roles.RolesAPI.html +6 -6
- package/website/interfaces/sharing-tasks.SharingTasksAPI.html +14 -14
- package/website/interfaces/spaces.SpacesAPI.html +18 -18
- package/website/interfaces/tasks.TasksAPI.html +11 -11
- package/website/interfaces/temp-contents.TempContentsAPI.html +4 -4
- package/website/interfaces/tenants.TenantsAPI.html +7 -7
- package/website/interfaces/themes.ThemesAPI.html +8 -8
- package/website/interfaces/transports.TransportsAPI.html +7 -7
- package/website/interfaces/ui-config.UiConfigAPI.html +8 -8
- package/website/interfaces/users.UsersAPI.html +10 -10
- package/website/interfaces/web-integrations.WebIntegrationsAPI.html +6 -6
- package/website/interfaces/web-notifications.WebNotificationsAPI.html +7 -7
- package/website/interfaces/webhooks.WebhooksAPI.html +11 -11
- package/website/modules/audits.html +1 -1
- package/website/modules/auth.html +1 -1
- package/website/modules/automations.html +1 -1
- package/website/modules/automl-deployments.html +1 -1
- package/website/modules/automl-predictions.html +1 -1
- package/website/modules/di-projects.html +1 -1
- package/website/modules/direct-access-agents.html +1 -1
- package/website/modules/ml.html +1 -1
- package/website/modules/qix.html +1 -1
- package/website/modules/reports.html +1 -1
- package/website/types/api-keys.Error.html +1 -1
- package/website/types/apps.Error.html +1 -1
- package/website/types/apps.Evaluation.html +1 -1
- package/website/types/apps.RecommendItems.html +1 -1
- package/website/types/apps.RecommendedAnalysis.html +1 -1
- package/website/types/assistants.Assistant.html +4 -2
- package/website/types/assistants.CreateAssistant.html +4 -2
- package/website/types/assistants.CreateAssistantWithAvatar.html +4 -2
- package/website/types/assistants.PromptInput.html +1 -1
- package/website/types/audits.EventExtensions.html +1 -1
- package/website/types/audits.FetchConsumptionAppAuditsHttpError.html +4 -0
- package/website/types/audits.FetchConsumptionAppAuditsHttpResponse.html +4 -0
- package/website/types/audits.GetSettingsResult.html +1 -1
- package/website/types/automations.AutomationDetailUpdateRequestObject.html +6 -0
- package/website/types/automations.CopyAutomationHttpResponse.html +1 -1
- package/website/types/automations.RunDetailResponseObject.html +1 -1
- package/website/types/automl-deployments.Error.html +1 -1
- package/website/types/automl-predictions.Error.html +1 -1
- package/website/types/collections.CollectionByIdPatch.html +1 -1
- package/website/types/csp-origins.CSPEntry.html +1 -1
- package/website/types/data-alerts.AlertingExecutionListResponse.html +1 -1
- package/website/types/data-alerts.AlertingTaskListResponse.html +1 -1
- package/website/types/data-connections.ActionDeleteRequest.html +1 -1
- package/website/types/data-connections.ActionUpdateRequest.html +1 -1
- package/website/types/data-connections.BulkResponse.html +1 -1
- package/website/types/data-connections.Link.html +1 -1
- package/website/types/data-connections.PatchRequest.html +1 -1
- package/website/types/data-connections.TopLevelLink.html +3 -3
- package/website/types/data-credentials.Link.html +1 -1
- package/website/types/data-credentials.PatchRequest.html +1 -1
- package/website/types/data-qualities.DataQualityComputationRequest.html +1 -1
- package/website/types/data-sources.GetDataSourceGatewaysHttpResponse.html +1 -1
- package/website/types/data-sources.QriDefinition.html +2 -2
- package/website/types/di-projects.AsyncActionDetails.html +1 -1
- package/website/types/di-projects.DataTaskInstanceState.html +29 -2
- package/website/types/di-projects.DataTaskRuntimeState.html +6 -0
- package/website/types/di-projects.DataTaskType.html +1 -1
- package/website/types/di-projects.GetDiExportProjectVariablesRsp.html +3 -2
- package/website/types/di-projects.GetDiProjectDiTaskRuntimeStateHttpResponse.html +2 -2
- package/website/types/direct-access-agents.FileConnectorAllowedPath.html +5 -0
- package/website/types/direct-access-agents.FileConnectorAllowedPathsResponse.html +3 -0
- package/website/types/direct-access-agents.GetDirectAccessAgentConnectorFilesAllowedPathsHttpError.html +4 -0
- package/website/types/direct-access-agents.GetDirectAccessAgentConnectorFilesAllowedPathsHttpResponse.html +4 -0
- package/website/types/direct-access-agents.Operation.html +2 -2
- package/website/types/direct-access-agents.PutDirectAccessAgentConnectorFilesAllowedPathsHttpError.html +4 -0
- package/website/types/direct-access-agents.PutDirectAccessAgentConnectorFilesAllowedPathsHttpResponse.html +4 -0
- package/website/types/direct-access-agents.UpdateFileConnectorAllowedPathsRequest.html +3 -0
- package/website/types/direct-access-agents.UpdateOdbcCustomTypeMappingsRequest.html +2 -1
- package/website/types/encryption.KeyProvider.html +1 -1
- package/website/types/global-types.PerformInteractiveLoginFn.html +1 -1
- package/website/types/groups.AssignedRoles.html +1 -1
- package/website/types/groups.AssignedRolesRefIDs.html +1 -1
- package/website/types/groups.AssignedRolesRefNames.html +1 -1
- package/website/types/groups.Error.html +1 -1
- package/website/types/identity-providers.CreateJWTAuthPayload.html +1 -1
- package/website/types/identity-providers.CreateOIDCPayload.html +2 -2
- package/website/types/identity-providers.CreateSAMLPayload.html +2 -2
- package/website/types/identity-providers.Error.html +1 -1
- package/website/types/identity-providers.IDPOIDC.html +1 -1
- package/website/types/identity-providers.IDPSAML.html +1 -1
- package/website/types/identity-providers.IDPsStatus.html +1 -1
- package/website/types/identity-providers.Links.html +3 -3
- package/website/types/identity-providers.PendingResult.html +1 -1
- package/website/types/interceptors.RestInterceptor.html +1 -1
- package/website/types/invoke-fetch-types.DownloadableBlob.html +1 -1
- package/website/types/items.ItemsSettingsPatch.html +1 -1
- package/website/types/licenses.AssignmentsActionsAddRequest.html +1 -1
- package/website/types/licenses.AssignmentsActionsAddResponse.html +1 -1
- package/website/types/licenses.AssignmentsActionsDeleteRequest.html +1 -1
- package/website/types/licenses.AssignmentsActionsDeleteResponse.html +1 -1
- package/website/types/licenses.AssignmentsActionsUpdateRequest.html +1 -1
- package/website/types/licenses.AssignmentsActionsUpdateResponse.html +1 -1
- package/website/types/licenses.AssignmentsResponse.html +1 -1
- package/website/types/licenses.ConsumptionEventsResponse.html +1 -1
- package/website/types/licenses.ErrorResponse.html +1 -1
- package/website/types/licenses.LicenseOverview.html +2 -2
- package/website/types/lineage-graphs.ErrorResponse500.html +1 -1
- package/website/types/lineage-graphs.Graph.html +1 -1
- package/website/types/lineage-graphs.Node.html +1 -1
- package/website/types/ml.APIError.html +1 -1
- package/website/types/ml.AliasFindResponse.html +1 -1
- package/website/types/ml.AliasGetResponse.html +1 -1
- package/website/types/ml.AliasPostResponse.html +1 -1
- package/website/types/ml.BatchPredictionActionResponse.html +1 -1
- package/website/types/ml.BatchPredictionFindResponse.html +1 -1
- package/website/types/ml.BatchPredictionGetResponse.html +1 -1
- package/website/types/ml.BatchPredictionPatch.html +1 -1
- package/website/types/ml.BatchPredictionPostResponse.html +1 -1
- package/website/types/ml.BatchPredictionScheduleGetResponse.html +1 -1
- package/website/types/ml.BatchPredictionScheduleInput.html +1 -1
- package/website/types/ml.BatchPredictionSchedulePatch.html +1 -1
- package/website/types/ml.BatchPredictionSchedulePutResponse.html +1 -1
- package/website/types/ml.DeploymentFindResponse.html +1 -1
- package/website/types/ml.DeploymentGetResponse.html +1 -1
- package/website/types/ml.DeploymentPatch.html +1 -1
- package/website/types/ml.DeploymentPostResponse.html +1 -1
- package/website/types/ml.ExperimentFindResponse.html +1 -1
- package/website/types/ml.ExperimentGetResponse.html +1 -1
- package/website/types/ml.ExperimentInput.html +1 -1
- package/website/types/ml.ExperimentModelRecommendationPostResponse.html +1 -1
- package/website/types/ml.ExperimentPostResponse.html +1 -1
- package/website/types/ml.ExperimentType.html +1 -1
- package/website/types/ml.ExperimentVersionFindResponse.html +1 -1
- package/website/types/ml.ExperimentVersionGetResponse.html +1 -1
- package/website/types/ml.ExperimentVersionPatch.html +1 -1
- package/website/types/ml.ExperimentVersionPostResponse.html +1 -1
- package/website/types/ml.Insights.html +1 -1
- package/website/types/ml.ModelAlgorithm.html +1 -1
- package/website/types/ml.ModelAlgorithmAbbreviation.html +1 -1
- package/website/types/ml.ModelFindResponse.html +1 -1
- package/website/types/ml.ModelGetResponse.html +1 -1
- package/website/types/ml.Pipeline.html +2 -3
- package/website/types/ml.ProfileInsights.html +1 -1
- package/website/types/ml.ProfileInsightsGetResponse.html +1 -1
- package/website/types/ml.ProfileInsightsInput.html +1 -1
- package/website/types/ml.ResponseLinks.html +5 -5
- package/website/types/notifications.NotificationItem.html +1 -1
- package/website/types/oauth-clients.ClientSecrets.html +1 -1
- package/website/types/oauth-clients.OAuthClientAdminListItem.html +1 -1
- package/website/types/oauth-clients.OAuthClientAdminReadResponse.html +1 -1
- package/website/types/oauth-clients.OAuthClientCreateRequest.html +1 -1
- package/website/types/oauth-clients.OAuthClientCreateResponse.html +1 -1
- package/website/types/oauth-clients.OAuthClientReadResponse.html +1 -1
- package/website/types/qix.BookmarkList.html +3 -6
- package/website/types/qix.BookmarkListDef.html +2 -5
- package/website/types/qix.DocAction.html +1 -1
- package/website/types/qix.NativeGenericObjectFunctions.html +1 -1
- package/website/types/qix.RpcObject.html +1 -1
- package/website/types/qix.UndoInfoObject.html +1 -1
- package/website/types/qix.UseAppHook.html +1 -1
- package/website/types/questions.Error.html +1 -1
- package/website/types/questions.NLMetricsResponse.html +1 -1
- package/website/types/quotas.Quota.html +1 -1
- package/website/types/reload-tasks.PostTaskBody.html +1 -1
- package/website/types/reload-tasks.PutTaskBody.html +1 -1
- package/website/types/reload-tasks.Task.html +1 -1
- package/website/types/reports.CreateReportHttpResponse.html +2 -2
- package/website/types/reports.GetReportOutputsHttpError.html +4 -0
- package/website/types/reports.GetReportOutputsHttpResponse.html +6 -0
- package/website/types/reports.LinkResponse.html +2 -0
- package/website/types/reports.LinksResponse.html +7 -0
- package/website/types/reports.OutputList.html +4 -0
- package/website/types/reports.OutputListItem.html +13 -0
- package/website/types/reports.PdfOutput.html +1 -1
- package/website/types/reports.PostReportsResponse.html +7 -0
- package/website/types/roles.Error.html +1 -1
- package/website/types/sharing-tasks.SharingExecutionListResponse.html +1 -1
- package/website/types/sharing-tasks.SharingTaskRecurringListResponse.html +1 -1
- package/website/types/sharing-tasks.SharingTaskRecurringResponse.html +1 -1
- package/website/types/spaces.Assignments.html +1 -1
- package/website/types/spaces.Error.html +1 -1
- package/website/types/spaces.Errors.html +1 -1
- package/website/types/spaces.SharePatch.html +1 -1
- package/website/types/spaces.ShareRoleType.html +2 -2
- package/website/types/spaces.Shares.html +1 -1
- package/website/types/spaces.Space.html +1 -1
- package/website/types/spaces.SpacePatch.html +1 -1
- package/website/types/spaces.Spaces.html +1 -1
- package/website/types/tasks.Action.html +1 -1
- package/website/types/tasks.Crondef.html +1 -1
- package/website/types/tasks.Eventstate.html +1 -1
- package/website/types/tasks.Functionref.html +1 -1
- package/website/types/tasks.GetTaskRunLogHttpResponse.html +1 -1
- package/website/types/tasks.Schedule.html +1 -1
- package/website/types/temp-contents.Error.html +1 -1
- package/website/types/tenants.Error.html +1 -1
- package/website/types/tenants.Tenant.html +1 -1
- package/website/types/tenants.TenantPatchErrors.html +1 -1
- package/website/types/tenants.TenantPatchSchema.html +1 -1
- package/website/types/transports.DeleteConfigNotFoundError.html +1 -1
- package/website/types/transports.SendTestMailConfigNotFoundError.html +1 -1
- package/website/types/transports.TenantAdminError.html +1 -1
- package/website/types/transports.UpdateEmailConfigError.html +1 -1
- package/website/types/transports.VerifyConnectionConfigNotFoundError.html +1 -1
- package/website/types/ui-config.JSONPatchPinnedLinkPayload.html +1 -1
- package/website/types/users.AssignedGroups.html +1 -1
- package/website/types/users.AssignedGroupsRefNames.html +1 -1
- package/website/types/users.AssignedRoles.html +1 -1
- package/website/types/users.Error.html +1 -1
- package/website/types/users.InviteErrorItem.html +1 -1
- package/website/types/users.RefIDs.html +1 -1
- package/website/types/users.RefNames.html +1 -1
- package/website/types/users.User.html +1 -1
- package/website/types/users.Users.html +1 -1
- package/website/types/web-integrations.Error.html +1 -1
- package/website/types/web-integrations.WebIntegrationPost.html +1 -1
- package/website/types/web-integrations.WebIntegrations.html +1 -1
- package/website/types/webhooks.Delivery.html +2 -2
- package/website/types/webhooks.WebhookPost.html +1 -1
- package/website/types/webhooks.WebhookResponse.html +1 -1
- package/website/variables/index.auth.html +1 -1
- package/website/variables/index.createQlikApi.html +1 -1
- package/website/variables/qix.QIX_SCHEMA_VERSION.html +1 -1
- package/chunks/global-types-CQrlc6w9.js +0 -0
- package/website/types/ml.ConfigurationKey.html +0 -1
- package/website/types/ml.DataSchemaConfiguration.html +0 -3
- package/website/types/qix.NxGroupMember.html +0 -2
|
@@ -28,15 +28,15 @@
|
|
|
28
28
|
<a href="#updateassistantstarter" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Assistant<wbr/>Starter</span></a>
|
|
29
29
|
<a href="#updateassistantstarterfollowup" class="tsd-index-link"><svg class="tsd-kind-icon" viewBox="0 0 24 24" aria-label="Property"><use href="../assets/icons.svg#icon-1024"></use></svg><span>update<wbr/>Assistant<wbr/>Starter<wbr/>Followup</span></a>
|
|
30
30
|
</div></section></div></details></section></section><details class="tsd-panel-group tsd-member-group tsd-accordion" open><summary class="tsd-accordion-summary" data-key="section-Properties"><svg width="20" height="20" viewBox="0 0 24 24" fill="none" aria-hidden="true"><use href="../assets/icons.svg#icon-chevronDown"></use></svg><h2>Properties</h2></summary><section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="clearcache"><span>clear<wbr/>Cache</span><a href="#clearcache" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">clearCache</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">()</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">void</span></div><div class="tsd-comment tsd-typography"><p>Clears the cache for assistants api requests.</p>
|
|
31
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
31
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">()</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">void</span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Clears the cache for assistants api requests.</p>
|
|
32
32
|
</div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4><div class="tsd-comment tsd-typography"></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createassistant"><span>create<wbr/>Assistant</span><a href="#createassistant" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">createAssistant</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.CreateAssistant.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistant</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates a new assistant.</p>
|
|
33
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
33
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.CreateAssistant.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistant</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new assistant.</p>
|
|
34
34
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/assistants.CreateAssistant.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistant</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
35
35
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws">Throws<a href="#throws" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateAssistantHttpError</p>
|
|
36
36
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body">Param: body<a href="#param-body" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
37
37
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-1">Throws<a href="#throws-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateAssistantHttpError</p>
|
|
38
38
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createassistantstarter"><span>create<wbr/>Assistant<wbr/>Starter</span><a href="#createassistantstarter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">createAssistantStarter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.CreateStarter.html" class="tsd-signature-type tsd-kind-type-alias">CreateStarter</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantStarterHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantStarterHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates a new starter for the assistant.</p>
|
|
39
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
39
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.CreateStarter.html" class="tsd-signature-type tsd-kind-type-alias">CreateStarter</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantStarterHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantStarterHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new starter for the assistant.</p>
|
|
40
40
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant in which to create the starter.</p>
|
|
41
41
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/assistants.CreateStarter.html" class="tsd-signature-type tsd-kind-type-alias">CreateStarter</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
42
42
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantStarterHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantStarterHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-2">Throws<a href="#throws-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateAssistantStarterHttpError</p>
|
|
@@ -44,7 +44,7 @@
|
|
|
44
44
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-1">Param: body<a href="#param-body-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
45
45
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-3">Throws<a href="#throws-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateAssistantStarterHttpError</p>
|
|
46
46
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createassistantthread"><span>create<wbr/>Assistant<wbr/>Thread</span><a href="#createassistantthread" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">createAssistantThread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.CreateThread.html" class="tsd-signature-type tsd-kind-type-alias">CreateThread</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates a new thread for the assistant.</p>
|
|
47
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
47
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.CreateThread.html" class="tsd-signature-type tsd-kind-type-alias">CreateThread</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new thread for the assistant.</p>
|
|
48
48
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant in which to create the thread.</p>
|
|
49
49
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/assistants.CreateThread.html" class="tsd-signature-type tsd-kind-type-alias">CreateThread</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
50
50
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-4">Throws<a href="#throws-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateAssistantThreadHttpError</p>
|
|
@@ -52,7 +52,7 @@
|
|
|
52
52
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-2">Param: body<a href="#param-body-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
53
53
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-5">Throws<a href="#throws-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateAssistantThreadHttpError</p>
|
|
54
54
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createassistantthreadinteraction"><span>create<wbr/>Assistant<wbr/>Thread<wbr/>Interaction</span><a href="#createassistantthreadinteraction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">createAssistantThreadInteraction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.CreateInteraction.html" class="tsd-signature-type tsd-kind-type-alias">CreateInteraction</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantThreadInteractionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantThreadInteractionHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates a new interaction for the thread.</p>
|
|
55
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
55
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.CreateInteraction.html" class="tsd-signature-type tsd-kind-type-alias">CreateInteraction</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantThreadInteractionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantThreadInteractionHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates a new interaction for the thread.</p>
|
|
56
56
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant in which to create the interaction.</p>
|
|
57
57
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">threadId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the thread in which to create the interaction.</p>
|
|
58
58
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/assistants.CreateInteraction.html" class="tsd-signature-type tsd-kind-type-alias">CreateInteraction</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
@@ -62,7 +62,7 @@
|
|
|
62
62
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-3">Param: body<a href="#param-body-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
63
63
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-7">Throws<a href="#throws-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateAssistantThreadInteractionHttpError</p>
|
|
64
64
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createassistantthreadinteractionfeedback"><span>create<wbr/>Assistant<wbr/>Thread<wbr/>Interaction<wbr/>Feedback</span><a href="#createassistantthreadinteractionfeedback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">createAssistantThreadInteractionFeedback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">interactionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.CreateFeedback.html" class="tsd-signature-type tsd-kind-type-alias">CreateFeedback</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantThreadInteractionFeedbackHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantThreadInteractionFeedbackHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates feedback for the thread.</p>
|
|
65
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
65
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">interactionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.CreateFeedback.html" class="tsd-signature-type tsd-kind-type-alias">CreateFeedback</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantThreadInteractionFeedbackHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantThreadInteractionFeedbackHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates feedback for the thread.</p>
|
|
66
66
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant in which to create the feedback.</p>
|
|
67
67
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">threadId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the thread in which to create the feedback.</p>
|
|
68
68
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">interactionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the interaction in which to create the feedback.</p>
|
|
@@ -74,7 +74,7 @@
|
|
|
74
74
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-4">Param: body<a href="#param-body-4" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
75
75
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-9">Throws<a href="#throws-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateAssistantThreadInteractionFeedbackHttpError</p>
|
|
76
76
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="createassistantthreadinteractionreview"><span>create<wbr/>Assistant<wbr/>Thread<wbr/>Interaction<wbr/>Review</span><a href="#createassistantthreadinteractionreview" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">createAssistantThreadInteractionReview</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">interactionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.CreateReview.html" class="tsd-signature-type tsd-kind-type-alias">CreateReview</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantThreadInteractionReviewHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantThreadInteractionReviewHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Creates feedback review for the thread.</p>
|
|
77
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
77
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">interactionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.CreateReview.html" class="tsd-signature-type tsd-kind-type-alias">CreateReview</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.CreateAssistantThreadInteractionReviewHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">CreateAssistantThreadInteractionReviewHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Creates feedback review for the thread.</p>
|
|
78
78
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant in which to create the feedback review.</p>
|
|
79
79
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">threadId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the thread in which to create the feedback review.</p>
|
|
80
80
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">interactionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the interaction in which to create the feedback review.</p>
|
|
@@ -86,13 +86,13 @@
|
|
|
86
86
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-5">Param: body<a href="#param-body-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
87
87
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-11">Throws<a href="#throws-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>CreateAssistantThreadInteractionReviewHttpError</p>
|
|
88
88
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteassistant"><span>delete<wbr/>Assistant</span><a href="#deleteassistant" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteAssistant</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.DeleteAssistantHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAssistantHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes the assistant and all of its resources.</p>
|
|
89
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
89
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.DeleteAssistantHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAssistantHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes the assistant and all of its resources.</p>
|
|
90
90
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant to delete.</p>
|
|
91
91
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.DeleteAssistantHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAssistantHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-12">Throws<a href="#throws-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteAssistantHttpError</p>
|
|
92
92
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id">Param: id<a href="#param-id" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the assistant to delete.</p>
|
|
93
93
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-13">Throws<a href="#throws-13" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteAssistantHttpError</p>
|
|
94
94
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteassistantstarter"><span>delete<wbr/>Assistant<wbr/>Starter</span><a href="#deleteassistantstarter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteAssistantStarter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">starterId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.DeleteAssistantStarterHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAssistantStarterHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes the starter and all of its resources.</p>
|
|
95
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
95
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">starterId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.DeleteAssistantStarterHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAssistantStarterHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes the starter and all of its resources.</p>
|
|
96
96
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant containing the requested starter.</p>
|
|
97
97
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">starterId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the starter to delete.</p>
|
|
98
98
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.DeleteAssistantStarterHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAssistantStarterHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-14">Throws<a href="#throws-14" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteAssistantStarterHttpError</p>
|
|
@@ -100,7 +100,7 @@
|
|
|
100
100
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-starterid">Param: starterId<a href="#param-starterid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the starter to delete.</p>
|
|
101
101
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-15">Throws<a href="#throws-15" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteAssistantStarterHttpError</p>
|
|
102
102
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteassistantstarterfollowup"><span>delete<wbr/>Assistant<wbr/>Starter<wbr/>Followup</span><a href="#deleteassistantstarterfollowup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteAssistantStarterFollowup</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">starterId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">followupId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.DeleteAssistantStarterFollowupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAssistantStarterFollowupHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes the specified Followup.</p>
|
|
103
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
103
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">starterId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">followupId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.DeleteAssistantStarterFollowupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAssistantStarterFollowupHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes the specified Followup.</p>
|
|
104
104
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant containing the requested Followup.</p>
|
|
105
105
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">starterId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the starter containing the requested Followup.</p>
|
|
106
106
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">followupId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the Followup to delete.</p>
|
|
@@ -110,7 +110,7 @@
|
|
|
110
110
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-followupid">Param: followupId<a href="#param-followupid" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the Followup to delete.</p>
|
|
111
111
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-17">Throws<a href="#throws-17" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteAssistantStarterFollowupHttpError</p>
|
|
112
112
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteassistantthread"><span>delete<wbr/>Assistant<wbr/>Thread</span><a href="#deleteassistantthread" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteAssistantThread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.DeleteAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes the specified thread and all of its resources.</p>
|
|
113
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
113
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.DeleteAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes the specified thread and all of its resources.</p>
|
|
114
114
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant containing the requested thread.</p>
|
|
115
115
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">threadid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the thread to retrieve.</p>
|
|
116
116
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.DeleteAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-18">Throws<a href="#throws-18" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteAssistantThreadHttpError</p>
|
|
@@ -118,7 +118,7 @@
|
|
|
118
118
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-threadid-3">Param: threadid<a href="#param-threadid-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the thread to retrieve.</p>
|
|
119
119
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-19">Throws<a href="#throws-19" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteAssistantThreadHttpError</p>
|
|
120
120
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="deleteassistantthreadinteraction"><span>delete<wbr/>Assistant<wbr/>Thread<wbr/>Interaction</span><a href="#deleteassistantthreadinteraction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">deleteAssistantThreadInteraction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">interactionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.DeleteAssistantThreadInteractionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAssistantThreadInteractionHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Deletes the specified interaction and all of its resources.</p>
|
|
121
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
121
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">interactionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.DeleteAssistantThreadInteractionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">DeleteAssistantThreadInteractionHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Deletes the specified interaction and all of its resources.</p>
|
|
122
122
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant in which to delete the interaction.</p>
|
|
123
123
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">threadId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the thread in which to delete the interaction.</p>
|
|
124
124
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">interactionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the interaction to delete.</p>
|
|
@@ -128,19 +128,19 @@
|
|
|
128
128
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-interactionid-2">Param: interactionId<a href="#param-interactionid-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the interaction to delete.</p>
|
|
129
129
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-21">Throws<a href="#throws-21" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>DeleteAssistantThreadInteractionHttpError</p>
|
|
130
130
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassistant"><span>get<wbr/>Assistant</span><a href="#getassistant" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getAssistant</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves the specified assistant.</p>
|
|
131
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
131
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the specified assistant.</p>
|
|
132
132
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant to retrieve.</p>
|
|
133
133
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-22">Throws<a href="#throws-22" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantHttpError</p>
|
|
134
134
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-id-1">Param: id<a href="#param-id-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the assistant to retrieve.</p>
|
|
135
135
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-23">Throws<a href="#throws-23" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantHttpError</p>
|
|
136
136
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassistantfeedback"><span>get<wbr/>Assistant<wbr/>Feedback</span><a href="#getassistantfeedback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getAssistantFeedback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantFeedbackHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantFeedbackHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves feedback summary for the assistant.</p>
|
|
137
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
137
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantFeedbackHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantFeedbackHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves feedback summary for the assistant.</p>
|
|
138
138
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant from which to retrieve feedback summary.</p>
|
|
139
139
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantFeedbackHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantFeedbackHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-24">Throws<a href="#throws-24" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantFeedbackHttpError</p>
|
|
140
140
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-assistantid-9">Param: assistantId<a href="#param-assistantid-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the assistant from which to retrieve feedback summary.</p>
|
|
141
141
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-25">Throws<a href="#throws-25" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantFeedbackHttpError</p>
|
|
142
142
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassistants"><span>get<wbr/>Assistants</span><a href="#getassistants" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getAssistants</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">countTotal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves the list of assistants. The result can be filtered, sorted, and paginated.</p>
|
|
143
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
143
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">countTotal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the list of assistants. The result can be filtered, sorted, and paginated.</p>
|
|
144
144
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">countTotal</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-NAME"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-DESCRIPTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
145
145
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">countTotal</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">boolean</span></h5><div class="tsd-comment tsd-typography"><div class="tsd-tag-deprecated"><h4 class="tsd-anchor-link" id="deprecated">Deprecated<a href="#deprecated" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>Optional parameter to request total count for query.</p>
|
|
146
146
|
</div></div></li><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The number of assistants to get.</p>
|
|
@@ -151,7 +151,7 @@
|
|
|
151
151
|
</div></div></li></ul></li></ul></div><div class="tsd-comment tsd-typography"><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query">Param: query<a href="#param-query" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
|
|
152
152
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-27">Throws<a href="#throws-27" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantsHttpError</p>
|
|
153
153
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassistantsources"><span>get<wbr/>Assistant<wbr/>Sources</span><a href="#getassistantsources" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getAssistantSources</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.ChunksRefs.html" class="tsd-signature-type tsd-kind-type-alias">ChunksRefs</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantSourcesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantSourcesHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Perform a bulk search for the plaintext of source chunks for the assistant.</p>
|
|
154
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
154
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.ChunksRefs.html" class="tsd-signature-type tsd-kind-type-alias">ChunksRefs</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantSourcesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantSourcesHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Perform a bulk search for the plaintext of source chunks for the assistant.</p>
|
|
155
155
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant in which to search for source chunks.</p>
|
|
156
156
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/assistants.ChunksRefs.html" class="tsd-signature-type tsd-kind-type-alias">ChunksRefs</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
157
157
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantSourcesHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantSourcesHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-28">Throws<a href="#throws-28" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantSourcesHttpError</p>
|
|
@@ -159,7 +159,7 @@
|
|
|
159
159
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-6">Param: body<a href="#param-body-6" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
160
160
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-29">Throws<a href="#throws-29" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantSourcesHttpError</p>
|
|
161
161
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassistantstarter"><span>get<wbr/>Assistant<wbr/>Starter</span><a href="#getassistantstarter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getAssistantStarter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">starterId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantStarterHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantStarterHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves the specified starter.</p>
|
|
162
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
162
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">starterId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantStarterHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantStarterHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the specified starter.</p>
|
|
163
163
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant containing the requested starter.</p>
|
|
164
164
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">starterId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the starter to retrieve.</p>
|
|
165
165
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantStarterHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantStarterHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-30">Throws<a href="#throws-30" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantStarterHttpError</p>
|
|
@@ -167,7 +167,7 @@
|
|
|
167
167
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-starterid-2">Param: starterId<a href="#param-starterid-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the starter to retrieve.</p>
|
|
168
168
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-31">Throws<a href="#throws-31" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantStarterHttpError</p>
|
|
169
169
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassistantstarters"><span>get<wbr/>Assistant<wbr/>Starters</span><a href="#getassistantstarters" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getAssistantStarters</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"QUESTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-QUESTION"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantStartersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantStartersHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves the list of starters for the assistant.</p>
|
|
170
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
170
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"QUESTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-QUESTION"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantStartersHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantStartersHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the list of starters for the assistant.</p>
|
|
171
171
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant from which to retrieve starters.</p>
|
|
172
172
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"QUESTION"</span><br/> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-QUESTION"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
173
173
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">number</span></h5><div class="tsd-comment tsd-typography"><p>The number of starters to get.</p>
|
|
@@ -179,7 +179,7 @@
|
|
|
179
179
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-1">Param: query<a href="#param-query-1" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
|
|
180
180
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-33">Throws<a href="#throws-33" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantStartersHttpError</p>
|
|
181
181
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassistantthread"><span>get<wbr/>Assistant<wbr/>Thread</span><a href="#getassistantthread" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getAssistantThread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves a thread for the assistant.</p>
|
|
182
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
182
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves a thread for the assistant.</p>
|
|
183
183
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant containing the requested thread.</p>
|
|
184
184
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">threadid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the thread to retrieve.</p>
|
|
185
185
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-34">Throws<a href="#throws-34" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantThreadHttpError</p>
|
|
@@ -187,7 +187,7 @@
|
|
|
187
187
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-threadid-5">Param: threadid<a href="#param-threadid-5" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the thread to retrieve.</p>
|
|
188
188
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-35">Throws<a href="#throws-35" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantThreadHttpError</p>
|
|
189
189
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassistantthreadinteraction"><span>get<wbr/>Assistant<wbr/>Thread<wbr/>Interaction</span><a href="#getassistantthreadinteraction" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getAssistantThreadInteraction</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">interactionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantThreadInteractionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantThreadInteractionHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves an interaction for the thread.</p>
|
|
190
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
190
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">interactionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantThreadInteractionHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantThreadInteractionHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves an interaction for the thread.</p>
|
|
191
191
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant in which to retrieve the interaction.</p>
|
|
192
192
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">threadId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the thread in which to retrieve the interaction.</p>
|
|
193
193
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">interactionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the interaction to retrieve.</p>
|
|
@@ -197,7 +197,7 @@
|
|
|
197
197
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-interactionid-3">Param: interactionId<a href="#param-interactionid-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>The ID of the interaction to retrieve.</p>
|
|
198
198
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-37">Throws<a href="#throws-37" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantThreadInteractionHttpError</p>
|
|
199
199
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassistantthreadinteractions"><span>get<wbr/>Assistant<wbr/>Thread<wbr/>Interactions</span><a href="#getassistantthreadinteractions" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getAssistantThreadInteractions</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"CREATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantThreadInteractionsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantThreadInteractionsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves the list of interactions for the thread.</p>
|
|
200
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
200
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"CREATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantThreadInteractionsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantThreadInteractionsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the list of interactions for the thread.</p>
|
|
201
201
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant from which to retrieve the interactions.</p>
|
|
202
202
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">threadId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the thread from which to retrieve the interactions.</p>
|
|
203
203
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"CREATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
@@ -211,7 +211,7 @@
|
|
|
211
211
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-2">Param: query<a href="#param-query-2" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
|
|
212
212
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-39">Throws<a href="#throws-39" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantThreadInteractionsHttpError</p>
|
|
213
213
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="getassistantthreads"><span>get<wbr/>Assistant<wbr/>Threads</span><a href="#getassistantthreads" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">getAssistantThreads</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"NAME"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-NAME"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CREATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantThreadsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantThreadsHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Retrieves the list of threads for the assistant.</p>
|
|
214
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
214
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">query</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"NAME"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-NAME"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CREATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-signature-symbol">}</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.GetAssistantThreadsHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">GetAssistantThreadsHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Retrieves the list of threads for the assistant.</p>
|
|
215
215
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant from which to retrieve threads.</p>
|
|
216
216
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">query</span>: <span class="tsd-signature-symbol">{</span><br/> <span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">limit</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">next</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">prev</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">;</span><br/> <span class="tsd-kind-property">sort</span><span class="tsd-signature-symbol">?:</span> <span class="tsd-signature-type">"NAME"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-NAME"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"CREATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-CREATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"UPDATED"</span> <span class="tsd-signature-symbol">|</span> <span class="tsd-signature-type">"-UPDATED"</span><span class="tsd-signature-symbol">;</span><br/><span class="tsd-signature-symbol">}</span></span><div class="tsd-comment tsd-typography"><p>an object with query parameters</p>
|
|
217
217
|
</div><div class="tsd-comment tsd-typography"></div><ul class="tsd-parameters"><li class="tsd-parameter"><h5><code class="tsd-tag">Optional</code><span class="tsd-kind-property">filter</span><span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">string</span></h5><div class="tsd-comment tsd-typography"><p>Optional parameter to filter threads.</p>
|
|
@@ -224,7 +224,7 @@
|
|
|
224
224
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-query-3">Param: query<a href="#param-query-3" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with query parameters</p>
|
|
225
225
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-41">Throws<a href="#throws-41" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>GetAssistantThreadsHttpError</p>
|
|
226
226
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="invokeassistantthread"><span>invoke<wbr/>Assistant<wbr/>Thread</span><a href="#invokeassistantthread" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">invokeAssistantThread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.PromptInput.html" class="tsd-signature-type tsd-kind-type-alias">PromptInput</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.InvokeAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">InvokeAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Execute prompt in synchronous non-streaming mode.</p>
|
|
227
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
227
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.PromptInput.html" class="tsd-signature-type tsd-kind-type-alias">PromptInput</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.InvokeAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">InvokeAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Execute prompt in synchronous non-streaming mode.</p>
|
|
228
228
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the Assistant containing requested Thread</p>
|
|
229
229
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">threadId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the Thread to retrieve</p>
|
|
230
230
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/assistants.PromptInput.html" class="tsd-signature-type tsd-kind-type-alias">PromptInput</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
@@ -234,7 +234,7 @@
|
|
|
234
234
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-7">Param: body<a href="#param-body-7" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
235
235
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-43">Throws<a href="#throws-43" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>InvokeAssistantThreadHttpError</p>
|
|
236
236
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchassistant"><span>patch<wbr/>Assistant</span><a href="#patchassistant" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">patchAssistant</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.JSONPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">JSONPatchArray</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.PatchAssistantHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchAssistantHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates the properties of an existing assistant with JSON Patch-formatted data.</p>
|
|
237
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
237
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">id</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.JSONPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">JSONPatchArray</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.PatchAssistantHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchAssistantHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the properties of an existing assistant with JSON Patch-formatted data.</p>
|
|
238
238
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">id</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The assistant ID.</p>
|
|
239
239
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/assistants.JSONPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">JSONPatchArray</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
240
240
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><code class="tsd-tag">Optional</code><span class="tsd-kind-parameter">options</span>: <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a></span></li></ul></div><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.PatchAssistantHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchAssistantHttpResponse</a><span class="tsd-signature-symbol">></span></h4><div class="tsd-comment tsd-typography"><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-44">Throws<a href="#throws-44" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>PatchAssistantHttpError</p>
|
|
@@ -242,7 +242,7 @@
|
|
|
242
242
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-8">Param: body<a href="#param-body-8" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
243
243
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-45">Throws<a href="#throws-45" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>PatchAssistantHttpError</p>
|
|
244
244
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchassistantthread"><span>patch<wbr/>Assistant<wbr/>Thread</span><a href="#patchassistantthread" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">patchAssistantThread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.ThreadPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">ThreadPatchArray</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.PatchAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates the properties of an existing thread with JSON Patch-formatted data.</p>
|
|
245
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
245
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadid</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.ThreadPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">ThreadPatchArray</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.PatchAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the properties of an existing thread with JSON Patch-formatted data.</p>
|
|
246
246
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant containing the requested thread.</p>
|
|
247
247
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">threadid</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the thread to retrieve.</p>
|
|
248
248
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/assistants.ThreadPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">ThreadPatchArray</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
@@ -252,7 +252,7 @@
|
|
|
252
252
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-9">Param: body<a href="#param-body-9" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
253
253
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-47">Throws<a href="#throws-47" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>PatchAssistantThreadHttpError</p>
|
|
254
254
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="patchassistantthreadinteractionfeedback"><span>patch<wbr/>Assistant<wbr/>Thread<wbr/>Interaction<wbr/>Feedback</span><a href="#patchassistantthreadinteractionfeedback" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">patchAssistantThreadInteractionFeedback</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">interactionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">feedbackId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.FeedbackPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">FeedbackPatchArray</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.PatchAssistantThreadInteractionFeedbackHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchAssistantThreadInteractionFeedbackHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates feedback for the thread.</p>
|
|
255
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
255
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">interactionId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">feedbackId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.FeedbackPatchArray.html" class="tsd-signature-type tsd-kind-type-alias">FeedbackPatchArray</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.PatchAssistantThreadInteractionFeedbackHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">PatchAssistantThreadInteractionFeedbackHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates feedback for the thread.</p>
|
|
256
256
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant containing the requested feedback.</p>
|
|
257
257
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">threadId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the thread containing the requested feedback.</p>
|
|
258
258
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">interactionId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the interaction containing the requested Feedback.</p>
|
|
@@ -266,7 +266,7 @@
|
|
|
266
266
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-10">Param: body<a href="#param-body-10" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
267
267
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-49">Throws<a href="#throws-49" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>PatchAssistantThreadInteractionFeedbackHttpError</p>
|
|
268
268
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="streamassistantthread"><span>stream<wbr/>Assistant<wbr/>Thread</span><a href="#streamassistantthread" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">streamAssistantThread</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.PromptInput.html" class="tsd-signature-type tsd-kind-type-alias">PromptInput</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.StreamAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">StreamAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Execute prompt in asynchronous streaming mode.</p>
|
|
269
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
269
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">threadId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.PromptInput.html" class="tsd-signature-type tsd-kind-type-alias">PromptInput</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.StreamAssistantThreadHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">StreamAssistantThreadHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Execute prompt in asynchronous streaming mode.</p>
|
|
270
270
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the Assistant containing requested Thread</p>
|
|
271
271
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">threadId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The id of the Thread to retrieve</p>
|
|
272
272
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/assistants.PromptInput.html" class="tsd-signature-type tsd-kind-type-alias">PromptInput</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
@@ -276,7 +276,7 @@
|
|
|
276
276
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-11">Param: body<a href="#param-body-11" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
277
277
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-51">Throws<a href="#throws-51" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>StreamAssistantThreadHttpError</p>
|
|
278
278
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updateassistantstarter"><span>update<wbr/>Assistant<wbr/>Starter</span><a href="#updateassistantstarter" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">updateAssistantStarter</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">starterId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.Starter.html" class="tsd-signature-type tsd-kind-type-alias">Starter</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.UpdateAssistantStarterHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateAssistantStarterHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates the specified starter.</p>
|
|
279
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
279
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">starterId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.Starter.html" class="tsd-signature-type tsd-kind-type-alias">Starter</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.UpdateAssistantStarterHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateAssistantStarterHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the specified starter.</p>
|
|
280
280
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant containing the requested starter.</p>
|
|
281
281
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">starterId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the starter to retrieve.</p>
|
|
282
282
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">body</span>: <a href="../types/assistants.Starter.html" class="tsd-signature-type tsd-kind-type-alias">Starter</a></span><div class="tsd-comment tsd-typography"><p>an object with the body content</p>
|
|
@@ -286,7 +286,7 @@
|
|
|
286
286
|
</div><div class="tsd-tag-param"><h4 class="tsd-anchor-link" id="param-body-12">Param: body<a href="#param-body-12" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>an object with the body content</p>
|
|
287
287
|
</div><div class="tsd-tag-throws"><h4 class="tsd-anchor-link" id="throws-53">Throws<a href="#throws-53" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h4><p>UpdateAssistantStarterHttpError</p>
|
|
288
288
|
</div></div></section><section class="tsd-panel tsd-member"><h3 class="tsd-anchor-link" id="updateassistantstarterfollowup"><span>update<wbr/>Assistant<wbr/>Starter<wbr/>Followup</span><a href="#updateassistantstarterfollowup" aria-label="Permalink" class="tsd-anchor-icon"><svg viewBox="0 0 24 24" aria-hidden="true"><use href="../assets/icons.svg#icon-anchor"></use></svg></a></h3><div class="tsd-signature"><span class="tsd-kind-property">updateAssistantStarterFollowup</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">starterId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">followupId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.Followup.html" class="tsd-signature-type tsd-kind-type-alias">Followup</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span> <span class="tsd-signature-symbol">=></span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.UpdateAssistantStarterFollowupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateAssistantStarterFollowupHttpResponse</a><span class="tsd-signature-symbol">></span></div><div class="tsd-comment tsd-typography"><p>Updates the specified Followup.</p>
|
|
289
|
-
</div><div class="tsd-type-declaration"><h4>Type
|
|
289
|
+
</div><div class="tsd-type-declaration"><h4>Type Declaration</h4><ul class="tsd-parameters"><li class="tsd-parameter-signature"><ul class="tsd-signatures"><li class="tsd-signature"><span class="tsd-signature-symbol">(</span><br/> <span class="tsd-kind-parameter">assistantId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">starterId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">followupId</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">body</span><span class="tsd-signature-symbol">:</span> <a href="../types/assistants.Followup.html" class="tsd-signature-type tsd-kind-type-alias">Followup</a><span class="tsd-signature-symbol">,</span><br/> <span class="tsd-kind-parameter">options</span><span class="tsd-signature-symbol">?:</span> <a href="../types/invoke-fetch-types.ApiCallOptions.html" class="tsd-signature-type tsd-kind-type-alias">ApiCallOptions</a><span class="tsd-signature-symbol">,</span><br/><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../types/assistants.UpdateAssistantStarterFollowupHttpResponse.html" class="tsd-signature-type tsd-kind-type-alias">UpdateAssistantStarterFollowupHttpResponse</a><span class="tsd-signature-symbol">></span></li><li class="tsd-description"><div class="tsd-comment tsd-typography"><p>Updates the specified Followup.</p>
|
|
290
290
|
</div><div class="tsd-parameters"><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameter-list"><li><span><span class="tsd-kind-parameter">assistantId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the assistant containing the requested Followup.</p>
|
|
291
291
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">starterId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the starter containing the requested Followup.</p>
|
|
292
292
|
</div><div class="tsd-comment tsd-typography"></div></li><li><span><span class="tsd-kind-parameter">followupId</span>: <span class="tsd-signature-type">string</span></span><div class="tsd-comment tsd-typography"><p>The ID of the Followup to update.</p>
|