openai-client-base 0.13.0

Auto-generated Rust client for the OpenAI API
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122

# \DataRetentionApi

All URIs are relative to *https://api.openai.com/v1*

Method | HTTP request | Description
------------- | ------------- | -------------
[**retrieve_organization_data_retention**](DataRetentionApi.md#retrieve_organization_data_retention) | **GET** /organization/data_retention | Retrieves organization data retention controls.
[**retrieve_project_data_retention**](DataRetentionApi.md#retrieve_project_data_retention) | **GET** /organization/projects/{project_id}/data_retention | Retrieves project data retention controls.
[**update_organization_data_retention**](DataRetentionApi.md#update_organization_data_retention) | **POST** /organization/data_retention | Updates organization data retention controls.
[**update_project_data_retention**](DataRetentionApi.md#update_project_data_retention) | **POST** /organization/projects/{project_id}/data_retention | Updates project data retention controls.



## retrieve_organization_data_retention

> models::OrganizationDataRetention retrieve_organization_data_retention()
Retrieves organization data retention controls.

### Parameters

This endpoint does not need any parameter.

### Return type

[**models::OrganizationDataRetention**](OrganizationDataRetention.md)

### Authorization

[AdminApiKeyAuth](../README.md#AdminApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## retrieve_project_data_retention

> models::ProjectDataRetention retrieve_project_data_retention(project_id)
Retrieves project data retention controls.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | The ID of the project to inspect. | [required] |

### Return type

[**models::ProjectDataRetention**](ProjectDataRetention.md)

### Authorization

[AdminApiKeyAuth](../README.md#AdminApiKeyAuth)

### HTTP request headers

- **Content-Type**: Not defined
- **Accept**: application/json

[[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)


## update_organization_data_retention

> models::OrganizationDataRetention update_organization_data_retention(update_organization_data_retention_body)
Updates organization data retention controls.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**update_organization_data_retention_body** | [**UpdateOrganizationDataRetentionBody**](UpdateOrganizationDataRetentionBody.md) | The desired organization data retention setting. | [required] |

### Return type

[**models::OrganizationDataRetention**](OrganizationDataRetention.md)

### Authorization

[AdminApiKeyAuth](../README.md#AdminApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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)


## update_project_data_retention

> models::ProjectDataRetention update_project_data_retention(project_id, update_project_data_retention_body)
Updates project data retention controls.

### Parameters


Name | Type | Description  | Required | Notes
------------- | ------------- | ------------- | ------------- | -------------
**project_id** | **String** | The ID of the project to update. | [required] |
**update_project_data_retention_body** | [**UpdateProjectDataRetentionBody**](UpdateProjectDataRetentionBody.md) | The desired project data retention setting. | [required] |

### Return type

[**models::ProjectDataRetention**](ProjectDataRetention.md)

### Authorization

[AdminApiKeyAuth](../README.md#AdminApiKeyAuth)

### HTTP request headers

- **Content-Type**: application/json
- **Accept**: application/json

[[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)