pulp_hugging_face_client 0.0.1
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.
- checksums.yaml +7 -0
- data/Gemfile +9 -0
- data/README.md +176 -0
- data/Rakefile +10 -0
- data/docs/AsyncOperationResponse.md +18 -0
- data/docs/ContentHuggingFaceApi.md +424 -0
- data/docs/ContentSummaryResponse.md +22 -0
- data/docs/DistributionsHuggingFaceApi.md +671 -0
- data/docs/HuggingFaceHuggingFaceContent.md +36 -0
- data/docs/HuggingFaceHuggingFaceContentResponse.md +42 -0
- data/docs/HuggingFaceHuggingFaceDistribution.md +32 -0
- data/docs/HuggingFaceHuggingFaceDistributionResponse.md +44 -0
- data/docs/HuggingFaceHuggingFacePublication.md +20 -0
- data/docs/HuggingFaceHuggingFacePublicationResponse.md +28 -0
- data/docs/HuggingFaceHuggingFaceRemote.md +62 -0
- data/docs/HuggingFaceHuggingFaceRemoteResponse.md +62 -0
- data/docs/HuggingFaceHuggingFaceRemoteResponseHiddenFieldsInner.md +20 -0
- data/docs/HuggingFaceHuggingFaceRepository.md +26 -0
- data/docs/HuggingFaceHuggingFaceRepositoryResponse.md +38 -0
- data/docs/PaginatedRepositoryVersionResponseList.md +24 -0
- data/docs/PaginatedhuggingFaceHuggingFaceContentResponseList.md +24 -0
- data/docs/PaginatedhuggingFaceHuggingFaceDistributionResponseList.md +24 -0
- data/docs/PaginatedhuggingFaceHuggingFacePublicationResponseList.md +24 -0
- data/docs/PaginatedhuggingFaceHuggingFaceRemoteResponseList.md +24 -0
- data/docs/PaginatedhuggingFaceHuggingFaceRepositoryResponseList.md +24 -0
- data/docs/PatchedhuggingFaceHuggingFaceDistribution.md +32 -0
- data/docs/PatchedhuggingFaceHuggingFaceRemote.md +62 -0
- data/docs/PatchedhuggingFaceHuggingFaceRepository.md +26 -0
- data/docs/PolicyEnum.md +15 -0
- data/docs/PublicationsHuggingFaceApi.md +350 -0
- data/docs/RemotesHuggingFaceApi.md +669 -0
- data/docs/Repair.md +18 -0
- data/docs/RepoTypeEnum.md +15 -0
- data/docs/RepositoriesHuggingFaceApi.md +831 -0
- data/docs/RepositoriesHuggingFaceVersionsApi.md +359 -0
- data/docs/RepositoryAddRemoveContent.md +22 -0
- data/docs/RepositorySyncURL.md +20 -0
- data/docs/RepositoryVersionResponse.md +32 -0
- data/docs/SetLabel.md +20 -0
- data/docs/SetLabelResponse.md +20 -0
- data/docs/UnsetLabel.md +18 -0
- data/docs/UnsetLabelResponse.md +20 -0
- data/lib/pulp_hugging_face_client/api/content_hugging_face_api.rb +441 -0
- data/lib/pulp_hugging_face_client/api/distributions_hugging_face_api.rb +684 -0
- data/lib/pulp_hugging_face_client/api/publications_hugging_face_api.rb +356 -0
- data/lib/pulp_hugging_face_client/api/remotes_hugging_face_api.rb +681 -0
- data/lib/pulp_hugging_face_client/api/repositories_hugging_face_api.rb +847 -0
- data/lib/pulp_hugging_face_client/api/repositories_hugging_face_versions_api.rb +374 -0
- data/lib/pulp_hugging_face_client/api_client.rb +438 -0
- data/lib/pulp_hugging_face_client/api_error.rb +58 -0
- data/lib/pulp_hugging_face_client/configuration.rb +392 -0
- data/lib/pulp_hugging_face_client/models/async_operation_response.rb +223 -0
- data/lib/pulp_hugging_face_client/models/content_summary_response.rb +260 -0
- data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_content.rb +428 -0
- data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_content_response.rb +385 -0
- data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_distribution.rb +345 -0
- data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_distribution_response.rb +366 -0
- data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_publication.rb +225 -0
- data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_publication_response.rb +264 -0
- data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_remote.rb +745 -0
- data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_remote_response.rb +564 -0
- data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_remote_response_hidden_fields_inner.rb +237 -0
- data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_repository.rb +316 -0
- data/lib/pulp_hugging_face_client/models/hugging_face_hugging_face_repository_response.rb +339 -0
- data/lib/pulp_hugging_face_client/models/paginated_repository_version_response_list.rb +259 -0
- data/lib/pulp_hugging_face_client/models/paginatedhugging_face_hugging_face_content_response_list.rb +259 -0
- data/lib/pulp_hugging_face_client/models/paginatedhugging_face_hugging_face_distribution_response_list.rb +259 -0
- data/lib/pulp_hugging_face_client/models/paginatedhugging_face_hugging_face_publication_response_list.rb +259 -0
- data/lib/pulp_hugging_face_client/models/paginatedhugging_face_hugging_face_remote_response_list.rb +259 -0
- data/lib/pulp_hugging_face_client/models/paginatedhugging_face_hugging_face_repository_response_list.rb +259 -0
- data/lib/pulp_hugging_face_client/models/patchedhugging_face_hugging_face_distribution.rb +331 -0
- data/lib/pulp_hugging_face_client/models/patchedhugging_face_hugging_face_remote.rb +731 -0
- data/lib/pulp_hugging_face_client/models/patchedhugging_face_hugging_face_repository.rb +309 -0
- data/lib/pulp_hugging_face_client/models/policy_enum.rb +41 -0
- data/lib/pulp_hugging_face_client/models/repair.rb +217 -0
- data/lib/pulp_hugging_face_client/models/repo_type_enum.rb +41 -0
- data/lib/pulp_hugging_face_client/models/repository_add_remove_content.rb +240 -0
- data/lib/pulp_hugging_face_client/models/repository_sync_url.rb +228 -0
- data/lib/pulp_hugging_face_client/models/repository_version_response.rb +283 -0
- data/lib/pulp_hugging_face_client/models/set_label.rb +264 -0
- data/lib/pulp_hugging_face_client/models/set_label_response.rb +255 -0
- data/lib/pulp_hugging_face_client/models/unset_label.rb +252 -0
- data/lib/pulp_hugging_face_client/models/unset_label_response.rb +252 -0
- data/lib/pulp_hugging_face_client/version.rb +15 -0
- data/lib/pulp_hugging_face_client.rb +77 -0
- data/pulp_hugging_face_client.gemspec +41 -0
- data/spec/api/content_hugging_face_api_spec.rb +121 -0
- data/spec/api/distributions_hugging_face_api_spec.rb +171 -0
- data/spec/api/publications_hugging_face_api_spec.rb +109 -0
- data/spec/api/remotes_hugging_face_api_spec.rb +170 -0
- data/spec/api/repositories_hugging_face_api_spec.rb +202 -0
- data/spec/api/repositories_hugging_face_versions_api_spec.rb +112 -0
- data/spec/models/async_operation_response_spec.rb +36 -0
- data/spec/models/content_summary_response_spec.rb +48 -0
- data/spec/models/hugging_face_hugging_face_content_response_spec.rb +108 -0
- data/spec/models/hugging_face_hugging_face_content_spec.rb +90 -0
- data/spec/models/hugging_face_hugging_face_distribution_response_spec.rb +114 -0
- data/spec/models/hugging_face_hugging_face_distribution_spec.rb +78 -0
- data/spec/models/hugging_face_hugging_face_publication_response_spec.rb +66 -0
- data/spec/models/hugging_face_hugging_face_publication_spec.rb +42 -0
- data/spec/models/hugging_face_hugging_face_remote_response_hidden_fields_inner_spec.rb +42 -0
- data/spec/models/hugging_face_hugging_face_remote_response_spec.rb +168 -0
- data/spec/models/hugging_face_hugging_face_remote_spec.rb +168 -0
- data/spec/models/hugging_face_hugging_face_repository_response_spec.rb +96 -0
- data/spec/models/hugging_face_hugging_face_repository_spec.rb +60 -0
- data/spec/models/paginated_repository_version_response_list_spec.rb +54 -0
- data/spec/models/paginatedhugging_face_hugging_face_content_response_list_spec.rb +54 -0
- data/spec/models/paginatedhugging_face_hugging_face_distribution_response_list_spec.rb +54 -0
- data/spec/models/paginatedhugging_face_hugging_face_publication_response_list_spec.rb +54 -0
- data/spec/models/paginatedhugging_face_hugging_face_remote_response_list_spec.rb +54 -0
- data/spec/models/paginatedhugging_face_hugging_face_repository_response_list_spec.rb +54 -0
- data/spec/models/patchedhugging_face_hugging_face_distribution_spec.rb +78 -0
- data/spec/models/patchedhugging_face_hugging_face_remote_spec.rb +168 -0
- data/spec/models/patchedhugging_face_hugging_face_repository_spec.rb +60 -0
- data/spec/models/policy_enum_spec.rb +30 -0
- data/spec/models/repair_spec.rb +36 -0
- data/spec/models/repo_type_enum_spec.rb +30 -0
- data/spec/models/repository_add_remove_content_spec.rb +48 -0
- data/spec/models/repository_sync_url_spec.rb +42 -0
- data/spec/models/repository_version_response_spec.rb +78 -0
- data/spec/models/set_label_response_spec.rb +42 -0
- data/spec/models/set_label_spec.rb +42 -0
- data/spec/models/unset_label_response_spec.rb +42 -0
- data/spec/models/unset_label_spec.rb +36 -0
- data/spec/spec_helper.rb +111 -0
- metadata +274 -0
checksums.yaml
ADDED
@@ -0,0 +1,7 @@
|
|
1
|
+
---
|
2
|
+
SHA256:
|
3
|
+
metadata.gz: fdebe2ba118b1ad52bda8b9be31fd79128be8697b1c98247091389ec0ec9fe26
|
4
|
+
data.tar.gz: a75a755ceb9d7d7bca8d640a7f0ad628451ced90472d8f20b556469a07dac418
|
5
|
+
SHA512:
|
6
|
+
metadata.gz: c25e14329b3ad474bdcc8d48f6e3f27dd0f9aa6ca954470be9f55eaec934f09db23a216241c1d25913e48fc520e8f193523eb0816ecce0d130ab3d070ccef783
|
7
|
+
data.tar.gz: cd9c5cb16425baf81b172cb0264994cab600a9c183c3735ac551a9bef67e00f78f65adba050b8adc367f9730398d0c1f5231d978283ffbc302d0f54dd635ce36
|
data/Gemfile
ADDED
data/README.md
ADDED
@@ -0,0 +1,176 @@
|
|
1
|
+
# pulp_hugging_face_client
|
2
|
+
|
3
|
+
PulpHuggingFaceClient - the Ruby gem for the Pulp 3 API
|
4
|
+
|
5
|
+
Fetch, Upload, Organize, and Distribute Software Packages
|
6
|
+
|
7
|
+
This SDK is automatically generated by the [OpenAPI Generator](https://openapi-generator.tech) project:
|
8
|
+
|
9
|
+
- API version: v3
|
10
|
+
- Package version: 0.0.1
|
11
|
+
- Generator version: 7.10.0
|
12
|
+
- Build package: org.openapitools.codegen.languages.RubyClientCodegen
|
13
|
+
For more information, please visit [https://pulpproject.org](https://pulpproject.org)
|
14
|
+
|
15
|
+
## Installation
|
16
|
+
|
17
|
+
### Build a gem
|
18
|
+
|
19
|
+
To build the Ruby code into a gem:
|
20
|
+
|
21
|
+
```shell
|
22
|
+
gem build pulp_hugging_face_client.gemspec
|
23
|
+
```
|
24
|
+
|
25
|
+
Then either install the gem locally:
|
26
|
+
|
27
|
+
```shell
|
28
|
+
gem install ./pulp_hugging_face_client-0.0.1.gem
|
29
|
+
```
|
30
|
+
|
31
|
+
(for development, run `gem install --dev ./pulp_hugging_face_client-0.0.1.gem` to install the development dependencies)
|
32
|
+
|
33
|
+
or publish the gem to a gem hosting service, e.g. [RubyGems](https://rubygems.org/).
|
34
|
+
|
35
|
+
Finally add this to the Gemfile:
|
36
|
+
|
37
|
+
gem 'pulp_hugging_face_client', '~> 0.0.1'
|
38
|
+
|
39
|
+
### Install from Git
|
40
|
+
|
41
|
+
If the Ruby gem is hosted at a git repository: https://github.com/GIT_USER_ID/GIT_REPO_ID, then add the following in the Gemfile:
|
42
|
+
|
43
|
+
gem 'pulp_hugging_face_client', :git => 'https://github.com/GIT_USER_ID/GIT_REPO_ID.git'
|
44
|
+
|
45
|
+
### Include the Ruby code directly
|
46
|
+
|
47
|
+
Include the Ruby code directly using `-I` as follows:
|
48
|
+
|
49
|
+
```shell
|
50
|
+
ruby -Ilib script.rb
|
51
|
+
```
|
52
|
+
|
53
|
+
## Getting Started
|
54
|
+
|
55
|
+
Please follow the [installation](#installation) procedure and then run the following code:
|
56
|
+
|
57
|
+
```ruby
|
58
|
+
# Load the gem
|
59
|
+
require 'pulp_hugging_face_client'
|
60
|
+
|
61
|
+
# Setup authorization
|
62
|
+
PulpHuggingFaceClient.configure do |config|
|
63
|
+
# Configure HTTP basic authorization: basicAuth
|
64
|
+
config.username = 'YOUR_USERNAME'
|
65
|
+
config.password = 'YOUR_PASSWORD'
|
66
|
+
# Configure faraday connection
|
67
|
+
config.configure_faraday_connection { |connection| 'YOUR CONNECTION CONFIG PROC' }
|
68
|
+
end
|
69
|
+
|
70
|
+
api_instance = PulpHuggingFaceClient::ContentHuggingFaceApi.new
|
71
|
+
hugging_face_hugging_face_content = PulpHuggingFaceClient::HuggingFaceHuggingFaceContent.new({artifact: 'artifact_example', relative_path: 'relative_path_example', repo_id: 'repo_id_example'}) # HuggingFaceHuggingFaceContent |
|
72
|
+
opts = {
|
73
|
+
x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
|
74
|
+
}
|
75
|
+
|
76
|
+
begin
|
77
|
+
#Create a hugging face content
|
78
|
+
result = api_instance.create(hugging_face_hugging_face_content, opts)
|
79
|
+
p result
|
80
|
+
rescue PulpHuggingFaceClient::ApiError => e
|
81
|
+
puts "Exception when calling ContentHuggingFaceApi->create: #{e}"
|
82
|
+
end
|
83
|
+
|
84
|
+
```
|
85
|
+
|
86
|
+
## Documentation for API Endpoints
|
87
|
+
|
88
|
+
All URIs are relative to *http://localhost:24817*
|
89
|
+
|
90
|
+
Class | Method | HTTP request | Description
|
91
|
+
------------ | ------------- | ------------- | -------------
|
92
|
+
*PulpHuggingFaceClient::ContentHuggingFaceApi* | [**create**](docs/ContentHuggingFaceApi.md#create) | **POST** /pulp/api/v3/content/hugging_face/hugging-face/ | Create a hugging face content
|
93
|
+
*PulpHuggingFaceClient::ContentHuggingFaceApi* | [**list**](docs/ContentHuggingFaceApi.md#list) | **GET** /pulp/api/v3/content/hugging_face/hugging-face/ | List hugging face contents
|
94
|
+
*PulpHuggingFaceClient::ContentHuggingFaceApi* | [**read**](docs/ContentHuggingFaceApi.md#read) | **GET** {hugging_face_hugging_face_content_href} | Inspect a hugging face content
|
95
|
+
*PulpHuggingFaceClient::ContentHuggingFaceApi* | [**set_label**](docs/ContentHuggingFaceApi.md#set_label) | **POST** {hugging_face_hugging_face_content_href}set_label/ | Set a label
|
96
|
+
*PulpHuggingFaceClient::ContentHuggingFaceApi* | [**unset_label**](docs/ContentHuggingFaceApi.md#unset_label) | **POST** {hugging_face_hugging_face_content_href}unset_label/ | Unset a label
|
97
|
+
*PulpHuggingFaceClient::DistributionsHuggingFaceApi* | [**create**](docs/DistributionsHuggingFaceApi.md#create) | **POST** /pulp/api/v3/distributions/hugging_face/hugging-face/ | Create a hugging face distribution
|
98
|
+
*PulpHuggingFaceClient::DistributionsHuggingFaceApi* | [**delete**](docs/DistributionsHuggingFaceApi.md#delete) | **DELETE** {hugging_face_hugging_face_distribution_href} | Delete a hugging face distribution
|
99
|
+
*PulpHuggingFaceClient::DistributionsHuggingFaceApi* | [**list**](docs/DistributionsHuggingFaceApi.md#list) | **GET** /pulp/api/v3/distributions/hugging_face/hugging-face/ | List hugging face distributions
|
100
|
+
*PulpHuggingFaceClient::DistributionsHuggingFaceApi* | [**partial_update**](docs/DistributionsHuggingFaceApi.md#partial_update) | **PATCH** {hugging_face_hugging_face_distribution_href} | Update a hugging face distribution
|
101
|
+
*PulpHuggingFaceClient::DistributionsHuggingFaceApi* | [**read**](docs/DistributionsHuggingFaceApi.md#read) | **GET** {hugging_face_hugging_face_distribution_href} | Inspect a hugging face distribution
|
102
|
+
*PulpHuggingFaceClient::DistributionsHuggingFaceApi* | [**set_label**](docs/DistributionsHuggingFaceApi.md#set_label) | **POST** {hugging_face_hugging_face_distribution_href}set_label/ | Set a label
|
103
|
+
*PulpHuggingFaceClient::DistributionsHuggingFaceApi* | [**unset_label**](docs/DistributionsHuggingFaceApi.md#unset_label) | **POST** {hugging_face_hugging_face_distribution_href}unset_label/ | Unset a label
|
104
|
+
*PulpHuggingFaceClient::DistributionsHuggingFaceApi* | [**update**](docs/DistributionsHuggingFaceApi.md#update) | **PUT** {hugging_face_hugging_face_distribution_href} | Update a hugging face distribution
|
105
|
+
*PulpHuggingFaceClient::PublicationsHuggingFaceApi* | [**create**](docs/PublicationsHuggingFaceApi.md#create) | **POST** /pulp/api/v3/publications/hugging_face/hugging-face/ | Create a hugging face publication
|
106
|
+
*PulpHuggingFaceClient::PublicationsHuggingFaceApi* | [**delete**](docs/PublicationsHuggingFaceApi.md#delete) | **DELETE** {hugging_face_hugging_face_publication_href} | Delete a hugging face publication
|
107
|
+
*PulpHuggingFaceClient::PublicationsHuggingFaceApi* | [**list**](docs/PublicationsHuggingFaceApi.md#list) | **GET** /pulp/api/v3/publications/hugging_face/hugging-face/ | List hugging face publications
|
108
|
+
*PulpHuggingFaceClient::PublicationsHuggingFaceApi* | [**read**](docs/PublicationsHuggingFaceApi.md#read) | **GET** {hugging_face_hugging_face_publication_href} | Inspect a hugging face publication
|
109
|
+
*PulpHuggingFaceClient::RemotesHuggingFaceApi* | [**create**](docs/RemotesHuggingFaceApi.md#create) | **POST** /pulp/api/v3/remotes/hugging_face/hugging-face/ | Create a hugging face remote
|
110
|
+
*PulpHuggingFaceClient::RemotesHuggingFaceApi* | [**delete**](docs/RemotesHuggingFaceApi.md#delete) | **DELETE** {hugging_face_hugging_face_remote_href} | Delete a hugging face remote
|
111
|
+
*PulpHuggingFaceClient::RemotesHuggingFaceApi* | [**list**](docs/RemotesHuggingFaceApi.md#list) | **GET** /pulp/api/v3/remotes/hugging_face/hugging-face/ | List hugging face remotes
|
112
|
+
*PulpHuggingFaceClient::RemotesHuggingFaceApi* | [**partial_update**](docs/RemotesHuggingFaceApi.md#partial_update) | **PATCH** {hugging_face_hugging_face_remote_href} | Update a hugging face remote
|
113
|
+
*PulpHuggingFaceClient::RemotesHuggingFaceApi* | [**read**](docs/RemotesHuggingFaceApi.md#read) | **GET** {hugging_face_hugging_face_remote_href} | Inspect a hugging face remote
|
114
|
+
*PulpHuggingFaceClient::RemotesHuggingFaceApi* | [**set_label**](docs/RemotesHuggingFaceApi.md#set_label) | **POST** {hugging_face_hugging_face_remote_href}set_label/ | Set a label
|
115
|
+
*PulpHuggingFaceClient::RemotesHuggingFaceApi* | [**unset_label**](docs/RemotesHuggingFaceApi.md#unset_label) | **POST** {hugging_face_hugging_face_remote_href}unset_label/ | Unset a label
|
116
|
+
*PulpHuggingFaceClient::RemotesHuggingFaceApi* | [**update**](docs/RemotesHuggingFaceApi.md#update) | **PUT** {hugging_face_hugging_face_remote_href} | Update a hugging face remote
|
117
|
+
*PulpHuggingFaceClient::RepositoriesHuggingFaceApi* | [**create**](docs/RepositoriesHuggingFaceApi.md#create) | **POST** /pulp/api/v3/repositories/hugging_face/hugging-face/ | Create a hugging face repository
|
118
|
+
*PulpHuggingFaceClient::RepositoriesHuggingFaceApi* | [**delete**](docs/RepositoriesHuggingFaceApi.md#delete) | **DELETE** {hugging_face_hugging_face_repository_href} | Delete a hugging face repository
|
119
|
+
*PulpHuggingFaceClient::RepositoriesHuggingFaceApi* | [**list**](docs/RepositoriesHuggingFaceApi.md#list) | **GET** /pulp/api/v3/repositories/hugging_face/hugging-face/ | List hugging face repositorys
|
120
|
+
*PulpHuggingFaceClient::RepositoriesHuggingFaceApi* | [**modify**](docs/RepositoriesHuggingFaceApi.md#modify) | **POST** {hugging_face_hugging_face_repository_href}modify/ | Modify Repository Content
|
121
|
+
*PulpHuggingFaceClient::RepositoriesHuggingFaceApi* | [**partial_update**](docs/RepositoriesHuggingFaceApi.md#partial_update) | **PATCH** {hugging_face_hugging_face_repository_href} | Update a hugging face repository
|
122
|
+
*PulpHuggingFaceClient::RepositoriesHuggingFaceApi* | [**read**](docs/RepositoriesHuggingFaceApi.md#read) | **GET** {hugging_face_hugging_face_repository_href} | Inspect a hugging face repository
|
123
|
+
*PulpHuggingFaceClient::RepositoriesHuggingFaceApi* | [**set_label**](docs/RepositoriesHuggingFaceApi.md#set_label) | **POST** {hugging_face_hugging_face_repository_href}set_label/ | Set a label
|
124
|
+
*PulpHuggingFaceClient::RepositoriesHuggingFaceApi* | [**sync**](docs/RepositoriesHuggingFaceApi.md#sync) | **POST** {hugging_face_hugging_face_repository_href}sync/ | Sync from remote
|
125
|
+
*PulpHuggingFaceClient::RepositoriesHuggingFaceApi* | [**unset_label**](docs/RepositoriesHuggingFaceApi.md#unset_label) | **POST** {hugging_face_hugging_face_repository_href}unset_label/ | Unset a label
|
126
|
+
*PulpHuggingFaceClient::RepositoriesHuggingFaceApi* | [**update**](docs/RepositoriesHuggingFaceApi.md#update) | **PUT** {hugging_face_hugging_face_repository_href} | Update a hugging face repository
|
127
|
+
*PulpHuggingFaceClient::RepositoriesHuggingFaceVersionsApi* | [**delete**](docs/RepositoriesHuggingFaceVersionsApi.md#delete) | **DELETE** {hugging_face_hugging_face_repository_version_href} | Delete a repository version
|
128
|
+
*PulpHuggingFaceClient::RepositoriesHuggingFaceVersionsApi* | [**list**](docs/RepositoriesHuggingFaceVersionsApi.md#list) | **GET** {hugging_face_hugging_face_repository_href}versions/ | List repository versions
|
129
|
+
*PulpHuggingFaceClient::RepositoriesHuggingFaceVersionsApi* | [**read**](docs/RepositoriesHuggingFaceVersionsApi.md#read) | **GET** {hugging_face_hugging_face_repository_version_href} | Inspect a repository version
|
130
|
+
*PulpHuggingFaceClient::RepositoriesHuggingFaceVersionsApi* | [**repair**](docs/RepositoriesHuggingFaceVersionsApi.md#repair) | **POST** {hugging_face_hugging_face_repository_version_href}repair/ |
|
131
|
+
|
132
|
+
|
133
|
+
## Documentation for Models
|
134
|
+
|
135
|
+
- [PulpHuggingFaceClient::AsyncOperationResponse](docs/AsyncOperationResponse.md)
|
136
|
+
- [PulpHuggingFaceClient::ContentSummaryResponse](docs/ContentSummaryResponse.md)
|
137
|
+
- [PulpHuggingFaceClient::HuggingFaceHuggingFaceContent](docs/HuggingFaceHuggingFaceContent.md)
|
138
|
+
- [PulpHuggingFaceClient::HuggingFaceHuggingFaceContentResponse](docs/HuggingFaceHuggingFaceContentResponse.md)
|
139
|
+
- [PulpHuggingFaceClient::HuggingFaceHuggingFaceDistribution](docs/HuggingFaceHuggingFaceDistribution.md)
|
140
|
+
- [PulpHuggingFaceClient::HuggingFaceHuggingFaceDistributionResponse](docs/HuggingFaceHuggingFaceDistributionResponse.md)
|
141
|
+
- [PulpHuggingFaceClient::HuggingFaceHuggingFacePublication](docs/HuggingFaceHuggingFacePublication.md)
|
142
|
+
- [PulpHuggingFaceClient::HuggingFaceHuggingFacePublicationResponse](docs/HuggingFaceHuggingFacePublicationResponse.md)
|
143
|
+
- [PulpHuggingFaceClient::HuggingFaceHuggingFaceRemote](docs/HuggingFaceHuggingFaceRemote.md)
|
144
|
+
- [PulpHuggingFaceClient::HuggingFaceHuggingFaceRemoteResponse](docs/HuggingFaceHuggingFaceRemoteResponse.md)
|
145
|
+
- [PulpHuggingFaceClient::HuggingFaceHuggingFaceRemoteResponseHiddenFieldsInner](docs/HuggingFaceHuggingFaceRemoteResponseHiddenFieldsInner.md)
|
146
|
+
- [PulpHuggingFaceClient::HuggingFaceHuggingFaceRepository](docs/HuggingFaceHuggingFaceRepository.md)
|
147
|
+
- [PulpHuggingFaceClient::HuggingFaceHuggingFaceRepositoryResponse](docs/HuggingFaceHuggingFaceRepositoryResponse.md)
|
148
|
+
- [PulpHuggingFaceClient::PaginatedRepositoryVersionResponseList](docs/PaginatedRepositoryVersionResponseList.md)
|
149
|
+
- [PulpHuggingFaceClient::PaginatedhuggingFaceHuggingFaceContentResponseList](docs/PaginatedhuggingFaceHuggingFaceContentResponseList.md)
|
150
|
+
- [PulpHuggingFaceClient::PaginatedhuggingFaceHuggingFaceDistributionResponseList](docs/PaginatedhuggingFaceHuggingFaceDistributionResponseList.md)
|
151
|
+
- [PulpHuggingFaceClient::PaginatedhuggingFaceHuggingFacePublicationResponseList](docs/PaginatedhuggingFaceHuggingFacePublicationResponseList.md)
|
152
|
+
- [PulpHuggingFaceClient::PaginatedhuggingFaceHuggingFaceRemoteResponseList](docs/PaginatedhuggingFaceHuggingFaceRemoteResponseList.md)
|
153
|
+
- [PulpHuggingFaceClient::PaginatedhuggingFaceHuggingFaceRepositoryResponseList](docs/PaginatedhuggingFaceHuggingFaceRepositoryResponseList.md)
|
154
|
+
- [PulpHuggingFaceClient::PatchedhuggingFaceHuggingFaceDistribution](docs/PatchedhuggingFaceHuggingFaceDistribution.md)
|
155
|
+
- [PulpHuggingFaceClient::PatchedhuggingFaceHuggingFaceRemote](docs/PatchedhuggingFaceHuggingFaceRemote.md)
|
156
|
+
- [PulpHuggingFaceClient::PatchedhuggingFaceHuggingFaceRepository](docs/PatchedhuggingFaceHuggingFaceRepository.md)
|
157
|
+
- [PulpHuggingFaceClient::PolicyEnum](docs/PolicyEnum.md)
|
158
|
+
- [PulpHuggingFaceClient::Repair](docs/Repair.md)
|
159
|
+
- [PulpHuggingFaceClient::RepoTypeEnum](docs/RepoTypeEnum.md)
|
160
|
+
- [PulpHuggingFaceClient::RepositoryAddRemoveContent](docs/RepositoryAddRemoveContent.md)
|
161
|
+
- [PulpHuggingFaceClient::RepositorySyncURL](docs/RepositorySyncURL.md)
|
162
|
+
- [PulpHuggingFaceClient::RepositoryVersionResponse](docs/RepositoryVersionResponse.md)
|
163
|
+
- [PulpHuggingFaceClient::SetLabel](docs/SetLabel.md)
|
164
|
+
- [PulpHuggingFaceClient::SetLabelResponse](docs/SetLabelResponse.md)
|
165
|
+
- [PulpHuggingFaceClient::UnsetLabel](docs/UnsetLabel.md)
|
166
|
+
- [PulpHuggingFaceClient::UnsetLabelResponse](docs/UnsetLabelResponse.md)
|
167
|
+
|
168
|
+
|
169
|
+
## Documentation for Authorization
|
170
|
+
|
171
|
+
|
172
|
+
Authentication schemes defined for the API:
|
173
|
+
### basicAuth
|
174
|
+
|
175
|
+
- **Type**: HTTP basic authentication
|
176
|
+
|
data/Rakefile
ADDED
@@ -0,0 +1,18 @@
|
|
1
|
+
# PulpHuggingFaceClient::AsyncOperationResponse
|
2
|
+
|
3
|
+
## Properties
|
4
|
+
|
5
|
+
| Name | Type | Description | Notes |
|
6
|
+
| ---- | ---- | ----------- | ----- |
|
7
|
+
| **task** | **String** | The href of the task. | |
|
8
|
+
|
9
|
+
## Example
|
10
|
+
|
11
|
+
```ruby
|
12
|
+
require 'pulp_hugging_face_client'
|
13
|
+
|
14
|
+
instance = PulpHuggingFaceClient::AsyncOperationResponse.new(
|
15
|
+
task: null
|
16
|
+
)
|
17
|
+
```
|
18
|
+
|
@@ -0,0 +1,424 @@
|
|
1
|
+
# PulpHuggingFaceClient::ContentHuggingFaceApi
|
2
|
+
|
3
|
+
All URIs are relative to *http://localhost:24817*
|
4
|
+
|
5
|
+
| Method | HTTP request | Description |
|
6
|
+
| ------ | ------------ | ----------- |
|
7
|
+
| [**create**](ContentHuggingFaceApi.md#create) | **POST** /pulp/api/v3/content/hugging_face/hugging-face/ | Create a hugging face content |
|
8
|
+
| [**list**](ContentHuggingFaceApi.md#list) | **GET** /pulp/api/v3/content/hugging_face/hugging-face/ | List hugging face contents |
|
9
|
+
| [**read**](ContentHuggingFaceApi.md#read) | **GET** {hugging_face_hugging_face_content_href} | Inspect a hugging face content |
|
10
|
+
| [**set_label**](ContentHuggingFaceApi.md#set_label) | **POST** {hugging_face_hugging_face_content_href}set_label/ | Set a label |
|
11
|
+
| [**unset_label**](ContentHuggingFaceApi.md#unset_label) | **POST** {hugging_face_hugging_face_content_href}unset_label/ | Unset a label |
|
12
|
+
|
13
|
+
|
14
|
+
## create
|
15
|
+
|
16
|
+
> <HuggingFaceHuggingFaceContentResponse> create(hugging_face_hugging_face_content, opts)
|
17
|
+
|
18
|
+
Create a hugging face content
|
19
|
+
|
20
|
+
Perform bookkeeping when saving Content. \"Artifacts\" need to be popped off and saved indpendently, as they are not actually part of the Content model.
|
21
|
+
|
22
|
+
### Examples
|
23
|
+
|
24
|
+
```ruby
|
25
|
+
require 'time'
|
26
|
+
require 'pulp_hugging_face_client'
|
27
|
+
# setup authorization
|
28
|
+
PulpHuggingFaceClient.configure do |config|
|
29
|
+
# Configure HTTP basic authorization: basicAuth
|
30
|
+
config.username = 'YOUR USERNAME'
|
31
|
+
config.password = 'YOUR PASSWORD'
|
32
|
+
end
|
33
|
+
|
34
|
+
api_instance = PulpHuggingFaceClient::ContentHuggingFaceApi.new
|
35
|
+
hugging_face_hugging_face_content = PulpHuggingFaceClient::HuggingFaceHuggingFaceContent.new({artifact: 'artifact_example', relative_path: 'relative_path_example', repo_id: 'repo_id_example'}) # HuggingFaceHuggingFaceContent |
|
36
|
+
opts = {
|
37
|
+
x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
|
38
|
+
}
|
39
|
+
|
40
|
+
begin
|
41
|
+
# Create a hugging face content
|
42
|
+
result = api_instance.create(hugging_face_hugging_face_content, opts)
|
43
|
+
p result
|
44
|
+
rescue PulpHuggingFaceClient::ApiError => e
|
45
|
+
puts "Error when calling ContentHuggingFaceApi->create: #{e}"
|
46
|
+
end
|
47
|
+
```
|
48
|
+
|
49
|
+
#### Using the create_with_http_info variant
|
50
|
+
|
51
|
+
This returns an Array which contains the response data, status code and headers.
|
52
|
+
|
53
|
+
> <Array(<HuggingFaceHuggingFaceContentResponse>, Integer, Hash)> create_with_http_info(hugging_face_hugging_face_content, opts)
|
54
|
+
|
55
|
+
```ruby
|
56
|
+
begin
|
57
|
+
# Create a hugging face content
|
58
|
+
data, status_code, headers = api_instance.create_with_http_info(hugging_face_hugging_face_content, opts)
|
59
|
+
p status_code # => 2xx
|
60
|
+
p headers # => { ... }
|
61
|
+
p data # => <HuggingFaceHuggingFaceContentResponse>
|
62
|
+
rescue PulpHuggingFaceClient::ApiError => e
|
63
|
+
puts "Error when calling ContentHuggingFaceApi->create_with_http_info: #{e}"
|
64
|
+
end
|
65
|
+
```
|
66
|
+
|
67
|
+
### Parameters
|
68
|
+
|
69
|
+
| Name | Type | Description | Notes |
|
70
|
+
| ---- | ---- | ----------- | ----- |
|
71
|
+
| **hugging_face_hugging_face_content** | [**HuggingFaceHuggingFaceContent**](HuggingFaceHuggingFaceContent.md) | | |
|
72
|
+
| **x_task_diagnostics** | [**Array<String>**](String.md) | List of profilers to use on tasks. | [optional] |
|
73
|
+
|
74
|
+
### Return type
|
75
|
+
|
76
|
+
[**HuggingFaceHuggingFaceContentResponse**](HuggingFaceHuggingFaceContentResponse.md)
|
77
|
+
|
78
|
+
### Authorization
|
79
|
+
|
80
|
+
[basicAuth](../README.md#basicAuth)
|
81
|
+
|
82
|
+
### HTTP request headers
|
83
|
+
|
84
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
85
|
+
- **Accept**: application/json
|
86
|
+
|
87
|
+
|
88
|
+
## list
|
89
|
+
|
90
|
+
> <PaginatedhuggingFaceHuggingFaceContentResponseList> list(opts)
|
91
|
+
|
92
|
+
List hugging face contents
|
93
|
+
|
94
|
+
A ViewSet for HuggingFaceContent. Define endpoint name which will appear in the API endpoint for this content type. For example:: https://pulp.example.com/pulp/api/v3/content/hugging-face/units/ Also specify queryset and serializer for HuggingFaceContent.
|
95
|
+
|
96
|
+
### Examples
|
97
|
+
|
98
|
+
```ruby
|
99
|
+
require 'time'
|
100
|
+
require 'pulp_hugging_face_client'
|
101
|
+
# setup authorization
|
102
|
+
PulpHuggingFaceClient.configure do |config|
|
103
|
+
# Configure HTTP basic authorization: basicAuth
|
104
|
+
config.username = 'YOUR USERNAME'
|
105
|
+
config.password = 'YOUR PASSWORD'
|
106
|
+
end
|
107
|
+
|
108
|
+
api_instance = PulpHuggingFaceClient::ContentHuggingFaceApi.new
|
109
|
+
opts = {
|
110
|
+
x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
|
111
|
+
limit: 56, # Integer | Number of results to return per page.
|
112
|
+
offset: 56, # Integer | The initial index from which to return the results.
|
113
|
+
ordering: ['-etag'], # Array<String> | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `repo_id` - Repo id * `-repo_id` - Repo id (descending) * `repo_type` - Repo type * `-repo_type` - Repo type (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `revision` - Revision * `-revision` - Revision (descending) * `size` - Size * `-size` - Size (descending) * `etag` - Etag * `-etag` - Etag (descending) * `last_modified` - Last modified * `-last_modified` - Last modified (descending) * `pk` - Pk * `-pk` - Pk (descending)
|
114
|
+
orphaned_for: 8.14, # Float | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME.
|
115
|
+
prn__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
116
|
+
pulp_href__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
117
|
+
pulp_id__in: ['inner_example'], # Array<String> | Multiple values may be separated by commas.
|
118
|
+
pulp_label_select: 'pulp_label_select_example', # String | Filter labels by search string
|
119
|
+
q: 'q_example', # String | Filter results by using NOT, AND and OR operations on other filters
|
120
|
+
relative_path: 'relative_path_example', # String | Filter results where relative_path matches value
|
121
|
+
repo_id: 'repo_id_example', # String | Filter results where repo_id matches value
|
122
|
+
repo_type: 'datasets', # String | Filter results where repo_type matches value * `models` - Models * `datasets` - Datasets * `spaces` - Spaces
|
123
|
+
repository_version: 'repository_version_example', # String | Repository Version referenced by HREF/PRN
|
124
|
+
repository_version_added: 'repository_version_added_example', # String | Repository Version referenced by HREF/PRN
|
125
|
+
repository_version_removed: 'repository_version_removed_example', # String | Repository Version referenced by HREF/PRN
|
126
|
+
revision: 'revision_example', # String | Filter results where revision matches value
|
127
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
128
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
129
|
+
}
|
130
|
+
|
131
|
+
begin
|
132
|
+
# List hugging face contents
|
133
|
+
result = api_instance.list(opts)
|
134
|
+
p result
|
135
|
+
rescue PulpHuggingFaceClient::ApiError => e
|
136
|
+
puts "Error when calling ContentHuggingFaceApi->list: #{e}"
|
137
|
+
end
|
138
|
+
```
|
139
|
+
|
140
|
+
#### Using the list_with_http_info variant
|
141
|
+
|
142
|
+
This returns an Array which contains the response data, status code and headers.
|
143
|
+
|
144
|
+
> <Array(<PaginatedhuggingFaceHuggingFaceContentResponseList>, Integer, Hash)> list_with_http_info(opts)
|
145
|
+
|
146
|
+
```ruby
|
147
|
+
begin
|
148
|
+
# List hugging face contents
|
149
|
+
data, status_code, headers = api_instance.list_with_http_info(opts)
|
150
|
+
p status_code # => 2xx
|
151
|
+
p headers # => { ... }
|
152
|
+
p data # => <PaginatedhuggingFaceHuggingFaceContentResponseList>
|
153
|
+
rescue PulpHuggingFaceClient::ApiError => e
|
154
|
+
puts "Error when calling ContentHuggingFaceApi->list_with_http_info: #{e}"
|
155
|
+
end
|
156
|
+
```
|
157
|
+
|
158
|
+
### Parameters
|
159
|
+
|
160
|
+
| Name | Type | Description | Notes |
|
161
|
+
| ---- | ---- | ----------- | ----- |
|
162
|
+
| **x_task_diagnostics** | [**Array<String>**](String.md) | List of profilers to use on tasks. | [optional] |
|
163
|
+
| **limit** | **Integer** | Number of results to return per page. | [optional] |
|
164
|
+
| **offset** | **Integer** | The initial index from which to return the results. | [optional] |
|
165
|
+
| **ordering** | [**Array<String>**](String.md) | Ordering * `pulp_id` - Pulp id * `-pulp_id` - Pulp id (descending) * `pulp_created` - Pulp created * `-pulp_created` - Pulp created (descending) * `pulp_last_updated` - Pulp last updated * `-pulp_last_updated` - Pulp last updated (descending) * `pulp_type` - Pulp type * `-pulp_type` - Pulp type (descending) * `upstream_id` - Upstream id * `-upstream_id` - Upstream id (descending) * `pulp_labels` - Pulp labels * `-pulp_labels` - Pulp labels (descending) * `timestamp_of_interest` - Timestamp of interest * `-timestamp_of_interest` - Timestamp of interest (descending) * `repo_id` - Repo id * `-repo_id` - Repo id (descending) * `repo_type` - Repo type * `-repo_type` - Repo type (descending) * `relative_path` - Relative path * `-relative_path` - Relative path (descending) * `revision` - Revision * `-revision` - Revision (descending) * `size` - Size * `-size` - Size (descending) * `etag` - Etag * `-etag` - Etag (descending) * `last_modified` - Last modified * `-last_modified` - Last modified (descending) * `pk` - Pk * `-pk` - Pk (descending) | [optional] |
|
166
|
+
| **orphaned_for** | **Float** | Minutes Content has been orphaned for. -1 uses ORPHAN_PROTECTION_TIME. | [optional] |
|
167
|
+
| **prn__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
168
|
+
| **pulp_href__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
169
|
+
| **pulp_id__in** | [**Array<String>**](String.md) | Multiple values may be separated by commas. | [optional] |
|
170
|
+
| **pulp_label_select** | **String** | Filter labels by search string | [optional] |
|
171
|
+
| **q** | **String** | Filter results by using NOT, AND and OR operations on other filters | [optional] |
|
172
|
+
| **relative_path** | **String** | Filter results where relative_path matches value | [optional] |
|
173
|
+
| **repo_id** | **String** | Filter results where repo_id matches value | [optional] |
|
174
|
+
| **repo_type** | **String** | Filter results where repo_type matches value * `models` - Models * `datasets` - Datasets * `spaces` - Spaces | [optional] |
|
175
|
+
| **repository_version** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
176
|
+
| **repository_version_added** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
177
|
+
| **repository_version_removed** | **String** | Repository Version referenced by HREF/PRN | [optional] |
|
178
|
+
| **revision** | **String** | Filter results where revision matches value | [optional] |
|
179
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
180
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
181
|
+
|
182
|
+
### Return type
|
183
|
+
|
184
|
+
[**PaginatedhuggingFaceHuggingFaceContentResponseList**](PaginatedhuggingFaceHuggingFaceContentResponseList.md)
|
185
|
+
|
186
|
+
### Authorization
|
187
|
+
|
188
|
+
[basicAuth](../README.md#basicAuth)
|
189
|
+
|
190
|
+
### HTTP request headers
|
191
|
+
|
192
|
+
- **Content-Type**: Not defined
|
193
|
+
- **Accept**: application/json
|
194
|
+
|
195
|
+
|
196
|
+
## read
|
197
|
+
|
198
|
+
> <HuggingFaceHuggingFaceContentResponse> read(hugging_face_hugging_face_content_href, opts)
|
199
|
+
|
200
|
+
Inspect a hugging face content
|
201
|
+
|
202
|
+
A ViewSet for HuggingFaceContent. Define endpoint name which will appear in the API endpoint for this content type. For example:: https://pulp.example.com/pulp/api/v3/content/hugging-face/units/ Also specify queryset and serializer for HuggingFaceContent.
|
203
|
+
|
204
|
+
### Examples
|
205
|
+
|
206
|
+
```ruby
|
207
|
+
require 'time'
|
208
|
+
require 'pulp_hugging_face_client'
|
209
|
+
# setup authorization
|
210
|
+
PulpHuggingFaceClient.configure do |config|
|
211
|
+
# Configure HTTP basic authorization: basicAuth
|
212
|
+
config.username = 'YOUR USERNAME'
|
213
|
+
config.password = 'YOUR PASSWORD'
|
214
|
+
end
|
215
|
+
|
216
|
+
api_instance = PulpHuggingFaceClient::ContentHuggingFaceApi.new
|
217
|
+
hugging_face_hugging_face_content_href = 'hugging_face_hugging_face_content_href_example' # String |
|
218
|
+
opts = {
|
219
|
+
x_task_diagnostics: ['inner_example'], # Array<String> | List of profilers to use on tasks.
|
220
|
+
fields: ['inner_example'], # Array<String> | A list of fields to include in the response.
|
221
|
+
exclude_fields: ['inner_example'] # Array<String> | A list of fields to exclude from the response.
|
222
|
+
}
|
223
|
+
|
224
|
+
begin
|
225
|
+
# Inspect a hugging face content
|
226
|
+
result = api_instance.read(hugging_face_hugging_face_content_href, opts)
|
227
|
+
p result
|
228
|
+
rescue PulpHuggingFaceClient::ApiError => e
|
229
|
+
puts "Error when calling ContentHuggingFaceApi->read: #{e}"
|
230
|
+
end
|
231
|
+
```
|
232
|
+
|
233
|
+
#### Using the read_with_http_info variant
|
234
|
+
|
235
|
+
This returns an Array which contains the response data, status code and headers.
|
236
|
+
|
237
|
+
> <Array(<HuggingFaceHuggingFaceContentResponse>, Integer, Hash)> read_with_http_info(hugging_face_hugging_face_content_href, opts)
|
238
|
+
|
239
|
+
```ruby
|
240
|
+
begin
|
241
|
+
# Inspect a hugging face content
|
242
|
+
data, status_code, headers = api_instance.read_with_http_info(hugging_face_hugging_face_content_href, opts)
|
243
|
+
p status_code # => 2xx
|
244
|
+
p headers # => { ... }
|
245
|
+
p data # => <HuggingFaceHuggingFaceContentResponse>
|
246
|
+
rescue PulpHuggingFaceClient::ApiError => e
|
247
|
+
puts "Error when calling ContentHuggingFaceApi->read_with_http_info: #{e}"
|
248
|
+
end
|
249
|
+
```
|
250
|
+
|
251
|
+
### Parameters
|
252
|
+
|
253
|
+
| Name | Type | Description | Notes |
|
254
|
+
| ---- | ---- | ----------- | ----- |
|
255
|
+
| **hugging_face_hugging_face_content_href** | **String** | | |
|
256
|
+
| **x_task_diagnostics** | [**Array<String>**](String.md) | List of profilers to use on tasks. | [optional] |
|
257
|
+
| **fields** | [**Array<String>**](String.md) | A list of fields to include in the response. | [optional] |
|
258
|
+
| **exclude_fields** | [**Array<String>**](String.md) | A list of fields to exclude from the response. | [optional] |
|
259
|
+
|
260
|
+
### Return type
|
261
|
+
|
262
|
+
[**HuggingFaceHuggingFaceContentResponse**](HuggingFaceHuggingFaceContentResponse.md)
|
263
|
+
|
264
|
+
### Authorization
|
265
|
+
|
266
|
+
[basicAuth](../README.md#basicAuth)
|
267
|
+
|
268
|
+
### HTTP request headers
|
269
|
+
|
270
|
+
- **Content-Type**: Not defined
|
271
|
+
- **Accept**: application/json
|
272
|
+
|
273
|
+
|
274
|
+
## set_label
|
275
|
+
|
276
|
+
> <SetLabelResponse> set_label(hugging_face_hugging_face_content_href, set_label, opts)
|
277
|
+
|
278
|
+
Set a label
|
279
|
+
|
280
|
+
Set a single pulp_label on the object to a specific value or null.
|
281
|
+
|
282
|
+
### Examples
|
283
|
+
|
284
|
+
```ruby
|
285
|
+
require 'time'
|
286
|
+
require 'pulp_hugging_face_client'
|
287
|
+
# setup authorization
|
288
|
+
PulpHuggingFaceClient.configure do |config|
|
289
|
+
# Configure HTTP basic authorization: basicAuth
|
290
|
+
config.username = 'YOUR USERNAME'
|
291
|
+
config.password = 'YOUR PASSWORD'
|
292
|
+
end
|
293
|
+
|
294
|
+
api_instance = PulpHuggingFaceClient::ContentHuggingFaceApi.new
|
295
|
+
hugging_face_hugging_face_content_href = 'hugging_face_hugging_face_content_href_example' # String |
|
296
|
+
set_label = PulpHuggingFaceClient::SetLabel.new({key: 'key_example', value: 'value_example'}) # SetLabel |
|
297
|
+
opts = {
|
298
|
+
x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
|
299
|
+
}
|
300
|
+
|
301
|
+
begin
|
302
|
+
# Set a label
|
303
|
+
result = api_instance.set_label(hugging_face_hugging_face_content_href, set_label, opts)
|
304
|
+
p result
|
305
|
+
rescue PulpHuggingFaceClient::ApiError => e
|
306
|
+
puts "Error when calling ContentHuggingFaceApi->set_label: #{e}"
|
307
|
+
end
|
308
|
+
```
|
309
|
+
|
310
|
+
#### Using the set_label_with_http_info variant
|
311
|
+
|
312
|
+
This returns an Array which contains the response data, status code and headers.
|
313
|
+
|
314
|
+
> <Array(<SetLabelResponse>, Integer, Hash)> set_label_with_http_info(hugging_face_hugging_face_content_href, set_label, opts)
|
315
|
+
|
316
|
+
```ruby
|
317
|
+
begin
|
318
|
+
# Set a label
|
319
|
+
data, status_code, headers = api_instance.set_label_with_http_info(hugging_face_hugging_face_content_href, set_label, opts)
|
320
|
+
p status_code # => 2xx
|
321
|
+
p headers # => { ... }
|
322
|
+
p data # => <SetLabelResponse>
|
323
|
+
rescue PulpHuggingFaceClient::ApiError => e
|
324
|
+
puts "Error when calling ContentHuggingFaceApi->set_label_with_http_info: #{e}"
|
325
|
+
end
|
326
|
+
```
|
327
|
+
|
328
|
+
### Parameters
|
329
|
+
|
330
|
+
| Name | Type | Description | Notes |
|
331
|
+
| ---- | ---- | ----------- | ----- |
|
332
|
+
| **hugging_face_hugging_face_content_href** | **String** | | |
|
333
|
+
| **set_label** | [**SetLabel**](SetLabel.md) | | |
|
334
|
+
| **x_task_diagnostics** | [**Array<String>**](String.md) | List of profilers to use on tasks. | [optional] |
|
335
|
+
|
336
|
+
### Return type
|
337
|
+
|
338
|
+
[**SetLabelResponse**](SetLabelResponse.md)
|
339
|
+
|
340
|
+
### Authorization
|
341
|
+
|
342
|
+
[basicAuth](../README.md#basicAuth)
|
343
|
+
|
344
|
+
### HTTP request headers
|
345
|
+
|
346
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
347
|
+
- **Accept**: application/json
|
348
|
+
|
349
|
+
|
350
|
+
## unset_label
|
351
|
+
|
352
|
+
> <UnsetLabelResponse> unset_label(hugging_face_hugging_face_content_href, unset_label, opts)
|
353
|
+
|
354
|
+
Unset a label
|
355
|
+
|
356
|
+
Unset a single pulp_label on the object.
|
357
|
+
|
358
|
+
### Examples
|
359
|
+
|
360
|
+
```ruby
|
361
|
+
require 'time'
|
362
|
+
require 'pulp_hugging_face_client'
|
363
|
+
# setup authorization
|
364
|
+
PulpHuggingFaceClient.configure do |config|
|
365
|
+
# Configure HTTP basic authorization: basicAuth
|
366
|
+
config.username = 'YOUR USERNAME'
|
367
|
+
config.password = 'YOUR PASSWORD'
|
368
|
+
end
|
369
|
+
|
370
|
+
api_instance = PulpHuggingFaceClient::ContentHuggingFaceApi.new
|
371
|
+
hugging_face_hugging_face_content_href = 'hugging_face_hugging_face_content_href_example' # String |
|
372
|
+
unset_label = PulpHuggingFaceClient::UnsetLabel.new({key: 'key_example'}) # UnsetLabel |
|
373
|
+
opts = {
|
374
|
+
x_task_diagnostics: ['inner_example'] # Array<String> | List of profilers to use on tasks.
|
375
|
+
}
|
376
|
+
|
377
|
+
begin
|
378
|
+
# Unset a label
|
379
|
+
result = api_instance.unset_label(hugging_face_hugging_face_content_href, unset_label, opts)
|
380
|
+
p result
|
381
|
+
rescue PulpHuggingFaceClient::ApiError => e
|
382
|
+
puts "Error when calling ContentHuggingFaceApi->unset_label: #{e}"
|
383
|
+
end
|
384
|
+
```
|
385
|
+
|
386
|
+
#### Using the unset_label_with_http_info variant
|
387
|
+
|
388
|
+
This returns an Array which contains the response data, status code and headers.
|
389
|
+
|
390
|
+
> <Array(<UnsetLabelResponse>, Integer, Hash)> unset_label_with_http_info(hugging_face_hugging_face_content_href, unset_label, opts)
|
391
|
+
|
392
|
+
```ruby
|
393
|
+
begin
|
394
|
+
# Unset a label
|
395
|
+
data, status_code, headers = api_instance.unset_label_with_http_info(hugging_face_hugging_face_content_href, unset_label, opts)
|
396
|
+
p status_code # => 2xx
|
397
|
+
p headers # => { ... }
|
398
|
+
p data # => <UnsetLabelResponse>
|
399
|
+
rescue PulpHuggingFaceClient::ApiError => e
|
400
|
+
puts "Error when calling ContentHuggingFaceApi->unset_label_with_http_info: #{e}"
|
401
|
+
end
|
402
|
+
```
|
403
|
+
|
404
|
+
### Parameters
|
405
|
+
|
406
|
+
| Name | Type | Description | Notes |
|
407
|
+
| ---- | ---- | ----------- | ----- |
|
408
|
+
| **hugging_face_hugging_face_content_href** | **String** | | |
|
409
|
+
| **unset_label** | [**UnsetLabel**](UnsetLabel.md) | | |
|
410
|
+
| **x_task_diagnostics** | [**Array<String>**](String.md) | List of profilers to use on tasks. | [optional] |
|
411
|
+
|
412
|
+
### Return type
|
413
|
+
|
414
|
+
[**UnsetLabelResponse**](UnsetLabelResponse.md)
|
415
|
+
|
416
|
+
### Authorization
|
417
|
+
|
418
|
+
[basicAuth](../README.md#basicAuth)
|
419
|
+
|
420
|
+
### HTTP request headers
|
421
|
+
|
422
|
+
- **Content-Type**: application/json, application/x-www-form-urlencoded, multipart/form-data
|
423
|
+
- **Accept**: application/json
|
424
|
+
|