Τι είναι το Rivya API;

Το Rivya API είναι η προγραμματιστική σύμβαση για τη χρήση υποστηριζόμενων δυνατοτήτων των μοντέλων Rivya από το δικό σας προϊόν, σενάριο εντολών ή ροή εργασίας, εφόσον η δημόσια πρόσβαση API είναι ενεργοποιημένη για τη συγκεκριμένη εγκατάσταση και διατίθεται στον λογαριασμό σας.

Δεν είναι ξεχωριστό προϊόν από το Rivya Studio. Χρησιμοποιεί το ίδιο όριο λογαριασμού, το ίδιο πορτοφόλι credits και το ίδιο δημόσιο επίπεδο μοντέλων που βλέπουν οι χρήστες στο Rivya. Η διαφορά είναι πώς ξεκινά η δουλειά: αντί να κάνετε κλικ μέσα στο Studio, η εφαρμογή σας στέλνει αιτήματα με API key.

Αν χρειάζεστε λεπτομέρειες για τα τελικά σημεία, ξεκινήστε από την Επισκόπηση του Rivya API και τη Γρήγορη εκκίνηση του Rivya API. Αυτό το άρθρο εξηγεί το προϊόν: σε τι χρησιμεύει το API, πού ταιριάζει και πότε δεν πρέπει να είναι η πρώτη επιλογή.

Η σύντομη εκδοχή

Το Rivya API v1 επιτρέπει σε έναν συνδεδεμένο λογαριασμό με το απαιτούμενο δικαίωμα να δημιουργεί κλειδιά API και να καλεί μέσω API τα έτοιμα μοντέλα Rivya εκτός της διαδικτυακής διεπαφής. Οι σελίδες για προγραμματιστές περιγράφουν την υλοποιημένη σύμβαση· το αν ένα αίτημα μπορεί να εκτελεστεί καθορίζεται από την ενεργή εγκατάσταση, τα δικαιώματα του λογαριασμού και την ετοιμότητα του μοντέλου.

Η υλοποιημένη επιφάνει API περιλαμβάνει:

• ανακάλυψη μοντέλων μέσω της λίστας μοντέλων API

• ασύγχρονες εργασίες δημιουργίας εικόνας, βίντεο και ήχου

• μεταφορτώσεις μέσω του API αρχείων για μοντέλα που χρειάζονται πολυμέσα αναφοράς

• περιοδικό έλεγχο της κατάστασης δημιουργίας με δημόσια αναγνωριστικά εργασιών

• ελέγχους credits λογαριασμού

• γύρους μέσω του API συνομιλίας, συμπεριλαμβανομένης της προαιρετικής τμηματικής μετάδοσης SSE

• υπογεγραμμένα webhooks για την ολοκλήρωση εργασιών δημιουργίας, όταν τα webhooks είναι ενεργοποιημένα για την εγκατάσταση

• TypeScript SDK beta για ομάδες που θέλουν client wrapper

Η δημόσια ενότητα για προγραμματιστές βρίσκεται στη σελίδα Για προγραμματιστές. Είναι η καλύτερη αφετηρία για καθοδηγούμενη επισκόπηση, συνδέσμους προς τις ρυθμίσεις κλειδιών API και ασφαλή διαδικασία εντοπισμού σφαλμάτων.

Γιατί το Rivya έχει API

Το Studio είναι χρήσιμο όταν ένας άνθρωπος ακόμη επιλέγει μοντέλα, διαμορφώνει prompts, ελέγχει εξόδους και αποφασίζει τι να κάνει μετά.

Το API είναι χρήσιμο όταν αυτή η απόφαση έχει γίνει επαναλήψιμο προϊόν ή επιχειρησιακή ροή εργασίας.

Συνηθισμένα παραδείγματα, όταν η πρόσβαση API είναι ενεργή, είναι τα εξής:

• ένα προϊόν θέλει να δημιουργεί παραλλαγές εικόνας αφού ο χρήστης υποβάλει δημιουργική σύνοψη

• μια marketing ροή εργασίας χρειάζεται να δημιουργεί οπτικά drafts από δομημένες εισόδους καμπάνιας

• ένα εσωτερικό εργαλείο χρειάζεται να υποβάλλει εργασίες βίντεο ή ήχου χωρίς να ζητά από κάποιον να ανοίξει browser

• ένα σύστημα υποστήριξης ή περιεχομένου θέλει έναν γύρο μοντέλου chat μέσα στη δική του διεπαφή

