neuland-hub-sdk 1.0.3
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/.openapi-generator/FILES +314 -0
- package/.openapi-generator/VERSION +1 -0
- package/.openapi-generator-ignore +27 -0
- package/LICENSE +10 -0
- package/README.md +619 -0
- package/api.ts +32704 -0
- package/base.ts +62 -0
- package/common.ts +127 -0
- package/configuration.ts +121 -0
- package/dist/api.d.ts +17739 -0
- package/dist/api.js +35085 -0
- package/dist/base.d.ts +42 -0
- package/dist/base.js +67 -0
- package/dist/common.d.ts +34 -0
- package/dist/common.js +231 -0
- package/dist/configuration.d.ts +98 -0
- package/dist/configuration.js +57 -0
- package/dist/index.d.ts +13 -0
- package/dist/index.js +31 -0
- package/docs/AccessItemOut.md +31 -0
- package/docs/AccessKind.md +13 -0
- package/docs/Alert.md +416 -0
- package/docs/ApiKey.md +123 -0
- package/docs/ApiKeyCreateRequest.md +23 -0
- package/docs/ApiKeyCreateResponse.md +27 -0
- package/docs/ApiKeyInventoryRequest.md +21 -0
- package/docs/ApiKeyInventoryResponse.md +22 -0
- package/docs/ApiKeyInventoryRow.md +36 -0
- package/docs/Application.md +308 -0
- package/docs/ApplicationAccessIn.md +23 -0
- package/docs/ApplicationCatalog.md +43 -0
- package/docs/ApplicationCatalogIn.md +29 -0
- package/docs/ApplicationCatalogUpdate.md +29 -0
- package/docs/ApplicationGroupOut.md +31 -0
- package/docs/ApplicationIn.md +37 -0
- package/docs/ApplicationMarketplace.md +490 -0
- package/docs/ApplicationMemberOut.md +31 -0
- package/docs/Assistant.md +1269 -0
- package/docs/AssistantCatalog.md +53 -0
- package/docs/AssistantCatalogIn.md +38 -0
- package/docs/AssistantCatalogToolOut.md +27 -0
- package/docs/AssistantCatalogUpdate.md +38 -0
- package/docs/AssistantGroupOut.md +31 -0
- package/docs/AssistantGroupsIn.md +20 -0
- package/docs/AssistantIn.md +42 -0
- package/docs/AssistantInputTypeEnum.md +10 -0
- package/docs/AssistantLibrary.md +30 -0
- package/docs/AssistantMarketplace.md +644 -0
- package/docs/AssistantMemberGrantedViaEnum.md +10 -0
- package/docs/AssistantMemberOut.md +29 -0
- package/docs/AssistantMembersIn.md +20 -0
- package/docs/AssistantTool.md +26 -0
- package/docs/AssistantVisibilityEnum.md +10 -0
- package/docs/AssistantVisibilityUpdate.md +21 -0
- package/docs/Atlassian.md +69 -0
- package/docs/Auth.md +816 -0
- package/docs/AuthConnector.md +622 -0
- package/docs/Bcc.md +19 -0
- package/docs/BudgetAlert.md +41 -0
- package/docs/BudgetAlertRequest.md +23 -0
- package/docs/BudgetAlertUpdate.md +25 -0
- package/docs/BudgetForecast.md +35 -0
- package/docs/BudgetSummary.md +43 -0
- package/docs/BudgetTopUpOut.md +29 -0
- package/docs/BudgetTopUpRequest.md +21 -0
- package/docs/BulkResult.md +22 -0
- package/docs/CatalogIn.md +46 -0
- package/docs/CatalogUpdate.md +46 -0
- package/docs/Category.md +61 -0
- package/docs/CategoryOut.md +33 -0
- package/docs/Cc.md +19 -0
- package/docs/Chat.md +555 -0
- package/docs/ChatIn.md +34 -0
- package/docs/ChatInactiveDocumentOut.md +27 -0
- package/docs/ChatLibrary.md +30 -0
- package/docs/ClarificationAnswer.md +25 -0
- package/docs/ConnectSharedMailboxIn.md +22 -0
- package/docs/Connector.md +44 -0
- package/docs/ConnectorAuthType.md +13 -0
- package/docs/ConnectorConsentOut.md +22 -0
- package/docs/ConnectorOut.md +30 -0
- package/docs/ConnectorStatusOut.md +38 -0
- package/docs/ConnectorUpdate.md +20 -0
- package/docs/CostAudioPerMinute.md +19 -0
- package/docs/CostByModel.md +32 -0
- package/docs/CostBySource.md +30 -0
- package/docs/CostCacheCreationTokens.md +19 -0
- package/docs/CostCacheCreationTokensAboveTier.md +19 -0
- package/docs/CostCachedTokens.md +19 -0
- package/docs/CostCachedTokensAboveTier.md +19 -0
- package/docs/CostCompletionTokens.md +19 -0
- package/docs/CostCompletionTokens1.md +19 -0
- package/docs/CostCompletionTokensAboveTier.md +19 -0
- package/docs/CostPromptTokens.md +19 -0
- package/docs/CostPromptTokens1.md +19 -0
- package/docs/CostPromptTokensAboveTier.md +19 -0
- package/docs/CostTimeseriesPoint.md +26 -0
- package/docs/CreateOutlookDraftRequest.md +35 -0
- package/docs/CreateOutlookDraftResponse.md +31 -0
- package/docs/CredentialIn.md +20 -0
- package/docs/CredentialPartOut.md +26 -0
- package/docs/CredentialTemplateOut.md +30 -0
- package/docs/CustomConnector.md +231 -0
- package/docs/CustomConnectorCreate.md +27 -0
- package/docs/CustomConnectorOut.md +30 -0
- package/docs/CustomConnectorUpdate.md +22 -0
- package/docs/DataSourceCapabilities.md +25 -0
- package/docs/DataSourceDriveModel.md +31 -0
- package/docs/DataSourceFolderModel.md +21 -0
- package/docs/DataSourceItemModel.md +47 -0
- package/docs/DataSourceSiteModel.md +31 -0
- package/docs/DataSourceUserModel.md +29 -0
- package/docs/DateWindowRequest.md +23 -0
- package/docs/Default.md +240 -0
- package/docs/DirectFileUrl.md +22 -0
- package/docs/Document.md +533 -0
- package/docs/DocumentMetrics.md +26 -0
- package/docs/DocumentTextOut.md +21 -0
- package/docs/DocumentUsageRequest.md +31 -0
- package/docs/DocumentUsageResponse.md +32 -0
- package/docs/DocumentUsageRow.md +30 -0
- package/docs/Dropbox.md +458 -0
- package/docs/EmailCatalogOut.md +25 -0
- package/docs/EmailSpec.md +27 -0
- package/docs/EmailTemplateKey.md +35 -0
- package/docs/Example.md +19 -0
- package/docs/FeatureFlag.md +194 -0
- package/docs/FeatureFlagOut.md +28 -0
- package/docs/FeatureFlagSetIn.md +20 -0
- package/docs/File.md +125 -0
- package/docs/FormField.md +33 -0
- package/docs/FormFieldTypeEnum.md +20 -0
- package/docs/GoogleDrive.md +458 -0
- package/docs/GroupAppAccessIn.md +23 -0
- package/docs/GroupIn.md +27 -0
- package/docs/GroupSyncOut.md +25 -0
- package/docs/HTTPValidationError.md +20 -0
- package/docs/IdleAssistant.md +24 -0
- package/docs/Invitation.md +293 -0
- package/docs/InvitationIn.md +28 -0
- package/docs/InvitationOut.md +44 -0
- package/docs/LLMConnectionTestIn.md +43 -0
- package/docs/LLMConnectionTestOut.md +25 -0
- package/docs/LLMSettingsIn.md +68 -0
- package/docs/LLMSettingsUpdate.md +68 -0
- package/docs/Library.md +437 -0
- package/docs/LibraryIn.md +22 -0
- package/docs/LibraryMemberBulkDelete.md +20 -0
- package/docs/LibraryMemberBulkIn.md +20 -0
- package/docs/LibraryMemberIn.md +22 -0
- package/docs/LibraryMemberOut.md +29 -0
- package/docs/LibraryUpdateIn.md +22 -0
- package/docs/LicenseUtilization.md +26 -0
- package/docs/Llm.md +540 -0
- package/docs/LlmCatalog.md +188 -0
- package/docs/LlmSetting.md +331 -0
- package/docs/LocationInner.md +18 -0
- package/docs/MarketplaceCatalogStateEnum.md +11 -0
- package/docs/MarketplaceCatalogStateUpdate.md +21 -0
- package/docs/Message.md +602 -0
- package/docs/MessageDetailOut.md +57 -0
- package/docs/MessageFileOut.md +26 -0
- package/docs/MessageIn.md +50 -0
- package/docs/MessageSubmitOut.md +65 -0
- package/docs/MessageTokensResponse.md +32 -0
- package/docs/MessageTurnOut.md +22 -0
- package/docs/ModelDelta.md +26 -0
- package/docs/ModelTierEnum.md +13 -0
- package/docs/MoversResponse.md +34 -0
- package/docs/NeulandAssistantsTaggingOut.md +29 -0
- package/docs/NeulandMarketplaceAssistantSchemasTaggingOut.md +29 -0
- package/docs/Nextcloud.md +458 -0
- package/docs/OAuth2ProviderEnum.md +35 -0
- package/docs/OAuthClient.md +40 -0
- package/docs/OAuthClientUpdate.md +26 -0
- package/docs/OneDrive.md +458 -0
- package/docs/OutputFormat.md +20 -0
- package/docs/PasswordResetIn.md +22 -0
- package/docs/PasswordResetRequestIn.md +20 -0
- package/docs/PlanStatus.md +19 -0
- package/docs/Project.md +615 -0
- package/docs/ProjectIn.md +24 -0
- package/docs/ProjectLibrary.md +30 -0
- package/docs/ProjectMember.md +28 -0
- package/docs/ProjectMemberBulkDelete.md +20 -0
- package/docs/ProjectMemberBulkIn.md +20 -0
- package/docs/ProjectMemberIn.md +22 -0
- package/docs/Prompt.md +248 -0
- package/docs/PromptIn.md +26 -0
- package/docs/PromptOptimizeIn.md +22 -0
- package/docs/PromptOptimizeOut.md +20 -0
- package/docs/Query.md +123 -0
- package/docs/RateableTypeEnum.md +13 -0
- package/docs/Rating.md +129 -0
- package/docs/RatingIn.md +27 -0
- package/docs/ReasoningEffortEnum.md +13 -0
- package/docs/RephraseStyleEnum.md +12 -0
- package/docs/ResourceAccess.md +197 -0
- package/docs/ResponseAuthGetEntraGroupsValue.md +18 -0
- package/docs/ResponseDropboxListRoots.md +18 -0
- package/docs/ResponseGoogledriveListRoots.md +18 -0
- package/docs/ResponseNextcloudListRoots.md +18 -0
- package/docs/ResponseOnedriveListRoots.md +18 -0
- package/docs/ResponseSharepointv1ListRoots.md +18 -0
- package/docs/ResumeIn.md +26 -0
- package/docs/Role.md +495 -0
- package/docs/RoleIn.md +39 -0
- package/docs/RoleUpdateIn.md +36 -0
- package/docs/RunCreateOut.md +22 -0
- package/docs/SecretUpdateIn.md +20 -0
- package/docs/SendEmailRequest.md +35 -0
- package/docs/SendEmailResponse.md +27 -0
- package/docs/SetAtlassianCloudIdRequest.md +21 -0
- package/docs/Settings.md +183 -0
- package/docs/SettingsIn.md +52 -0
- package/docs/SharedMailbox.md +29 -0
- package/docs/SharedMailboxCandidateOut.md +26 -0
- package/docs/SharedMailboxListOut.md +20 -0
- package/docs/SharedMailboxSearchOut.md +20 -0
- package/docs/Sharepoint.md +402 -0
- package/docs/SharepointDriveModel.md +31 -0
- package/docs/SharepointFolderModel.md +21 -0
- package/docs/SharepointItemModel.md +47 -0
- package/docs/SharepointSiteModel.md +31 -0
- package/docs/SharepointUserModel.md +29 -0
- package/docs/SharepointV1.md +458 -0
- package/docs/SsoExchangeIn.md +22 -0
- package/docs/SsoInitOut.md +24 -0
- package/docs/SsoResolveOut.md +22 -0
- package/docs/Storage.md +66 -0
- package/docs/StreamTokenOut.md +20 -0
- package/docs/SubtenantUsageResponse.md +26 -0
- package/docs/SubtenantUsageRow.md +34 -0
- package/docs/System.md +122 -0
- package/docs/SystemSettings.md +44 -0
- package/docs/SystemSettingsUpdate.md +41 -0
- package/docs/Tag.md +187 -0
- package/docs/TagIn.md +20 -0
- package/docs/TaggableTypeEnum.md +12 -0
- package/docs/Tagging.md +32 -0
- package/docs/Tarif.md +189 -0
- package/docs/TarifIn.md +39 -0
- package/docs/TarifStatusEnum.md +11 -0
- package/docs/Template.md +243 -0
- package/docs/TemplateIn.md +31 -0
- package/docs/TemplateOut.md +35 -0
- package/docs/TemplateUpdate.md +31 -0
- package/docs/Tenant.md +1189 -0
- package/docs/TenantIn.md +68 -0
- package/docs/TenantLLM.md +33 -0
- package/docs/TenantModelBulkIn.md +22 -0
- package/docs/TenantModelIn.md +20 -0
- package/docs/TenantOAuthClientIn.md +32 -0
- package/docs/TenantOAuthClientOut.md +36 -0
- package/docs/TenantOAuthClientUpdate.md +30 -0
- package/docs/TenantOut.md +76 -0
- package/docs/TenantThemeOut.md +46 -0
- package/docs/TenantUpdateIn.md +66 -0
- package/docs/ThemeModeEnum.md +12 -0
- package/docs/TimeseriesPoint.md +23 -0
- package/docs/TimeseriesResponse.md +23 -0
- package/docs/To.md +19 -0
- package/docs/To1.md +19 -0
- package/docs/TokenOut.md +22 -0
- package/docs/TokenTimeseriesPerModel.md +23 -0
- package/docs/TokenTimeseriesPoint.md +23 -0
- package/docs/TokensPerModel.md +31 -0
- package/docs/TokensTimeseriesResponse.md +31 -0
- package/docs/Tool.md +188 -0
- package/docs/ToolAction.md +355 -0
- package/docs/ToolCallOut.md +38 -0
- package/docs/ToolCallProgressStepOut.md +24 -0
- package/docs/ToolCreate.md +27 -0
- package/docs/ToolOut.md +35 -0
- package/docs/ToolUpdate.md +27 -0
- package/docs/Transcription.md +114 -0
- package/docs/TranscriptionOut.md +27 -0
- package/docs/TranscriptionSegment.md +27 -0
- package/docs/Translation.md +20 -0
- package/docs/UsageCostRequest.md +30 -0
- package/docs/UsageCostResponse.md +40 -0
- package/docs/UsageMetrics.md +28 -0
- package/docs/UsageQueryRequest.md +41 -0
- package/docs/UsageQueryResponse.md +32 -0
- package/docs/UsageRequest.md +25 -0
- package/docs/UsageRow.md +32 -0
- package/docs/User.md +786 -0
- package/docs/UserAccessOut.md +31 -0
- package/docs/UserGrantIn.md +21 -0
- package/docs/UserGrantOut.md +27 -0
- package/docs/UserGroup.md +39 -0
- package/docs/UserGroupMember.md +29 -0
- package/docs/UserGroupSource.md +11 -0
- package/docs/UserIn.md +34 -0
- package/docs/UserMeOut.md +51 -0
- package/docs/UserOut.md +48 -0
- package/docs/UserPreferenceOut.md +28 -0
- package/docs/UserPreferenceUpdateIn.md +24 -0
- package/docs/UserUpdateIn.md +34 -0
- package/docs/UtilizationRequest.md +24 -0
- package/docs/UtilizationResponse.md +28 -0
- package/docs/ValidationError.md +28 -0
- package/docs/VariableSpec.md +27 -0
- package/docs/Workflow.md +411 -0
- package/docs/WorkflowChatIn.md +20 -0
- package/docs/WorkflowChatOut.md +26 -0
- package/docs/WorkflowIn.md +30 -0
- package/docs/WorkflowUpdateIn.md +28 -0
- package/index.ts +18 -0
- package/package.json +31 -0
- package/tsconfig.json +21 -0
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ProjectMemberBulkDelete
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**user_ids** | **Array<string>** | Public ids of the users to remove from the project. | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ProjectMemberBulkDelete } from 'neuland-hub-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: ProjectMemberBulkDelete = {
|
|
16
|
+
user_ids,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# ProjectMemberBulkIn
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**members** | [**Array<ProjectMemberIn>**](ProjectMemberIn.md) | List of members to add to the project. | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { ProjectMemberBulkIn } from 'neuland-hub-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: ProjectMemberBulkIn = {
|
|
16
|
+
members,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# ProjectMemberIn
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**user_id** | **string** | Public id of the user to add to the project. | [default to undefined]
|
|
9
|
+
**role** | **string** | Role to assign to the member (e.g. `owner` or `member`). | [default to undefined]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { ProjectMemberIn } from 'neuland-hub-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: ProjectMemberIn = {
|
|
17
|
+
user_id,
|
|
18
|
+
role,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Prompt.md
ADDED
|
@@ -0,0 +1,248 @@
|
|
|
1
|
+
# Prompt
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**promptsCreatePrompt**](#promptscreateprompt) | **POST** /prompts/ | Create a prompt|
|
|
8
|
+
|[**promptsDeletePrompt**](#promptsdeleteprompt) | **DELETE** /prompts/{prompt_id} | Delete a prompt|
|
|
9
|
+
|[**promptsOptimizePrompt**](#promptsoptimizeprompt) | **POST** /prompts/optimize | Optimize a prompt|
|
|
10
|
+
|[**promptsUpdatePrompt**](#promptsupdateprompt) | **PATCH** /prompts/{prompt_id} | Update a prompt|
|
|
11
|
+
|
|
12
|
+
# **promptsCreatePrompt**
|
|
13
|
+
> Prompt promptsCreatePrompt(promptIn)
|
|
14
|
+
|
|
15
|
+
Create a saved prompt for the current user.
|
|
16
|
+
|
|
17
|
+
### Example
|
|
18
|
+
|
|
19
|
+
```typescript
|
|
20
|
+
import {
|
|
21
|
+
Prompt,
|
|
22
|
+
Configuration,
|
|
23
|
+
PromptIn
|
|
24
|
+
} from 'neuland-hub-sdk';
|
|
25
|
+
|
|
26
|
+
const configuration = new Configuration();
|
|
27
|
+
const apiInstance = new Prompt(configuration);
|
|
28
|
+
|
|
29
|
+
let promptIn: PromptIn; //
|
|
30
|
+
let cookieName: string; // (optional) (default to undefined)
|
|
31
|
+
|
|
32
|
+
const { status, data } = await apiInstance.promptsCreatePrompt(
|
|
33
|
+
promptIn,
|
|
34
|
+
cookieName
|
|
35
|
+
);
|
|
36
|
+
```
|
|
37
|
+
|
|
38
|
+
### Parameters
|
|
39
|
+
|
|
40
|
+
|Name | Type | Description | Notes|
|
|
41
|
+
|------------- | ------------- | ------------- | -------------|
|
|
42
|
+
| **promptIn** | **PromptIn**| | |
|
|
43
|
+
| **cookieName** | [**string**] | | (optional) defaults to undefined|
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Return type
|
|
47
|
+
|
|
48
|
+
**Prompt**
|
|
49
|
+
|
|
50
|
+
### Authorization
|
|
51
|
+
|
|
52
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
|
|
53
|
+
|
|
54
|
+
### HTTP request headers
|
|
55
|
+
|
|
56
|
+
- **Content-Type**: application/json
|
|
57
|
+
- **Accept**: application/json
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### HTTP response details
|
|
61
|
+
| Status code | Description | Response headers |
|
|
62
|
+
|-------------|-------------|------------------|
|
|
63
|
+
|**201** | Successful Response | - |
|
|
64
|
+
|**401** | Missing or invalid authentication. | - |
|
|
65
|
+
|**403** | Only admins may create public prompts. | - |
|
|
66
|
+
|**422** | Validation Error | - |
|
|
67
|
+
|
|
68
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
69
|
+
|
|
70
|
+
# **promptsDeletePrompt**
|
|
71
|
+
> promptsDeletePrompt()
|
|
72
|
+
|
|
73
|
+
Delete a prompt owned by the current user.
|
|
74
|
+
|
|
75
|
+
### Example
|
|
76
|
+
|
|
77
|
+
```typescript
|
|
78
|
+
import {
|
|
79
|
+
Prompt,
|
|
80
|
+
Configuration
|
|
81
|
+
} from 'neuland-hub-sdk';
|
|
82
|
+
|
|
83
|
+
const configuration = new Configuration();
|
|
84
|
+
const apiInstance = new Prompt(configuration);
|
|
85
|
+
|
|
86
|
+
let promptId: string; //Public id of the prompt to delete. (default to undefined)
|
|
87
|
+
let cookieName: string; // (optional) (default to undefined)
|
|
88
|
+
|
|
89
|
+
const { status, data } = await apiInstance.promptsDeletePrompt(
|
|
90
|
+
promptId,
|
|
91
|
+
cookieName
|
|
92
|
+
);
|
|
93
|
+
```
|
|
94
|
+
|
|
95
|
+
### Parameters
|
|
96
|
+
|
|
97
|
+
|Name | Type | Description | Notes|
|
|
98
|
+
|------------- | ------------- | ------------- | -------------|
|
|
99
|
+
| **promptId** | [**string**] | Public id of the prompt to delete. | defaults to undefined|
|
|
100
|
+
| **cookieName** | [**string**] | | (optional) defaults to undefined|
|
|
101
|
+
|
|
102
|
+
|
|
103
|
+
### Return type
|
|
104
|
+
|
|
105
|
+
void (empty response body)
|
|
106
|
+
|
|
107
|
+
### Authorization
|
|
108
|
+
|
|
109
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
|
|
110
|
+
|
|
111
|
+
### HTTP request headers
|
|
112
|
+
|
|
113
|
+
- **Content-Type**: Not defined
|
|
114
|
+
- **Accept**: application/json
|
|
115
|
+
|
|
116
|
+
|
|
117
|
+
### HTTP response details
|
|
118
|
+
| Status code | Description | Response headers |
|
|
119
|
+
|-------------|-------------|------------------|
|
|
120
|
+
|**204** | Successful Response | - |
|
|
121
|
+
|**401** | Missing or invalid authentication. | - |
|
|
122
|
+
|**403** | Not the creator of this prompt. | - |
|
|
123
|
+
|**404** | No prompt exists with the given id. | - |
|
|
124
|
+
|**422** | Validation Error | - |
|
|
125
|
+
|
|
126
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
127
|
+
|
|
128
|
+
# **promptsOptimizePrompt**
|
|
129
|
+
> PromptOptimizeOut promptsOptimizePrompt(promptOptimizeIn)
|
|
130
|
+
|
|
131
|
+
Rewrite a draft prompt into a clearer, better-structured version using an LLM.
|
|
132
|
+
|
|
133
|
+
### Example
|
|
134
|
+
|
|
135
|
+
```typescript
|
|
136
|
+
import {
|
|
137
|
+
Prompt,
|
|
138
|
+
Configuration,
|
|
139
|
+
PromptOptimizeIn
|
|
140
|
+
} from 'neuland-hub-sdk';
|
|
141
|
+
|
|
142
|
+
const configuration = new Configuration();
|
|
143
|
+
const apiInstance = new Prompt(configuration);
|
|
144
|
+
|
|
145
|
+
let promptOptimizeIn: PromptOptimizeIn; //
|
|
146
|
+
let cookieName: string; // (optional) (default to undefined)
|
|
147
|
+
|
|
148
|
+
const { status, data } = await apiInstance.promptsOptimizePrompt(
|
|
149
|
+
promptOptimizeIn,
|
|
150
|
+
cookieName
|
|
151
|
+
);
|
|
152
|
+
```
|
|
153
|
+
|
|
154
|
+
### Parameters
|
|
155
|
+
|
|
156
|
+
|Name | Type | Description | Notes|
|
|
157
|
+
|------------- | ------------- | ------------- | -------------|
|
|
158
|
+
| **promptOptimizeIn** | **PromptOptimizeIn**| | |
|
|
159
|
+
| **cookieName** | [**string**] | | (optional) defaults to undefined|
|
|
160
|
+
|
|
161
|
+
|
|
162
|
+
### Return type
|
|
163
|
+
|
|
164
|
+
**PromptOptimizeOut**
|
|
165
|
+
|
|
166
|
+
### Authorization
|
|
167
|
+
|
|
168
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
|
|
169
|
+
|
|
170
|
+
### HTTP request headers
|
|
171
|
+
|
|
172
|
+
- **Content-Type**: application/json
|
|
173
|
+
- **Accept**: application/json
|
|
174
|
+
|
|
175
|
+
|
|
176
|
+
### HTTP response details
|
|
177
|
+
| Status code | Description | Response headers |
|
|
178
|
+
|-------------|-------------|------------------|
|
|
179
|
+
|**200** | Successful Response | - |
|
|
180
|
+
|**401** | Missing or invalid authentication. | - |
|
|
181
|
+
|**403** | Usage budget exceeded. | - |
|
|
182
|
+
|**404** | Current user does not exist. | - |
|
|
183
|
+
|**422** | Validation Error | - |
|
|
184
|
+
|
|
185
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
186
|
+
|
|
187
|
+
# **promptsUpdatePrompt**
|
|
188
|
+
> Prompt promptsUpdatePrompt(promptIn)
|
|
189
|
+
|
|
190
|
+
Update a prompt owned by the current user.
|
|
191
|
+
|
|
192
|
+
### Example
|
|
193
|
+
|
|
194
|
+
```typescript
|
|
195
|
+
import {
|
|
196
|
+
Prompt,
|
|
197
|
+
Configuration,
|
|
198
|
+
PromptIn
|
|
199
|
+
} from 'neuland-hub-sdk';
|
|
200
|
+
|
|
201
|
+
const configuration = new Configuration();
|
|
202
|
+
const apiInstance = new Prompt(configuration);
|
|
203
|
+
|
|
204
|
+
let promptId: string; //Public id of the prompt to update. (default to undefined)
|
|
205
|
+
let promptIn: PromptIn; //
|
|
206
|
+
let cookieName: string; // (optional) (default to undefined)
|
|
207
|
+
|
|
208
|
+
const { status, data } = await apiInstance.promptsUpdatePrompt(
|
|
209
|
+
promptId,
|
|
210
|
+
promptIn,
|
|
211
|
+
cookieName
|
|
212
|
+
);
|
|
213
|
+
```
|
|
214
|
+
|
|
215
|
+
### Parameters
|
|
216
|
+
|
|
217
|
+
|Name | Type | Description | Notes|
|
|
218
|
+
|------------- | ------------- | ------------- | -------------|
|
|
219
|
+
| **promptIn** | **PromptIn**| | |
|
|
220
|
+
| **promptId** | [**string**] | Public id of the prompt to update. | defaults to undefined|
|
|
221
|
+
| **cookieName** | [**string**] | | (optional) defaults to undefined|
|
|
222
|
+
|
|
223
|
+
|
|
224
|
+
### Return type
|
|
225
|
+
|
|
226
|
+
**Prompt**
|
|
227
|
+
|
|
228
|
+
### Authorization
|
|
229
|
+
|
|
230
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
|
|
231
|
+
|
|
232
|
+
### HTTP request headers
|
|
233
|
+
|
|
234
|
+
- **Content-Type**: application/json
|
|
235
|
+
- **Accept**: application/json
|
|
236
|
+
|
|
237
|
+
|
|
238
|
+
### HTTP response details
|
|
239
|
+
| Status code | Description | Response headers |
|
|
240
|
+
|-------------|-------------|------------------|
|
|
241
|
+
|**200** | Successful Response | - |
|
|
242
|
+
|**401** | Missing or invalid authentication. | - |
|
|
243
|
+
|**403** | Not the creator, or only admins may make a prompt public. | - |
|
|
244
|
+
|**404** | No prompt exists with the given id. | - |
|
|
245
|
+
|**422** | Validation Error | - |
|
|
246
|
+
|
|
247
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
248
|
+
|
package/docs/PromptIn.md
ADDED
|
@@ -0,0 +1,26 @@
|
|
|
1
|
+
# PromptIn
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**name** | **string** | | [optional] [default to undefined]
|
|
9
|
+
**prompt** | **string** | The content of the prompt. This field is required. | [default to undefined]
|
|
10
|
+
**is_public** | **boolean** | | [optional] [default to undefined]
|
|
11
|
+
**description** | **string** | | [optional] [default to undefined]
|
|
12
|
+
|
|
13
|
+
## Example
|
|
14
|
+
|
|
15
|
+
```typescript
|
|
16
|
+
import { PromptIn } from 'neuland-hub-sdk';
|
|
17
|
+
|
|
18
|
+
const instance: PromptIn = {
|
|
19
|
+
name,
|
|
20
|
+
prompt,
|
|
21
|
+
is_public,
|
|
22
|
+
description,
|
|
23
|
+
};
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,22 @@
|
|
|
1
|
+
# PromptOptimizeIn
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**prompt** | **string** | Prompt to optimize. | [default to undefined]
|
|
9
|
+
**temperature** | **number** | Temperature for optimization, default is 0.0 | [optional] [default to 0.0]
|
|
10
|
+
|
|
11
|
+
## Example
|
|
12
|
+
|
|
13
|
+
```typescript
|
|
14
|
+
import { PromptOptimizeIn } from 'neuland-hub-sdk';
|
|
15
|
+
|
|
16
|
+
const instance: PromptOptimizeIn = {
|
|
17
|
+
prompt,
|
|
18
|
+
temperature,
|
|
19
|
+
};
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,20 @@
|
|
|
1
|
+
# PromptOptimizeOut
|
|
2
|
+
|
|
3
|
+
|
|
4
|
+
## Properties
|
|
5
|
+
|
|
6
|
+
Name | Type | Description | Notes
|
|
7
|
+
------------ | ------------- | ------------- | -------------
|
|
8
|
+
**content** | **string** | The rewritten, optimized prompt text. | [default to undefined]
|
|
9
|
+
|
|
10
|
+
## Example
|
|
11
|
+
|
|
12
|
+
```typescript
|
|
13
|
+
import { PromptOptimizeOut } from 'neuland-hub-sdk';
|
|
14
|
+
|
|
15
|
+
const instance: PromptOptimizeOut = {
|
|
16
|
+
content,
|
|
17
|
+
};
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Query.md
ADDED
|
@@ -0,0 +1,123 @@
|
|
|
1
|
+
# Query
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**queryQuery**](#queryquery) | **GET** /query/{path} | Proxy a PostgREST query|
|
|
8
|
+
|[**queryQueryRpc**](#queryqueryrpc) | **GET** /query/rpc/{path} | Proxy a PostgREST RPC call|
|
|
9
|
+
|
|
10
|
+
# **queryQuery**
|
|
11
|
+
> any queryQuery()
|
|
12
|
+
|
|
13
|
+
Forward the request to the upstream PostgREST service and return its response.
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
Query,
|
|
20
|
+
Configuration
|
|
21
|
+
} from 'neuland-hub-sdk';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new Query(configuration);
|
|
25
|
+
|
|
26
|
+
let path: string; //PostgREST resource path to proxy. (default to undefined)
|
|
27
|
+
let cookieName: string; // (optional) (default to undefined)
|
|
28
|
+
|
|
29
|
+
const { status, data } = await apiInstance.queryQuery(
|
|
30
|
+
path,
|
|
31
|
+
cookieName
|
|
32
|
+
);
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
### Parameters
|
|
36
|
+
|
|
37
|
+
|Name | Type | Description | Notes|
|
|
38
|
+
|------------- | ------------- | ------------- | -------------|
|
|
39
|
+
| **path** | [**string**] | PostgREST resource path to proxy. | defaults to undefined|
|
|
40
|
+
| **cookieName** | [**string**] | | (optional) defaults to undefined|
|
|
41
|
+
|
|
42
|
+
|
|
43
|
+
### Return type
|
|
44
|
+
|
|
45
|
+
**any**
|
|
46
|
+
|
|
47
|
+
### Authorization
|
|
48
|
+
|
|
49
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
|
|
50
|
+
|
|
51
|
+
### HTTP request headers
|
|
52
|
+
|
|
53
|
+
- **Content-Type**: Not defined
|
|
54
|
+
- **Accept**: application/json
|
|
55
|
+
|
|
56
|
+
|
|
57
|
+
### HTTP response details
|
|
58
|
+
| Status code | Description | Response headers |
|
|
59
|
+
|-------------|-------------|------------------|
|
|
60
|
+
|**200** | Successful Response | - |
|
|
61
|
+
|**401** | Missing or invalid authentication. | - |
|
|
62
|
+
|**502** | The upstream PostgREST service is unavailable. | - |
|
|
63
|
+
|**422** | Validation Error | - |
|
|
64
|
+
|
|
65
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
66
|
+
|
|
67
|
+
# **queryQueryRpc**
|
|
68
|
+
> any queryQueryRpc()
|
|
69
|
+
|
|
70
|
+
Forward the request to an upstream PostgREST RPC endpoint and return its response.
|
|
71
|
+
|
|
72
|
+
### Example
|
|
73
|
+
|
|
74
|
+
```typescript
|
|
75
|
+
import {
|
|
76
|
+
Query,
|
|
77
|
+
Configuration
|
|
78
|
+
} from 'neuland-hub-sdk';
|
|
79
|
+
|
|
80
|
+
const configuration = new Configuration();
|
|
81
|
+
const apiInstance = new Query(configuration);
|
|
82
|
+
|
|
83
|
+
let path: string; //PostgREST RPC function name to invoke. (default to undefined)
|
|
84
|
+
let cookieName: string; // (optional) (default to undefined)
|
|
85
|
+
|
|
86
|
+
const { status, data } = await apiInstance.queryQueryRpc(
|
|
87
|
+
path,
|
|
88
|
+
cookieName
|
|
89
|
+
);
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
### Parameters
|
|
93
|
+
|
|
94
|
+
|Name | Type | Description | Notes|
|
|
95
|
+
|------------- | ------------- | ------------- | -------------|
|
|
96
|
+
| **path** | [**string**] | PostgREST RPC function name to invoke. | defaults to undefined|
|
|
97
|
+
| **cookieName** | [**string**] | | (optional) defaults to undefined|
|
|
98
|
+
|
|
99
|
+
|
|
100
|
+
### Return type
|
|
101
|
+
|
|
102
|
+
**any**
|
|
103
|
+
|
|
104
|
+
### Authorization
|
|
105
|
+
|
|
106
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
|
|
107
|
+
|
|
108
|
+
### HTTP request headers
|
|
109
|
+
|
|
110
|
+
- **Content-Type**: Not defined
|
|
111
|
+
- **Accept**: application/json
|
|
112
|
+
|
|
113
|
+
|
|
114
|
+
### HTTP response details
|
|
115
|
+
| Status code | Description | Response headers |
|
|
116
|
+
|-------------|-------------|------------------|
|
|
117
|
+
|**200** | Successful Response | - |
|
|
118
|
+
|**401** | Missing or invalid authentication. | - |
|
|
119
|
+
|**502** | The upstream PostgREST service is unavailable. | - |
|
|
120
|
+
|**422** | Validation Error | - |
|
|
121
|
+
|
|
122
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
123
|
+
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# RateableTypeEnum
|
|
2
|
+
|
|
3
|
+
Resources that can be rated through the generic rating system.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `ASSISTANT_CATALOG` (value: `'ASSISTANT_CATALOG'`)
|
|
8
|
+
|
|
9
|
+
* `COMMUNITY_ASSISTANT` (value: `'COMMUNITY_ASSISTANT'`)
|
|
10
|
+
|
|
11
|
+
* `APP_CATALOG` (value: `'APP_CATALOG'`)
|
|
12
|
+
|
|
13
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
package/docs/Rating.md
ADDED
|
@@ -0,0 +1,129 @@
|
|
|
1
|
+
# Rating
|
|
2
|
+
|
|
3
|
+
All URIs are relative to *http://localhost*
|
|
4
|
+
|
|
5
|
+
|Method | HTTP request | Description|
|
|
6
|
+
|------------- | ------------- | -------------|
|
|
7
|
+
|[**ratingsRemove**](#ratingsremove) | **DELETE** /ratings/{rateable_type}/{rateable_id} | Delete a rating|
|
|
8
|
+
|[**ratingsUpsert**](#ratingsupsert) | **POST** /ratings/ | Upsert a rating|
|
|
9
|
+
|
|
10
|
+
# **ratingsRemove**
|
|
11
|
+
> ratingsRemove()
|
|
12
|
+
|
|
13
|
+
Delete the caller\'s rating for the target resource.
|
|
14
|
+
|
|
15
|
+
### Example
|
|
16
|
+
|
|
17
|
+
```typescript
|
|
18
|
+
import {
|
|
19
|
+
Rating,
|
|
20
|
+
Configuration
|
|
21
|
+
} from 'neuland-hub-sdk';
|
|
22
|
+
|
|
23
|
+
const configuration = new Configuration();
|
|
24
|
+
const apiInstance = new Rating(configuration);
|
|
25
|
+
|
|
26
|
+
let rateableType: RateableTypeEnum; //Kind of resource whose rating to delete. (default to undefined)
|
|
27
|
+
let rateableId: string; //Public id of the resource whose rating to delete. (default to undefined)
|
|
28
|
+
let cookieName: string; // (optional) (default to undefined)
|
|
29
|
+
|
|
30
|
+
const { status, data } = await apiInstance.ratingsRemove(
|
|
31
|
+
rateableType,
|
|
32
|
+
rateableId,
|
|
33
|
+
cookieName
|
|
34
|
+
);
|
|
35
|
+
```
|
|
36
|
+
|
|
37
|
+
### Parameters
|
|
38
|
+
|
|
39
|
+
|Name | Type | Description | Notes|
|
|
40
|
+
|------------- | ------------- | ------------- | -------------|
|
|
41
|
+
| **rateableType** | **RateableTypeEnum** | Kind of resource whose rating to delete. | defaults to undefined|
|
|
42
|
+
| **rateableId** | [**string**] | Public id of the resource whose rating to delete. | defaults to undefined|
|
|
43
|
+
| **cookieName** | [**string**] | | (optional) defaults to undefined|
|
|
44
|
+
|
|
45
|
+
|
|
46
|
+
### Return type
|
|
47
|
+
|
|
48
|
+
void (empty response body)
|
|
49
|
+
|
|
50
|
+
### Authorization
|
|
51
|
+
|
|
52
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
|
|
53
|
+
|
|
54
|
+
### HTTP request headers
|
|
55
|
+
|
|
56
|
+
- **Content-Type**: Not defined
|
|
57
|
+
- **Accept**: application/json
|
|
58
|
+
|
|
59
|
+
|
|
60
|
+
### HTTP response details
|
|
61
|
+
| Status code | Description | Response headers |
|
|
62
|
+
|-------------|-------------|------------------|
|
|
63
|
+
|**204** | Successful Response | - |
|
|
64
|
+
|**401** | Missing or invalid authentication. | - |
|
|
65
|
+
|**404** | You have not rated this resource. | - |
|
|
66
|
+
|**422** | Validation Error | - |
|
|
67
|
+
|
|
68
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
69
|
+
|
|
70
|
+
# **ratingsUpsert**
|
|
71
|
+
> Rating ratingsUpsert(ratingIn)
|
|
72
|
+
|
|
73
|
+
Upsert the caller\'s rating for the target resource.
|
|
74
|
+
|
|
75
|
+
### Example
|
|
76
|
+
|
|
77
|
+
```typescript
|
|
78
|
+
import {
|
|
79
|
+
Rating,
|
|
80
|
+
Configuration,
|
|
81
|
+
RatingIn
|
|
82
|
+
} from 'neuland-hub-sdk';
|
|
83
|
+
|
|
84
|
+
const configuration = new Configuration();
|
|
85
|
+
const apiInstance = new Rating(configuration);
|
|
86
|
+
|
|
87
|
+
let ratingIn: RatingIn; //
|
|
88
|
+
let cookieName: string; // (optional) (default to undefined)
|
|
89
|
+
|
|
90
|
+
const { status, data } = await apiInstance.ratingsUpsert(
|
|
91
|
+
ratingIn,
|
|
92
|
+
cookieName
|
|
93
|
+
);
|
|
94
|
+
```
|
|
95
|
+
|
|
96
|
+
### Parameters
|
|
97
|
+
|
|
98
|
+
|Name | Type | Description | Notes|
|
|
99
|
+
|------------- | ------------- | ------------- | -------------|
|
|
100
|
+
| **ratingIn** | **RatingIn**| | |
|
|
101
|
+
| **cookieName** | [**string**] | | (optional) defaults to undefined|
|
|
102
|
+
|
|
103
|
+
|
|
104
|
+
### Return type
|
|
105
|
+
|
|
106
|
+
**Rating**
|
|
107
|
+
|
|
108
|
+
### Authorization
|
|
109
|
+
|
|
110
|
+
[APIKeyHeader](../README.md#APIKeyHeader), [OAuth2PasswordBearer](../README.md#OAuth2PasswordBearer)
|
|
111
|
+
|
|
112
|
+
### HTTP request headers
|
|
113
|
+
|
|
114
|
+
- **Content-Type**: application/json
|
|
115
|
+
- **Accept**: application/json
|
|
116
|
+
|
|
117
|
+
|
|
118
|
+
### HTTP response details
|
|
119
|
+
| Status code | Description | Response headers |
|
|
120
|
+
|-------------|-------------|------------------|
|
|
121
|
+
|**200** | Successful Response | - |
|
|
122
|
+
|**401** | Missing or invalid authentication. | - |
|
|
123
|
+
|**403** | The target resource is not in your tenant. | - |
|
|
124
|
+
|**404** | The target resource does not exist. | - |
|
|
125
|
+
|**409** | The target resource cannot be rated (deprecated catalog item, or an assistant that is not community-shared or not ready). | - |
|
|
126
|
+
|**422** | Validation Error | - |
|
|
127
|
+
|
|
128
|
+
[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
|
|
129
|
+
|
package/docs/RatingIn.md
ADDED
|
@@ -0,0 +1,27 @@
|
|
|
1
|
+
# RatingIn
|
|
2
|
+
|
|
3
|
+
Request body for creating or updating a rating.
|
|
4
|
+
|
|
5
|
+
## Properties
|
|
6
|
+
|
|
7
|
+
Name | Type | Description | Notes
|
|
8
|
+
------------ | ------------- | ------------- | -------------
|
|
9
|
+
**rateable_type** | [**RateableTypeEnum**](RateableTypeEnum.md) | Kind of resource being rated. | [default to undefined]
|
|
10
|
+
**rateable_id** | **string** | Public id of the resource being rated. | [default to undefined]
|
|
11
|
+
**value** | **number** | Rating score, from 1 (worst) to 5 (best). | [default to undefined]
|
|
12
|
+
**comment** | **string** | | [optional] [default to undefined]
|
|
13
|
+
|
|
14
|
+
## Example
|
|
15
|
+
|
|
16
|
+
```typescript
|
|
17
|
+
import { RatingIn } from 'neuland-hub-sdk';
|
|
18
|
+
|
|
19
|
+
const instance: RatingIn = {
|
|
20
|
+
rateable_type,
|
|
21
|
+
rateable_id,
|
|
22
|
+
value,
|
|
23
|
+
comment,
|
|
24
|
+
};
|
|
25
|
+
```
|
|
26
|
+
|
|
27
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
# ReasoningEffortEnum
|
|
2
|
+
|
|
3
|
+
How much reasoning a model should spend, forwarded as `reasoning_effort`.
|
|
4
|
+
|
|
5
|
+
## Enum
|
|
6
|
+
|
|
7
|
+
* `low` (value: `'low'`)
|
|
8
|
+
|
|
9
|
+
* `medium` (value: `'medium'`)
|
|
10
|
+
|
|
11
|
+
* `high` (value: `'high'`)
|
|
12
|
+
|
|
13
|
+
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
|