Ikhtisar
Konsol AgentLoop mendukung integrasi ke sistem pihak ketiga melalui penyematan. Anda dapat membuka halaman AgentSpace tertentu melalui tautan tanpa login dan menggunakan parameter URL untuk mengontrol navigasi, header halaman, entri pengalihan AgentSpace, serta status awal beberapa halaman bisnis.
Domain yang direkomendasikan untuk akses tersemat adalah:
https://agentloop4service.console.alibabacloud.comJangan mencampur domain konsol biasa dengan domain tersemat. Akses tersemat harus selalu menggunakan domain 4service yang disebutkan dalam dokumen ini untuk menghindari halaman yang tidak dapat diakses akibat ketidakkonsistenan status login.
Format URL halaman
Format URL halaman AgentSpace adalah sebagai berikut:
https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/{appPath}Deskripsi parameter:
Parameter | Deskripsi |
| Wilayah tempat AgentSpace berada, misalnya |
| Nama AgentSpace |
| Jalur halaman yang akan dibuka |
Contoh:
https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/agent-insightJalur halaman umum:
Halaman |
| Deskripsi |
Quick start |
| Membuka halaman Quick start |
Agent Insights |
| Membuka halaman analisis observabilitas Agent |
Agent comparison |
| Membuka halaman perbandingan Agent |
AI Agent Observability |
| Membuka entri utama AI Agent Observability |
Dashboard |
| Membuka halaman Dashboard |
Integration Center |
| Membuka halaman Integration Center |
Agent trajectory |
| Membuka halaman trajektori Agent |
Evaluation tasks |
| Membuka halaman tugas evaluasi |
Evaluation analysis insights |
| Membuka halaman wawasan analisis evaluasi |
Evaluator |
| Membuka halaman Evaluator |
Experiment plan |
| Membuka halaman rencana eksperimen |
Experiment record |
| Membuka halaman catatan eksperimen |
Variabel jalur {agentSpaceName} harus di-URL-encode saat alamat digabungkan.
Hasilkan tautan tanpa login
Anda dapat merujuk pada metode pembuatan tautan tanpa login Konsol Manajemen Alibaba Cloud, menggunakan halaman target AgentLoop sebagai Destination untuk menghasilkan tautan tanpa login yang dapat ditempatkan dalam iframe.
Langkah 1: Buat Tujuan
Destination adalah halaman AgentLoop yang akan dibuka pengguna setelah otentikasi tanpa login.
const destination = new URL(
'https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/evaluate-task'
);
destination.searchParams.set('hiddenSwitch', 'true');
destination.searchParams.set('hiddenBackHome', 'true');
destination.searchParams.set(
'embed',
JSON.stringify({
sidebar: 'hidden',
header: 'hidden',
eval: {
dataSource: 'trace',
serviceName: '{serviceName}',
},
})
);Langkah 2: Dapatkan kredensial sementara
Server sistem pihak ketiga memanggil STS AssumeRole untuk mendapatkan kredensial sementara. Konfigurasikan hak istimewa minimal berdasarkan cakupan pengguna, penyewa, atau resource bisnis. Token hanya dapat digunakan sekali. Untuk detailnya, lihat AssumeRole.
Parameter umum:
Parameter | Deskripsi |
| ARN dari Peran RAM yang akan diasumsikan |
| Nama sesi. Gunakan identifikasi pengguna bisnis yang dapat diaudit. |
| Periode validitas kredensial sementara |
| Opsional. Digunakan untuk membatasi lebih lanjut cakupan resource yang dapat diakses dalam sesi ini. |
Jangan menyimpan atau mengirim AccessKey jangka panjang di frontend browser.
Langkah 3: Dapatkan SigninToken
Panggil Single Sign-On (SSO) RAM untuk mendapatkan SigninToken. Format tautannya sebagai berikut. Catatan: TicketType harus diatur ke mini.
http://signin.alibabacloud.com/federation?Action=GetSigninToken
&AccessKeyId=<Temporary AK returned by STS>
&AccessKeySecret=<Temporary Secret returned by STS>
&SecurityToken=<Security Token returned by STS>
&TicketType=miniUntuk menghindari pengeksposan informasi sensitif, GetSigninToken hanya boleh dipanggil di sisi server. Jangan menggabungkan atau mengekspos kunci sementara di frontend browser.Langkah 4: Hasilkan tautan tanpa login
Tambahkan SigninToken yang dikembalikan ke tautan yang telah disiapkan untuk menghasilkan tautan akses tanpa kata sandi.
const loginUrl = new URL('https://signin.alibabacloud.com/federation');
loginUrl.searchParams.set('Action', 'Login');
loginUrl.searchParams.set('LoginUrl', 'https://{your-domain}/login-expired');
loginUrl.searchParams.set('Destination', destination.toString());
loginUrl.searchParams.set('SigninToken', signinToken);
console.log(loginUrl.toString());Format URL akhir:
http://signin.alibabacloud.com/federation?Action=Login
&LoginUrl=<Alamat untuk dialihkan saat login kedaluwarsa, biasanya dikonfigurasi sebagai URL yang melakukan pengalihan 302 di layanan web kustom Anda. Gunakan encodeURL untuk meng-encode LoginUrl.>
&Destination=<Halaman aktual yang akan diakses. Jika ada parameter, gunakan encodeURL untuk meng-encode-nya.>
&SigninToken=<Token login yang diperoleh. Gunakan encodeURL untuk meng-encode token tersebut.>Contoh iframe:
<iframe
src="{loginUrl}"
width="100%"
height="100%"
frameborder="0"
allowfullscreen
></iframe>Parameter penyematan
AgentLoop mendukung parameter URL berikut untuk mengontrol tampilan dan perilaku halaman tersemat.
embed
embed digunakan untuk meneruskan konfigurasi penyematan terstruktur sebagai string JSON. Saat ditambahkan ke URL, nilai ini harus di-URL-encode.
Bentuk yang mudah dibaca:
?embed={"sidebar":"hidden","header":"hidden","eval":{"dataSource":"trace","serviceName":"{serviceName}"}}Definisi struktur:
interface EmbedConfig {
sidebar?: 'hidden';
header?: 'hidden';
eval?: {
dataSource?: 'trace' | 'atif' | 'log' | 'dataset';
serviceName?: string;
explorer?: {
timePicker?: 'hidden';
topBar?: 'hidden';
filterSidebar?: 'hidden';
timeRange?: {
from: number;
to: number;
};
};
};
}Deskripsi parameter:
Parameter | Nilai yang mungkin | Deskripsi |
|
| Menyembunyikan seluruh area kiri AgentSpace, termasuk logo, pemilih AgentSpace, menu, dan tombol lipat. Cocok untuk skenario di mana sistem pihak ketiga menyediakan navigasinya sendiri. |
|
| Menyembunyikan header area konten AgentSpace, termasuk judul halaman, tab atas, dan area operasi di sebelah kanan. Tidak mengontrol bilah atas terluar Konsol Manajemen Alibaba Cloud. |
|
| Pratata jenis sumber data saat formulir buat tugas dibuka di halaman Evaluation tasks |
| Nama layanan | Pratata nama layanan saat formulir buat tugas dibuka di halaman Evaluation tasks |
|
| Menyembunyikan pemilih waktu di halaman Evaluation analysis insights |
|
| Menyembunyikan area pencarian, agregasi, dan log di bagian atas halaman Evaluation analysis insights |
| Number | Waktu mulai awal, timestamp Unix tingkat detik |
| Number | Waktu akhir awal, timestamp Unix tingkat detik |
timeRange.from harus lebih kecil dari timeRange.to, dan kedua nilai menggunakan timestamp Unix tingkat detik. embed.eval hanya pratata formulir buat tugas; tidak membuka formulir secara otomatis.
Contoh pembuatan:
const targetUrl = new URL(
'https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/evaluate-task'
);
targetUrl.searchParams.set(
'embed',
JSON.stringify({
sidebar: 'hidden',
eval: {
dataSource: 'trace',
serviceName: '{serviceName}',
},
})
);
console.log(targetUrl.toString());Contoh URL yang dihasilkan:
https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/evaluate-task?embed=%7B%22sidebar%22%3A%22hidden%22%2C%22eval%22%3A%7B%22dataSource%22%3A%22trace%22%2C%22serviceName%22%3A%22%7BserviceName%7D%22%7D%7DhiddenSwitch
Menyembunyikan entri pengalihan AgentSpace.
hiddenSwitch=trueJika sistem pihak ketiga telah menetapkan AgentSpace saat ini, aktifkan parameter ini untuk mencegah pengguna beralih ke ruang lain dalam halaman tersemat.
hiddenBackHome
Menyembunyikan entri "Kembali ke Beranda".
hiddenBackHome=trueJika sistem pihak ketiga ingin pengguna tetap berada di halaman AgentSpace yang ditentukan, aktifkan parameter ini untuk mencegah pengguna kembali ke halaman utama AgentLoop.
dan dievaluasi hanya berdasarkan keberadaannya. Bahkan jika nilainya false, parameter tetap berlaku selama muncul di URL. Untuk mengembalikan entri pengalihan AgentSpace atau entri halaman utama, hapus parameter yang sesuai dari URL.
Kombinasi parameter yang direkomendasikan
Sembunyikan navigasi sisi kiri
https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/agent-insight?embed=%7B%22sidebar%22%3A%22hidden%22%7DSembunyikan header halaman
https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/agent-insight?embed=%7B%22header%22%3A%22hidden%22%7DNonaktifkan pengalihan ruang dan kembali ke beranda
https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/agent-insight?hiddenSwitch=true&hiddenBackHome=true&embed=%7B%22sidebar%22%3A%22hidden%22%2C%22header%22%3A%22hidden%22%7DSembunyikan navigasi dan pratata parameter tugas evaluasi
https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/evaluate-task?hiddenSwitch=true&hiddenBackHome=true&embed=%7B%22sidebar%22%3A%22hidden%22%2C%22eval%22%3A%7B%22dataSource%22%3A%22trace%22%2C%22serviceName%22%3A%22%7BserviceName%7D%22%7D%7DSederhanakan halaman Evaluation analysis insights
Menghasilkan alamat dengan API browser standar menghindari penanganan manual JSON, spasi, dan tanda kutip:
const targetUrl = new URL(
'https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/explorer'
);
targetUrl.searchParams.set(
'embed',
JSON.stringify({
sidebar: 'hidden',
header: 'hidden',
eval: {
explorer: {
timePicker: 'hidden',
topBar: 'hidden',
filterSidebar: 'hidden',
timeRange: {
from: 1785427200,
to: 1785513600,
},
},
},
})
);
console.log(targetUrl.toString());Parameter halaman evaluasi
Selain konfigurasi embed, halaman evaluasi membaca sejumlah kecil parameter URL yang membuka formulir tertentu atau memulihkan status awal tertentu.
Buka formulir buat tugas secara otomatis
Jalur halaman:
/app/evaluate-taskDeskripsi parameter:
Parameter | Wajib | Nilai yang mungkin | Deskripsi |
| Ya |
| Membuka formulir buat tugas secara otomatis |
| Tidak |
| Pratata sumber data |
| Tidak | Nama dataset | Pratata dataset saat sumber data adalah |
Contoh:
const targetUrl = new URL(
'https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/evaluate-task'
);
targetUrl.searchParams.set('action', 'create');
targetUrl.searchParams.set('dataSource', 'dataset');
targetUrl.searchParams.set('datasetName', '{datasetName}');Setelah halaman menggunakan parameter satu kali ini, action, dataSource, dan datasetName dihapus dari bilah alamat sehingga refresh tidak memicu formulir lagi.
Buka formulir edit tugas
/app/evaluate-task?editTaskId={taskId}editTaskId juga dihapus dari bilah alamat setelah digunakan.
Buka detail tugas
Jalur halaman:
/app/evaluate-task-detailDeskripsi parameter:
Parameter | Wajib | Deskripsi |
| Wajib saat melihat, menyalin, atau mengedit tugas yang ada | ID tugas evaluasi |
| Tidak |
|
| Tidak | Alur detail saat ini mendukung |
Atur keadaan awal wawasan analisis Evaluasi
Jalur halaman:
/app/explorerDeskripsi parameter:
Parameter | Tipe | Nilai default | Deskripsi |
| String | Kosong | Pernyataan kueri awal. Harus di-URL-encode. |
| String |
| Dimensi agregasi primer awal. Nilai yang didukung: |
| String |
| Dimensi agregasi sekunder awal. Nilainya sama dengan |
Contoh:
const targetUrl = new URL(
'https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/explorer'
);
targetUrl.searchParams.set('q', 'status: success');
targetUrl.searchParams.set('groupBy', 'evaluator');Saat agregasi tidak diperlukan, abaikan groupBy dan subGroupBy atau atur nilainya ke none.
Halaman AI Agent Observability
Entri utama saat ini untuk halaman AI Agent Observability adalah:
https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/llm_agent/app-listEntri utama memilih halaman dalam urutan berikut:
Jika
traceIdditeruskan, Trace details dibuka.Jika
traceIdtidak diteruskan dantargetPage=session-explorer, Session Explorer dibuka.Dalam semua kasus lain, daftar aplikasi AI dibuka.
Buka daftar aplikasi
Saat baik traceId maupun targetPage tidak diteruskan, halaman membuka daftar aplikasi.
https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/llm_agent/app-list?hiddenSwitch=true&hiddenBackHome=trueBuka Detail Trace
https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/llm_agent/app-list?traceId={traceId}&startTime={startTime}&endTime={endTime}&hiddenSwitch=true&hiddenBackHome=trueDeskripsi parameter:
Parameter | Wajib | Deskripsi |
| Ya | ID Trace. Entri utama peka huruf besar/kecil, jadi gunakan ejaan ini. |
| Tidak | Waktu mulai kueri. Tautan dalam AgentLoop Trace saat ini menggunakan timestamp Unix tingkat milidetik. Jika tidak diteruskan, nilai default adalah satu jam sebelum waktu saat ini. |
| Tidak | Waktu akhir kueri. Tautan dalam AgentLoop Trace saat ini menggunakan timestamp Unix tingkat milidetik. Jika tidak diteruskan, nilai default adalah waktu saat ini. |
Buka Session Explorer
const targetUrl = new URL(
'https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/llm_agent/app-list'
);
targetUrl.searchParams.set('targetPage', 'session-explorer');
targetUrl.searchParams.set(
'filters',
'attributes.gen_ai.session.id: "{sessionId}"'
);
targetUrl.searchParams.set('queryTimeType', '99');
targetUrl.searchParams.set('startTime', '{startTime}');
targetUrl.searchParams.set('endTime', '{endTime}');Deskripsi parameter:
Parameter | Wajib | Deskripsi |
| Ya | Atur ke |
| Tidak | Ekspresi filter Sesi atau Trace |
| Tidak | Pernyataan kueri yang diteruskan ke halaman kueri dalam |
| Tidak | Mode waktu halaman turunan. Tautan dalam internal AgentLoop saat ini meneruskan |
| Tidak | Waktu mulai kueri. Tautan dalam Sesi AgentLoop saat ini menggunakan timestamp Unix tingkat detik. |
| Tidak | Waktu akhir kueri. Tautan dalam Sesi AgentLoop saat ini menggunakan timestamp Unix tingkat detik. |
Tautan dalam Sesi menggunakan timestamp tingkat detik sedangkan tautan dalam Trace menggunakan timestamp tingkat milidetik, jadi konversi nilai waktu sesuai dengan halaman yang Anda buka. Encode semua nama layanan, nama dataset, pernyataan kueri, dan ekspresi filter dengan URLSearchParams.
Parameter kompatibilitas entri rute komponen Trace
Saat modul dinamis yang dideploy mendaftarkan /app/llm_agent/trace-detail, entri rute komponen tersebut juga mendukung parameter berikut:
Parameter | Wajib | Deskripsi |
| Ya | ID Trace. Entri rute komponen juga menerima ejaan huruf kecil. |
| Tidak | Mendukung timestamp tingkat detik atau milidetik. |
| Tidak | Mendukung timestamp tingkat detik atau milidetik. |
| Tidak | Tentukan ID Span |
| Tidak | Tab awal di halaman Trace details |
| Tidak | Identifikasi sumber kueri Trace |
| Tidak | Identifikasi sumber halaman |
| Tidak | Kondisi filter detail Span |
| Tidak | Kondisi filter deret waktu Span |
Entri utama /app/llm_agent/app-list tidak meneruskan semua parameter lanjutan ini. Untuk entri yang stabil dan terpadu, gunakan hanya traceId, startTime, dan endTime, yang didukung oleh entri utama.
Halaman Integration Center
Jalur halaman Integration Center adalah:
https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/integratingcenterAnda dapat menggabungkan parameter tersemat sesuai kebutuhan, misalnya:
https://agentloop4service.console.alibabacloud.com/agentloop/region/{regionId}/agentspace/{agentSpaceName}/app/integratingcenter?hiddenSwitch=true&hiddenBackHome=true&embed=%7B%22sidebar%22%3A%22hidden%22%2C%22header%22%3A%22hidden%22%7DPraktik integrasi terbaik
Hasilkan tautan tanpa login di sisi server:
AssumeRole,GetSigninToken, dan URL Login akhir semuanya harus diselesaikan di sisi server. Frontend browser hanya menerima URL iframe yang dapat diakses.Selalu gunakan domain 4service:
Destinationharus menggunakanagentloop4service.console.alibabacloud.com.Tangani peng-encode-an URL dengan benar:
Destinationitu sendiri mungkin berisi parameter kueri dan harus sepenuhnya di-encode saat ditulis ke URL Login. GunakanURLdanURLSearchParamsuntuk pembuatan.Sembunyikan navigasi konsol sesuai kebutuhan: Jika sistem eksternal sudah menyediakan navigasi, gunakan kombinasi
embed={"sidebar":"hidden","header":"hidden"},hiddenSwitch=true, danhiddenBackHome=true.Kontrol masa berlaku tautan tanpa login: Refresh tautan tanpa login sebelum
SigninTokenkedaluwarsa untuk mencegah halaman dalam iframe menjadi tidak dapat diakses akibat status login yang kedaluwarsa.Otorisasi hak istimewa minimal: Izin peran RAM harus dibatasi pada resource AgentLoop, logging, dan observabilitas yang diperlukan sesuai kebutuhan bisnis.
Aturan penguraian dan kompatibilitas parameter
embedharus berupa JSON yang valid. Jika penguraian gagal, seluruh konfigurasiembeddiabaikan.embedhanya diurai sekali selama siklus hidup halaman saat ini. Muat ulang halaman setelah parameter diubah.Bidang
embedyang tidak dikenali tidak berpengaruh.Parameter URL hanya mengontrol tampilan dan status awal. Parameter ini tidak menyediakan kontrol akses, dan menyembunyikan menu atau header tidak menggantikan verifikasi izin RAM, AgentSpace, atau data.
Encode semua input pengguna, nama layanan, nama dataset, pernyataan kueri, dan ekspresi filter dengan
URLSearchParams.Parameter kueri dan bidang waktu proses yang tidak tercantum dalam dokumen ini bukan bagian dari protokol integrasi publik. Jangan menggabungkannya sendiri dan jangan menambahkannya ke dokumentasi online.
FAQ
Masalah | Pemecahan Masalah |
Tidak login ditampilkan di iframe | Konfirmasi bahwa |
Tidak memiliki izin ditampilkan di iframe | Konfirmasi bahwa izin peran RAM mencakup AgentSpace target dan resource terkaitnya. |
Pengguna dapat mengalihkan AgentSpace | Tambahkan |
Pengguna dapat kembali ke halaman utama AgentLoop | Tambahkan |
Navigasi sisi kiri masih ditampilkan | Konfirmasi bahwa |
Header halaman masih ditampilkan | Konfirmasi bahwa |
Entri pengalihan masih disembunyikan setelah diteruskan | Parameter ini dievaluasi berdasarkan keberadaannya. Hapus dari URL untuk mengembalikan entri tersebut. |
Formulir buat tugas tidak terbuka secara otomatis | Gunakan |
Nama layanan tidak di-pratata saat membuat tugas evaluasi | Konfirmasi bahwa halaman |
Sesi tidak dibuka di halaman AI Agent | Gunakan entri saat ini |
Halaman tidak berubah setelah | Konfigurasi hanya diurai sekali. Muat ulang halaman setelah URL diubah. |