整理主目录,更新AI总结文档 (#871)

* 整理README中的目录信息,使之与项目中的文档一一对应。

更新AI总结的文档,修复card_info.md中出现的格式错乱。

* 修改AI总结文档的错误内容
This commit is contained in:
EssentialCuber 2023-11-23 13:40:54 +08:00 committed by GitHub
parent 86ba55259d
commit a01ef3bdc2
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 366 additions and 291 deletions

View File

@ -71,6 +71,7 @@ B站 API 采用 C/S 结构,大多数接口为 REST API 和 gRPC少部分接
- [x] [公共错误码](docs/misc/errcode.md)
- [x] [图片格式化](docs/misc/picture.md)
- [x] [bvid 说明](docs/misc/bvid_desc.md)
- [ ] [设备唯一标识BUVID](docs/misc/device_identity.md)
- [ ] [gRPC API 接口定义](grpc_api)
- [ ] [登录](docs/login)
- [x] [登录操作 (人机认证)](docs/login/login_action)
@ -95,6 +96,7 @@ B站 API 采用 C/S 结构,大多数接口为 REST API 和 gRPC少部分接
- [x] [检查昵称是否可注册](docs/user/check_nickname.md)
- [x] [用户注册](docs/user/register.md)
- [x] [用户认证类型一览](docs/user/official_role.md)
- [ ] [加入老粉计划](docs/user/contract.md)
- [ ] [大会员](docs/vip)
- [ ] [大会员基本信息](docs/vip/info.md)
- [ ] [大会员中心](docs/vip/center.md)
@ -114,10 +116,14 @@ B站 API 采用 C/S 结构,大多数接口为 REST API 和 gRPC少部分接
- [ ] [信息上报 (心跳及记录历史)](docs/video/report.md)
- [x] [视频属性数据](docs/video/attribute_data.md)
- [x] [视频在线人数](docs/video/online.md)
- [x] [视频AI摘要](docs/video/summary.md)
- [ ] [稿件投诉](docs/video/appeal.md)
- [ ] [视频状态数](docs/video/status_number.md)
- [ ] [剧集 (番剧、影视)](docs/bangumi)
- [ ] [基本信息](docs/bangumi/info.md)
- [ ] [播放&下载地址(视频流)](docs/bangumi/videostream_url.md)
- [ ] [时间轴](docs/bangumi/timeline.md)
- [ ] [追番相关](docs/bangumi/follow.md)
- [ ] 状态数
- [ ] 操作
- [ ] [视频弹幕](docs/danmaku)
@ -138,7 +144,7 @@ B站 API 采用 C/S 结构,大多数接口为 REST API 和 gRPC少部分接
- [x] [笔记详细信息](docs/note/info.md)
- [x] [笔记操作](docs/note/action.md)
- [ ] [专栏](docs/article)
- [ ] 分区
- [ ] [专栏分类](docs/article/category.md)
- [X] [基本信息](docs/article/info.md)
- [X] [点赞 & 投币 & 收藏 & 分享](docs/article/action.md)
- [X] [文集基本信息](docs/article/articles.md)
@ -186,7 +192,13 @@ B站 API 采用 C/S 结构,大多数接口为 REST API 和 gRPC少部分接
- [x] [充电留言](docs/electric/charge_msg.md)
- [x] [充电列表](docs/electric/charge_list.md)
- [ ] [动态](docs/dynamic)
- [ ] [获取动态列表](docs/dynamic/all.md)
- [ ] [获取用户孔径动态](docs/dynamic/space.md)
- [ ] [动态基本信息](docs/dynamic/basicInfo.md)
- [ ] [动态详细信息字段](docs/dynamic/card_info.md)
- [ ] [获取动态详情](docs/dynamic/detail.md)
- [ ] [动态类型](docs/dynamic/dynamic_enum.md)
- [ ] [动态信息](docs/dynamic/content.md)
- [ ] [发送 & 转载动态](docs/dynamic/publish.md)
- [ ] [根据关键字搜索用户at 别人时的填充列表)](docs/dynamic/atlist.md)
- [ ] [操作](docs/dynamic/action.md)
@ -231,14 +243,16 @@ B站 API 采用 C/S 结构,大多数接口为 REST API 和 gRPC少部分接
- [ ] B币充值
- [ ] 贝壳相关
- [ ] [哔哩哔哩漫画](docs/manga)
- [ ] [用户信息](docs/manga/user.md)
- [ ] 用户信息
- [x] [签到](docs/manga/ClockIn.md)
- [x] [积分商城](docs/manga/point_shop.md)
- [x] [漫画操作](docs/manga/Comic.md)
- [ ] [漫画任务操作](docs/manga/Activity.md)
- [x] [漫画赛季](docs/manga/Season.md)
- [x] [漫读券/已购相关](docs/manga/User.md)
- [x] [下载](docs/manga/Download.md)
- [x] [data.index解析](docs/manga/index_file.md)
- [ ] [获取轻享卡信息](docs/manga/light_card.md)
- [ ] 哔哩哔哩游戏
- [ ] [终端网络查询](docs/clientinfo)
- [x] [基于 ip 的地理位置查询](docs/clientinfo/ip.md)
@ -343,7 +357,8 @@ OR Aifadian[https://afdian.net/@ShakaiAneE](https://afdian.net/@ShakaiAneE)
- [grpc/grpc](https://github.com/grpc/grpc): The C based gRPC (C++, Python, Ruby, Objective-C, PHP, C#)
- [quicktype](https://github.com/quicktype/quicktype) quicktype generates strongly-typed models and serializers from JSON, JSON Schema, TypeScript, and GraphQL queries, making it a breeze to work with JSON type-safely in many programming languages.一键生成多种语言的json反序列化所需类,以便于快速反序列化, 有网页版
- [quicktype](https://github.com/quicktype/quicktype) quicktype generates strongly-typed models and serializers from JSON, JSON Schema, TypeScript, and GraphQL queries, making it a breeze to work with JSON type-safely in many programming languages.一键生成多种语言的json反序列化所需类,以便于快速反序列化,
有网页版
<style scoped>
.shields a {

View File

@ -13,6 +13,7 @@
需注意账号转发视频投稿其他用户的动态以及分享收藏夹等均为转发类内容并不属于type=4300的收藏类动态等。
在type=1的转发类动态中解析出的对象包含以下内容
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ------- |
| user | obj | 转发者用户信息 | 包含用户名用户id和头像 |
@ -106,6 +107,7 @@
## 在图片动态中type=2
在type=2的图片动态中解析出的对象包含以下内容
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ------- |
| item | obj | 图片动态内容 | `description`字段为文字内容<br/>`pictures`字段图片 | |
@ -166,10 +168,10 @@
</details>
## 在文字动态中type=4
在type=4的文字动态中解析出的对象包含以下内容
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ------- |
| item | obj | 文字动态内容 | `description`字段为文字内容 | |
@ -204,6 +206,7 @@
## 在视频投稿动态中type=8
在type=8的视频投稿动态中解析出的对象包含以下内容
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ------- |
| aid | num | 视频avid | |
@ -302,6 +305,7 @@
## 在专栏投稿动态中type=64
在type=64的专栏投稿动态中解析出的对象包含以下内容
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ------- |
| id | num | 专栏的id即cv号 | |
@ -448,6 +452,7 @@
## 在音频投稿动态中type=256
在type=256的音频投稿动态中解析出的对象包含以下内容
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | ------- |
| id | num | 投稿编号 | 即au号 |

View File

@ -1,5 +1,3 @@
**# 视频AI总结**
@ -18,21 +16,16 @@
**请求方式: Get**
认证方式: Cookie(SESSDATA)
认证方式: 无需认证
限制游客访问,需要登录
鉴权方式:[Wbi 签名](../misc/sign/wbi.md)
**url参数**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------ | ---- | ---------- | ------ | ------------------------------------ |
|--------|-----|--------|-----|----------------------------------|
| bvid | str | 稿件bvid | 必要 | |
| cid | num | 稿件cid | 必要 | |
| up_mid | num | UP主mid | 必要 | |
@ -44,7 +37,7 @@
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | -------------------------------- |
|---------|-----|------|--------------------------|
| code | num | 返回值 | 0: 成功<br /> -403: 访问权限不足 |
| message | str | 错误信息 | 默认为0 |
| ttl | num | 1 | |
@ -53,14 +46,14 @@
`data`对象:
| 字段 | 类型 | 内容 | 备注 |
| ------------ | ---- | -------- | --------------------------- |
|--------------|-----|------|----------------------|
| code | num | 返回值 | 0: 有摘要<br />-1: 没有摘要 |
| model_result | obj | 摘要内容 | |
`model_result`对象:
| 字段 | 类型 | 内容 | 备注 |
| ----------- | ---- | -------------- | ----------------------------------------------------------- |
|-------------|-----|----------|------------------------------------------|
| result_type | num | 数据类型 | 0: 没有摘要或者没有时间线<br />2: 有时间线<br />(1暂不知晓) |
| summary | str | 整个视频总结 | |
| outline | obj | 时间线 | 没有时间线为None |
@ -72,14 +65,14 @@
`outline`对象:
| 字段 | 类型 | 内容 | 备注 |
| ------------ | ---- | -------- | ---- |
|--------------|-----|------|----|
| title | str | 分段标题 | |
| part_outline | obj | 分段小结 | |
`part_outline`对象:
| 字段 | 类型 | 内容 | 备注 |
| --------- | ---- | ---------- | ---- |
|-----------|-----|-------|----|
| timestamp | num | 小结时间戳 | |
| content | str | 小结内容 | |
@ -92,12 +85,39 @@ curl 'https://api.bilibili.com/x/web-interface/view/conclusion/get?bvid=BV1L94y1
--compressed
```
<details>
<summary>查看Python Demo</summary>
```python
import requests
headers = {
# 需要附带上Cookie等信息
'user-agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36',
}
params = {
'bvid': 'BV1d94y1375U',
'cid': '1334003541',
'up_mid': '407275913',
'w_rid': '5cafe844afcb813ecd129f08e6ea73b5', # 参见Wbi签名章节
'wts': '1700579155',
}
response = requests.get(
'https://api.bilibili.com/x/web-interface/view/conclusion/get',
params=params,
headers=headers,
)
```
</details>
有摘要示例:
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,
@ -188,21 +208,21 @@ curl 'https://api.bilibili.com/x/web-interface/view/conclusion/get?bvid=BV1L94y1
认证方式Cookie(SESSDATA)
限制游客访问,需要登录
鉴权方式:[Wbi 签名](../misc/sign/wbi.md)
***\*url参数:\****
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ------ | ---- | ---------- | ------ | ------------------------------------ |
|-------|-----|--------|-----|----------------------------------|
| w_rid | str | Wbi 签名 | 必要 | 详见 [Wbi 签名](../misc/sign/wbi.md) |
| wts | num | 当前时间戳 | 必要 | 详见 [Wbi 签名](../misc/sign/wbi.md) |
**正文参数( application/x-www-form-urlencoded ):**
| 参数名 | 类型 | 内容 | 必要性 | 备注 |
| ---------- | ---- | ------------------------ | ------ | --------------------------------- |
|------------|-----|----------------------|-----|-----------------------------|
| bvid | str | 稿件bvid | 必要 | |
| cid | num | 稿件cid | 必要 | |
| up_mid | num | UP主mid | 必要 | |
@ -215,7 +235,7 @@ curl 'https://api.bilibili.com/x/web-interface/view/conclusion/get?bvid=BV1L94y1
根对象:
| 字段 | 类型 | 内容 | 备注 |
| ------- | ---- | -------- | -------------------------------------------------- |
|---------|-----|------|------------------------------------------|
| code | num | 返回值 | 0: 成功 <br />-400: 请求错误<br />65006: 已赞/踩过 |
| message | str | 错误信息 | 默认为0 |
| ttl | num | 1 | |
@ -230,11 +250,46 @@ curl 'https://api.bilibili.com/x/web-interface/view/conclusion/set?w_rid=edb471f
--compressed
```
<details>
<summary>查看Python Demo</summary>
```python
import requests
headers = {
# 需要附带上Cookie等信息
'user-agent': 'Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/119.0.0.0 Safari/537.36',
}
params = {
'w_rid': 'edb471fc926646ef3889a80488166b66',
'wts': '1700358953',
}
data = {
'bvid': 'BV1L94y1H7CV',
'cid': '1335073288',
'up_mid': '297242063',
'stid': '5117037934391059183',
'like_state': '1',
'csrf': '522xxxxxxxxxxxxxxx6f4',
}
response = requests.post(
'https://api.bilibili.com/x/web-interface/view/conclusion/set',
params=params,
data=data
)
```
</details>
<details>
<summary>查看响应示例:</summary>
```json
{
"code": 0,