Membuat sebuah cerita.
Deskripsi operasi
Sebelum Anda menggunakan operasi ini, pastikan Anda familier dengan metode penagihan dan harga dari Intelligent Media Management (IMM).
Sebelum Anda memanggil operasi ini, pastikan file telah diindeks ke dalam dataset menggunakan binding (CreateBinding) atau dengan pengindeksan aktif (IndexFileMeta atau BatchIndexFileMeta).
Operasi ini bersifat asinkron. Setelah tugas mulai berjalan, informasi tugas hanya disimpan selama 7 hari dan tidak dapat diperoleh setelah 7 hari. Panggil operasi GetTask atau ListTasks untuk mengkueri informasi tugas berdasarkan TaskId yang dikembalikan. Anda juga dapat mengonfigurasi parameter Notification untuk memperoleh informasi tugas menggunakan notifikasi pesan.
Coba sekarang
Test
RAM authorization
|
Action |
Access level |
Resource type |
Condition key |
Dependent action |
|
imm:CreateStory |
create |
*Dataset
|
None | None |
Parameter permintaan
|
Parameter |
Type |
Required |
Description |
Example |
| ProjectName |
string |
Yes |
Nama proyek. Untuk informasi tentang cara memperoleh nama, lihat CreateProject. |
test-project |
| DatasetName |
string |
Yes |
Nama dataset. Untuk informasi tentang cara memperoleh nama, lihat CreateDataset. |
test-dataset |
| ObjectId |
string |
No |
ID dari objek cerita. Parameter ini bersifat opsional. Jika Anda mengosongkan parameter ini, IMM akan membuat ID untuk cerita yang dihasilkan. ID tersebut merupakan pengidentifikasi unik cerita dan dapat digunakan untuk mengkueri dan memperbarui cerita. Anda juga dapat menghasilkan ID dan meneruskannya menggunakan parameter ini. IMM mencatat ID sebagai pengidentifikasi unik cerita. Jika Anda meneruskan ID yang sudah ada, cerita yang sesuai dengan ID tersebut akan diperbarui. |
id1 |
| StoryType |
string |
Yes |
Tipe cerita. Parameter ini menentukan tipe cerita album yang akan dihasilkan. Untuk deskripsi tipe spesifik dan nilai yang tersedia, lihat Tipe dan subtipe cerita. |
PeopleMemory |
| StorySubType |
string |
No |
Subtipe cerita. Parameter ini menentukan subtipe cerita album yang akan dihasilkan. Untuk deskripsi tipe spesifik dan nilai yang tersedia, lihat Tipe dan subtipe cerita. |
Solo |
| StoryStartTime |
string |
No |
Waktu mulai koleksi foto dari mana cerita akan dibuat. Bersama dengan StoryEndTime, parameter ini mendefinisikan rentang waktu. IMM memfilter foto kandidat dalam rentang waktu ini untuk menghasilkan cerita. Nilai parameter ini berupa string dalam format waktu RFC 3339. |
2016-12-30T16:00:00Z |
| StoryEndTime |
string |
No |
Waktu akhir koleksi foto dari mana cerita akan dibuat. Bersama dengan StoryStartTime, parameter ini mendefinisikan rentang waktu. IMM memfilter foto kandidat dalam rentang waktu ini untuk menghasilkan cerita. Nilai parameter ini berupa string dalam format waktu RFC 3339. |
2021-12-30T16:00:00Z |
| StoryName |
string |
No |
Nama cerita. |
name1 |
| MinFileCount |
integer |
No |
Jumlah minimum file foto yang akan disertakan dalam cerita yang dihasilkan. Jumlah aktual foto dalam cerita yang dihasilkan berada di antara MinFileCount dan MaxFileCount. Nilai parameter ini adalah bilangan bulat yang lebih besar dari 1. Jika jumlah foto yang tersedia dalam kumpulan foto kandidat untuk cerita kurang dari nilai ini, cerita kosong akan dikembalikan. |
1 |
| MaxFileCount |
integer |
No |
Jumlah maksimum file foto yang akan disertakan dalam cerita yang dihasilkan. Jumlah aktual foto dalam cerita yang dihasilkan berada di antara MinFileCount dan MaxFileCount. Nilai parameter ini adalah bilangan bulat yang lebih besar dari MinFileCount. (Untuk memastikan kualitas cerita yang dihasilkan, algoritma secara internal membatasi jumlah maksimum hingga 1500. Parameter ini tidak berpengaruh ketika MaxFileCount lebih besar dari 1500.) |
3 |
| NotifyTopicName |
string |
No |
TopicName untuk notifikasi balik asinkron. |
test-topic |
| CustomLabels |
object |
No |
Label kustom. Label ini mencatat informasi yang ditentukan pengguna tentang cerita dan dapat digunakan untuk pengambilan. |
{"Bucket": "examplebucket"} |
| CustomId |
string |
No |
ID kustom. Pengidentifikasi yang ditentukan pengguna untuk cerita yang dihasilkan (yang mungkin berbeda dari ObjectID), yang dapat digunakan untuk pengambilan dan pengurutan cerita selanjutnya. |
test |
| Address | AddressForStory |
No |
Informasi alamat untuk cerita yang akan dihasilkan. IMM memfilter foto yang lokasi pengambilannya cocok dengan informasi alamat yang ditentukan oleh parameter ini untuk menghasilkan cerita. Parameter ini hanya berlaku ketika tipe cerita adalah TravelMemory. Catatan
Sesuai dengan peraturan yang berlaku, kemampuan untuk menerjemahkan informasi GPS di Tiongkok daratan menjadi alamat tidak dapat disediakan di Hong Kong (Tiongkok), Makau (Tiongkok), Taiwan (Tiongkok), atau di luar Tiongkok daratan. |
|
| Tags |
object |
No |
Parameter ini menyediakan mekanisme penandaan yang dapat digunakan dalam skenario berikut:
|
{"key":"val"} |
| UserData |
string |
No |
Informasi yang ditentukan pengguna yang dikembalikan dalam notifikasi pesan asinkron. Informasi ini membantu Anda mengkorelasikan notifikasi pesan dalam sistem Anda. Panjang maksimum adalah 2.048 byte. |
{"ID": "testuid","Name": "test-user","Avatar": "http://test.com/testuid"} |
| Notification | Notification |
No |
Konfigurasi notifikasi pesan. Untuk detail, klik Notification. Untuk format pesan notifikasi asinkron, lihat Format pesan notifikasi asinkron. |
Elemen respons
|
Element |
Type |
Description |
Example |
|
object |
Skema Respons |
||
| RequestId |
string |
ID permintaan untuk permintaan saat ini. |
1B3D5E0A-D8B8-4DA0-8127-ED32C851**** |
| TaskId |
string |
ID tugas. |
CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19**** |
| EventId |
string |
ID event. |
392-1CqzvESGTEeNZ2OWFbRKIM**** |
Contoh
Respons sukses
JSONformat
{
"RequestId": "1B3D5E0A-D8B8-4DA0-8127-ED32C851****",
"TaskId": "CreateStory-4ef6ff43-edf3-4612-9cc4-0c7f9e19****",
"EventId": "392-1CqzvESGTEeNZ2OWFbRKIM****"
}
Kode kesalahan
Lihat Error Codes untuk daftar lengkap.
Catatan rilis
Lihat Release Notes untuk daftar lengkap.