Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add summary feature #128

Merged
merged 1 commit into from
Oct 23, 2024
Merged

Add summary feature #128

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,9 @@
# Changelog
All changes to this project will be documented in this file.

## [1.4.5] - 2024-10-21
- Add summary feature

## [1.4.4] - 2024-10-08
- Add transcript feature

Expand Down
35 changes: 32 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@
- [ChaptersApi](#chaptersapi)
- [LiveStreamsApi](#livestreamsapi)
- [PlayerThemesApi](#playerthemesapi)
- [SummariesApi](#summariesapi)
- [TagsApi](#tagsapi)
- [UploadTokensApi](#uploadtokensapi)
- [VideosApi](#videosapi)
Expand Down Expand Up @@ -69,7 +70,7 @@ Add this dependency to your project's POM:
<dependency>
<groupId>video.api</groupId>
<artifactId>java-api-client</artifactId>
<version>1.4.4</version>
<version>1.4.5</version>
<scope>compile</scope>
</dependency>
```
Expand All @@ -79,7 +80,7 @@ Add this dependency to your project's POM:
Add this dependency to your project's build file:

```groovy
implementation "video.api:java-api-client:1.4.4"
implementation "video.api:java-api-client:1.4.5"
```

#### Others
Expand All @@ -92,7 +93,7 @@ mvn clean package

Then manually install the following JARs:

* `target/java-api-client-1.4.4.jar`
* `target/java-api-client-1.4.5.jar`
* `target/lib/*.jar`

### Code sample
Expand Down Expand Up @@ -249,6 +250,28 @@ Method | HTTP request | Description
[**deleteLogo**](https://github.com/apivideo/api.video-java-client/blob/main/docs/PlayerThemesApi.md#deleteLogo) | **DELETE** `/players/{playerId}/logo` | Delete logo


### SummariesApi


#### Retrieve an instance of SummariesApi:
```java
ApiVideoClient client = new ApiVideoClient("YOUR_API_KEY");
SummariesApi summaries = client.summaries()
```



#### Endpoints

Method | HTTP request | Description
------------- | ------------- | -------------
[**create**](https://github.com/apivideo/api.video-java-client/blob/main/docs/SummariesApi.md#create) | **POST** `/summaries` | Generate video summary
[**update**](https://github.com/apivideo/api.video-java-client/blob/main/docs/SummariesApi.md#update) | **PATCH** `/summaries/{summaryId}/source` | Update summary details
[**delete**](https://github.com/apivideo/api.video-java-client/blob/main/docs/SummariesApi.md#delete) | **DELETE** `/summaries/{summaryId}` | Delete video summary
[**list**](https://github.com/apivideo/api.video-java-client/blob/main/docs/SummariesApi.md#list) | **GET** `/summaries` | List summaries
[**getSummarySource**](https://github.com/apivideo/api.video-java-client/blob/main/docs/SummariesApi.md#getSummarySource) | **GET** `/summaries/{summaryId}/source` | Get summary details


### TagsApi


Expand Down Expand Up @@ -384,6 +407,7 @@ Method | HTTP request | Description
- [CaptionsUpdatePayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/CaptionsUpdatePayload.md)
- [Chapter](https://github.com/apivideo/api.video-java-client/blob/main/docs/Chapter.md)
- [ChaptersListResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/ChaptersListResponse.md)
- [ConflictError](https://github.com/apivideo/api.video-java-client/blob/main/docs/ConflictError.md)
- [DiscardedVideoUpdatePayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/DiscardedVideoUpdatePayload.md)
- [FilterBy](https://github.com/apivideo/api.video-java-client/blob/main/docs/FilterBy.md)
- [FilterBy1](https://github.com/apivideo/api.video-java-client/blob/main/docs/FilterBy1.md)
Expand Down Expand Up @@ -411,6 +435,11 @@ Method | HTTP request | Description
- [RefreshTokenPayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/RefreshTokenPayload.md)
- [RestreamsRequestObject](https://github.com/apivideo/api.video-java-client/blob/main/docs/RestreamsRequestObject.md)
- [RestreamsResponseObject](https://github.com/apivideo/api.video-java-client/blob/main/docs/RestreamsResponseObject.md)
- [SummariesListResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/SummariesListResponse.md)
- [Summary](https://github.com/apivideo/api.video-java-client/blob/main/docs/Summary.md)
- [SummaryCreationPayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/SummaryCreationPayload.md)
- [SummarySource](https://github.com/apivideo/api.video-java-client/blob/main/docs/SummarySource.md)
- [SummaryUpdatePayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/SummaryUpdatePayload.md)
- [TokenCreationPayload](https://github.com/apivideo/api.video-java-client/blob/main/docs/TokenCreationPayload.md)
- [TokenListResponse](https://github.com/apivideo/api.video-java-client/blob/main/docs/TokenListResponse.md)
- [TooManyRequests](https://github.com/apivideo/api.video-java-client/blob/main/docs/TooManyRequests.md)
Expand Down
Loading
Loading