bge-reranker-v2-m3
BAAIs flerspråklige kryssenkoder for rangering av kandidatavsnitt opp mot en spørring. Den leser hvert spørring–avsnitt-par samlet og returnerer en relevansskår som forbedrer et kort utvalg av søkeresultater, uten å generere et svar eller lage dokumentinnbygginger.
Om modellen
Denne beskrivelsen dekker modellens funksjoner. Tilgjengelige inndata, utdata og alternativer i Ailoot er oppført nedenfor for den valgte metoden.
BGE Reranker v2 M3 er en flerspråklig relevansmodell bygget på BGE-M3. Den mottar en spørring og et kandidatavsnitt samlet og returnerer en skår for forholdet mellom dem. BAAI posisjonerer denne utgaven som en effektiv flerspråklig omrangeringsmodell, blant annet for gjenfinning på kinesisk og engelsk, når en søkeapplikasjon trenger å forbedre en eksisterende kandidatliste.
Relevans fra et spørring–avsnitt-par
En kryssenkoder behandler begge tekstene samlet, slik at innholdet deres kan samvirke før relevansskåren produseres. Dette skiller seg fra en innbyggingsmodell, som koder tekster uavhengig for gjenbrukbar vektorsammenligning. Omrangeringsmodellens utdata er en skalar skår for et bestemt par, fremfor en dokumentvektor eller et skriftlig svar.
Bruk modellen etter at et innledende søk har valgt ut aktuelle avsnitt. Koble spørsmålet med hver kandidat, og sorter kandidatene etter skårene som returneres. Dette retter den mer detaljerte sammenligningen mot et håndterbart kort utvalg fremfor å be en kryssenkoder undersøke hvert avsnitt i en stor samling.
v2 M3-utgaven
Produsenten oppgir BGE-M3 som basismodell og flerspråklig støtte som en hovedfunksjon. Innenfor v2-familien av omrangeringsmodeller er M3 det effektive flerspråklige alternativet; de Gemma-baserte variantene og variantene med valg av lag er egne modeller med andre implementeringsvalg. Navnet M3 betyr her ikke at omrangeringsmodellen returnerer de tette, sparsomme og flervektorbaserte innbyggingene fra den opprinnelige innbyggingsmodellen.
Denne forskjellen er viktig når du velger resultatet applikasjonen trenger. Velg en innbyggingsmodell for å representere og søke i en dokumentsamling. Velg denne omrangeringsmodellen når du allerede har kandidattekst og må avgjøre hvilket avsnitt som er mest relevant for den aktuelle spørringen.
Klargjøre kandidater som kan rangeres på en nyttig måte
Oppgi det faktiske spørsmålet og hele kandidatteksten som trengs for å tolke den. Behold overskrifter eller definisjoner i nærheten når de avgjør betydningen av et avsnitt. I det publiserte Transformers-eksemplet tokeniseres spørringen og avsnittet sammen med avkorting og max_length=512. Dette er en eksempelinnstilling, ikke en grense for hele modellen. Hold spørsmålet og det nødvendige belegget innenfor det valgte parbudsjettet, og kontroller hva avkortingen fjerner. Et resultat som nevner det samme produktet som en spørring, kan likevel være irrelevant hvis det gjelder feil operasjon eller betingelse; klargjør eksempler som skiller disse tilfellene når du evaluerer kvaliteten på gjenfinningen.
For en dokumentassistent bør du beholde kandidatidentifikatorene sammen med teksten, skåre spørsmål–avsnitt-parene og sende de valgte originalavsnittene videre til svartrinnet. Svarmodellen mottar da belegget fremfor en relevansskår uten kilden. Dette er en illustrerende arbeidsflyt for gjenfinning; omrangeringsmodellen selv verken søker i en ekstern samling eller skriver svaret.
Lese og normalisere skårer
Produsenten returnerer rå relevansskårer, der en høyere verdi angir et nærmere samsvar. Den dokumenterte valgfrie normaliseringen bruker en sigmoidfunksjon for å plassere skåren mellom 0 og 1. En normalisert skår har et praktisk verdiområde, men denne transformasjonen alene fastslår ikke en kalibrert sannsynlighet for at kandidaten er korrekt.
Velg terskler for rangering eller filtrering ved hjelp av representative spørring–avsnitt-par fra arbeidsmengden din. Ta med avsnitt som deler nøkkelord, men svarer på et annet spørsmål, samt relevante avsnitt med en annen ordlyd. Dette gjør den valgte terskelen meningsfull for samlingen det søkes i.
For et Ailoot API-prosjekt bør du definere hva sluttkonteksten skal inneholde, og hvor mange kandidater som kan undersøkes effektivt. Det nyttige resultatet er et bedre sortert sett med belegg til applikasjonens neste trinn. Hold relevansutdataene fra denne utgaven atskilt fra dokumentinnbygginger, generert prosa og kontrollene for lagvalg som er dokumentert for andre omrangeringsmodeller.
Ailoot Ultra · Omrangering POST /v1/rerank bge-reranker-v2-m3
bge-reranker-v2-m3Start
BAAIs flerspråklige kryssenkoder for rangering av kandidatavsnitt opp mot en spørring. Den leser hvert spørring–avsnitt-par samlet og returnerer en relevansskår som forbedrer et kort utvalg av søkeresultater, uten å generere et svar eller lage dokumentinnbygginger.
- Godkjente inndata
- Tekst
- Resultater
- Rangerte resultater
Tilgjengelig i Ailoot · inndata & metoder
Ailoot Ultra · Omrangering POST /v1/rerank
- Inndatatyper
text- Utdatatyper
rerank
| Felt | Type | Krav | Verdier & grenser | Standard |
|---|---|---|---|---|
Feltmodel | Typestring | KravPåkrevd | Verdier & grenser bge-reranker-v2-m3 | Standard— |
Feltquery | Typestring | KravValgfritt | Verdier & grenser | Standard— |
Feltdocuments | Typearray | KravPåkrevd | Verdier & grenser | Standard— |
Metodeparametere og livssyklus
| Parameter | Avtale |
|---|---|
Parametercontent_type | Avtaleapplication/json |
Parameterrequired | Avtalemodel, documents |
Parametermaterial_types | Avtaletext |
Parametermaterial_conditions | AvtaleAngi den faktiske spørringen din og en matrise med minst ett opprinnelig tekstdokument. Resultatindeksene viser til denne opprinnelige matrisen. |
Livssyklus: synchronous_result_then_owned_library
GET /v1/media/assets/{asset_id}/content
GET /v1/media/assets
GET /v1/media/assets/{asset_id}
Priser
Tariffopplysninger legger ikke til forespørselsvalg. Støttede parametere står ved den valgte metoden.
- Hurtigmodus
- Ikke angitt Når hurtigmodus er valgt
- Flex-modus
- Ikke angitt Når flex-modus er valgt
- Maksimal resonneringsinnsats
- Ikke angitt Når justeringen «default» brukes for maksimal resonneringsinnsats
Ailoot-satser
Priser etter konfigurasjon
Knytt hver kostnad til de viste vilkårene. Bruk én sats for hvert sett med alternative konfigurasjoner.
| Konfigurasjon | Prisplan | Faktureringsenhet | Kostnad |
|---|---|---|---|
| KonfigurasjonGrunnpriser for tokener | PrisplanGrunnsats | Faktureringsenhet— | Kostnad Inndata · Inngående tokener — / 1K tokener Utdata · Utgående tokener — / 1K tokener Inndata · Lesing fra hurtigbuffer — / 1K tokener Inndata · Skriving til hurtigbuffer — / 1K tokener Inndata · Skriving til hurtigbuffer, 1 time — / 1K tokener |
| Konfigurasjontoken totalt | Prisplan— | Faktureringsenhet/ 1K tokener | Kostnad Inndata · token totalt $0.00004 / 1K tokener |
Ailoot reserverer et estimert beløp før en forespørsel. Etter resultatet gjøres det endelige beløpet opp basert på målt forbruk. Oppgjør for strømming bruker den endelige forbruksposten. Slik fungerer reservasjon og oppgjør →
Eksempelforespørsler
Ailoot Ultra · Omrangering
set -eu
: "${AILOOT_API_KEY:?Set your Ailoot API key}"
: "${AILOOT_QUERY:?Set the actual documented input value}"
export AILOOT_QUERY
: "${AILOOT_DOCUMENTS_JSON:?Set the actual documented input value}"
export AILOOT_DOCUMENTS_JSON
python3 - <<'PY_REQUEST'
import json,os
from pathlib import Path
request={'model': 'bge-reranker-v2-m3', 'query': '${ACTUAL_QUERY}', 'documents': '${ACTUAL_DOCUMENTS}'}
request['query']=os.environ['AILOOT_QUERY']
request['documents']=json.loads(os.environ['AILOOT_DOCUMENTS_JSON'])
Path('request.json').write_text(json.dumps(request,ensure_ascii=False),encoding='utf-8')
PY_REQUEST
curl --fail-with-body --silent --show-error https://api.ailoot.ai/v1/rerank \
-H "Authorization: Bearer $AILOOT_API_KEY" -H 'Content-Type: application/json' \
--data-binary @request.json -D response-headers.txt -o response.bin
# Retain the complete response and headers, every actual output, original returned identifiers and all usage fields. Recover the original operation without submitting creation again.
Motta og lagre resultater
Ailoot Ultra · Omrangering
Hele det opprinnelige JSON-resultatet i sitt opprinnelige format med den konfigurerte svarmodellen, opprinnelige dokumentindekser, relevansverdier, dokumentstrenger og tokenforbruk i opprinnelig format. Behold alle faktiske resultat- og forbruksfelt.
GET /v1/media/assets/{asset_id}/contentGET /v1/media/assetsGET /v1/media/assets/{asset_id}
Behold alle ferdige resultater
Behold alle fullstendige returnerte svar, filer og innholdsdeler.
Bevar hele svaret og svarhodene, alle faktiske utdata, de opprinnelige returnerte identifikatorene og alle bruksfeltene. Hent den opprinnelige operasjonen igjen uten å sende opprettelsesforespørselen på nytt.
Hvis det opprinnelige svaret må kontrolleres
Behold den faktiske X-Client-Request-ID og hele svaret. Les de opprinnelige ressursene du eier, og deres eksakte signerte innholdsadresser; send aldri en usikker opprettelse på nytt.
Svarfelter
| Felt | Type | Betydning |
|---|---|---|
Feltmodel | Typestring | BetydningEksakt svarmodell som kreves av den konfigurerte svarmottakeren i kildekoden. |
Feltresults[].index | Typeinteger | BetydningUnik indeks for det opprinnelige inndatadokumentet. |
Feltresults[].relevance_score | Typenumber | BetydningRelevansverdi som er et endelig tall. |
Feltresults[].document | Typestring | BetydningOpprinnelig tekstdokument som kreves av denne konfigurerte svarmottakeren. |
Feltusage.total_tokens | Typeinteger | BetydningEndelig, ikke-negativt tokenantall i det opprinnelige formatet som kreves av den gjeldende godtatte tariffen. |
Feil og neste trinn
| Svar | Vilkår | Neste trinn |
|---|---|---|
Svar400 · invalid_request_error | VilkårJSON-kroppen eller den eksplisitte kanoniske modell-ID-en er ugyldig. | Neste trinnBehold svaret og korriger det angitte forespørselsfeltet. |
Svar401 · authentication_error | VilkårAiloot API-nøkkelen er ugyldig. | Neste trinnBruk den autoriserte Ailoot API-nøkkelen din. |
Svar403 · permission_error | VilkårNøkkelgruppen gir ikke tilgang til denne metoden. | Neste trinnBehold de returnerte feildetaljene. |
Svar404 · not_found_error | VilkårDen valgte metoden har ingen godkjent rute. | Neste trinnBehold de returnerte feildetaljene. |
Svar422 · price_unavailable | VilkårDen godtatte tariffen kan ikke hente den nødvendige inndatamengden eller grensen. | Neste trinnBehold svaret; bruk inndatarepresentasjonen som den godtatte tariffen krever. |
Svar503 · | VilkårNødvendig lagring, rute, metodepris eller reservasjon er utilgjengelig. | Neste trinnBehold hele det opprinnelige svaret. En usikker reservasjon gir ikke tillatelse til å sende inn på nytt. |
Svar502 · billing_requires_check | VilkårDet opprinnelige resultatet, forbruket eller oppgjøret må kontrolleres. | Neste trinnBehold den faktiske forespørsels-ID-en og det opprinnelige svaret. Les den eksisterende oppføringen du eier; ikke send opprettelsen på nytt. |
Aliaser
Modellaliaser
Ailoot Ultra bge-reranker-v2-m3
Aliaser for metodestier
Bruk metodestiene som vises ovenfor.
Tilknyttede anroper-ID-er
FAQ · bge-reranker-v2-m3
- Hvilke inndata og resultater er tilgjengelige?
POST /v1/rerank·bge-reranker-v2-m3:text→rerank- Hvilke felt bruker forespørselen?
POST /v1/rerank·bge-reranker-v2-m3:model,query,documents