• μια υπηρεσία παρασκηνίου χρειάζεται υπογεγραμμένες επιστροφές όταν ολοκληρώνονται οι εργασίες δημιουργίας

Σε αυτές τις περιπτώσεις, το Rivya API κρατά τη δουλειά συνδεδεμένη με τον ίδιο λογαριασμό Rivya αντί να απαιτεί ξεχωριστό stack για χρέωση, επιλογή μοντέλου και κατάσταση εργασίας.

Τι δεν αντικαθιστά το API

Το API δεν αντικαθιστά κάθε λόγο να χρησιμοποιείτε το Rivya απευθείας.

Χρησιμοποιήστε Οδηγός Rivya Studio ή τις δημόσιες επιφάνειες εργασίας όταν:

• η οδηγία χρειάζεται ακόμη ανθρώπινη διερεύνηση

• η επιλογή μοντέλου δεν είναι σταθερή

• ένας creator χρειάζεται να συγκρίνει οπτικά τις εξόδους

• το έργο εξαρτάται από αποθηκευμένο ιστορικό και χειροκίνητο έλεγχο

• η ομάδα δεν έχει αποφασίσει ποια μορφή εισόδου και εξόδου πρέπει να γίνει επαναλήψιμη

Χρησιμοποιήστε το API όταν η ροή εργασίας είναι αρκετά καθαρή ώστε να αυτοματοποιηθεί.

Αυτό το όριο έχει σημασία. Μια ασαφής δημιουργική ερώτηση συνήθως ανήκει πρώτα στο Studio. Μια γνωστή ροή προϊόντος με προβλέψιμες εισόδους μπορεί να μετακινηθεί στο API.

Τα κύρια δομικά στοιχεία

Σκεφτείτε το API ως έξι συνδεδεμένα κομμάτια.

Η τεκμηρίωση API είναι η πηγή για τα σχήματα αιτήματος και απόκρισης. Αυτό το άρθρο σας βοηθά να αποφασίσετε ποιο μέρος χρειάζεστε πρώτο.

Πώς λειτουργούν τα credits

Η χρήση API αντλεί από το ίδιο πορτοφόλι credits λογαριασμού Rivya με το Studio.

Αυτό σημαίνει ότι το API δεν λειτουργεί ως ανώνυμος διαμεσολαβητής μοντέλων. Ένα αίτημα ανήκει σε λογαριασμό Rivya, χρησιμοποιεί κλειδί API που δημιουργήθηκε από αυτόν τον λογαριασμό και ακολουθεί το ίδιο όριο credits σε επίπεδο προϊόντος που περιγράφεται στα Credits του API.

Αυτό είναι χρήσιμο για ομάδες επειδή τα πειράματα στο Studio και η χρήση API μένουν σε ένα λειτουργικό μοντέλο. Μπορείτε να δοκιμάσετε ένα μοντέλο χειροκίνητα και μετά να μετακινήσετε το επαναλήψιμο μέρος σε μια ενσωμάτωση χωρίς να δημιουργήσετε δεύτερο επίπεδο χρέωσης.

Πώς ταιριάζουν τα αρχεία

Μερικά μοντέλα μπορούν να τρέξουν μόνο από κείμενο. Άλλα χρειάζονται εικόνα, βίντεο ή αρχείο ήχου αναφοράς.

Στις ενσωματώσεις API, αυτές οι αναφορές πρέπει να περνούν από το API αρχείων. Η μεταφόρτωση δημιουργεί μια διαχειριζόμενη εγγραφή αρχείου που μπορεί να δοθεί σε υποστηριζόμενες παραμέτρους μοντέλου.

Ο πρακτικός κανόνας είναι απλός:

• αν ένα μοντέλο δέχεται μόνο είσοδο κειμένου, ξεκινήστε από το τελικό σημείο δημιουργίας

• αν ένα μοντέλο χρειάζεται reference media, ανεβάστε πρώτα το αρχείο

• αν το μοντέλο συνομιλίας δέχεται συνημμένες εικόνες, χρησιμοποιήστε το Chat API και αναγνωριστικά αρχείων

Μη σχεδιάζετε την ενσωμάτωσή σας γύρω από ροές μεταφόρτωσης αποκλειστικά μέσω προγράμματος περιήγησης ή αποθηκευμένες συνεδρίες Studio. Το API διαθέτει σκόπιμα το δικό του δημόσιο όριο αρχείων.

Πού βοηθούν τα Webhooks

Ο περιοδικός έλεγχος είναι η απλούστερη πρώτη διαδρομή ενσωμάτωσης. Υποβάλετε μια εργασία δημιουργίας, αποθηκεύστε το δημόσιο αναγνωριστικό της και ελέγχετε την κατάσταση μέχρι να πετύχει ή να αποτύχει.

Όταν τα webhooks είναι ενεργοποιημένα για την εγκατάσταση, γίνονται χρήσιμα καθώς η ενσωμάτωση πλησιάζει τις ανάγκες παραγωγής:

• δεν θέλετε μια διεργασία να ελέγχει περιοδικά κάθε εργασία

• η εφαρμογή σας πρέπει να ενημερώσει μια εγγραφή όταν ολοκληρωθεί η δημιουργία

• θέλετε υπογεγραμμένο event που μπορεί να επαναδοκιμαστεί με ασφάλεια

• οι αποτυχημένες εργασίες χρειάζεται να μπουν σε καθαρή διαδρομή ανάκτησης

Για τη σύμβαση των υπογεγραμμένων ειδοποιήσεων, συμβουλευτείτε το API για webhooks. Βεβαιωθείτε ότι η δυνατότητα διατίθεται πριν βασίσετε πάνω της τον σχεδιασμό σας. Κρατήστε τον δέκτη webhook αυστηρά περιορισμένο: επαληθεύετε τις υπογραφές, χειρίζεστε τυχόν διπλότυπες ειδοποιήσεις και μην καταγράφετε μυστικές τιμές στα αρχεία καταγραφής.

Ένα καλό πρώτο API project

Το καλύτερο πρώτο API project είναι συνήθως μικρό και συγκεκριμένο.

Για παράδειγμα:

1. επιβεβαιώστε ότι η πρόσβαση API είναι ενεργοποιημένη για την εγκατάσταση και τον λογαριασμό

2. δημιουργήστε ένα κλειδί API στις ρυθμίσεις

3. καλέστε τη λίστα μοντέλων

4. επιλέξτε ένα μοντέλο που είναι έτοιμο για χρήση μέσω API

5. υποβάλετε μία εργασία δημιουργίας με κλειδί idempotency

6. ελέγχετε το τελικό σημείο κατάστασης μέχρι να ολοκληρωθεί η εργασία

7. ελέγξτε τα credits πριν και μετά

8. μόνο τότε προσθέστε το API αρχείων, το API συνομιλίας ή τα webhooks που διαθέτει η εγκατάσταση

Αυτή η διαδρομή σάς δίνει μια λειτουργική ενσωμάτωση χωρίς να συνδυάσετε κάθε λειτουργία API στην πρώτη δοκιμή.

Πότε το API είναι λάθος σημείο εκκίνησης

Το API πιθανότατα δεν είναι το σωστό πρώτο βήμα όταν:

• η ομάδα δεν έχει επιλέξει ακόμη οικογένεια μοντέλων

• η επιθυμητή έξοδος αλλάζει σε κάθε εκτέλεση

• η οδηγία εξαρτάται από ανθρώπινη κρίση και έλεγχο

• η ενσωμάτωση θα έκρυβε τη χρήση credits από τους ανθρώπους που πρέπει να την καταλάβουν

• το προϊόν χρειάζεται δημόσια επίδειξη πριν χρειαστεί αυτοματοποίηση

Σε αυτές τις περιπτώσεις, ξεκινήστε από Εικόνα, Βίντεο, Ήχο, Συνομιλία ή Μοντέλα ΤΝ. Μόλις η διαδρομή γίνει επαναλήψιμη, μετακινήστε το σταθερό μέρος στο API.

Πού να πάτε μετά

• Ανοίξτε τη σελίδα Για προγραμματιστές για τον δημόσιο κόμβο API και τα εργαλεία εντοπισμού σφαλμάτων.

• Διαβάστε Γρήγορη εκκίνηση του Rivya API για να κάνετε το πρώτο ασφαλές αίτημα.

• Διαβάστε Πιστοποίηση API πριν βάλετε key σε server.

• Διαβάστε Μοντέλα API πριν επιλέξετε model IDs.

• Διαβάστε Πότε να χρησιμοποιήσετε το Rivya API αντί για Studio αν το όριο προϊόντος είναι ακόμη ασαφές.

• Διαβάστε Πώς να χτίσετε μια πολυτροπική AI ροή εργασίας με το Rivya API όταν σχεδιάζετε πλήρη ενσωμάτωση εικόνας, βίντεο, ήχου ή chat.