From 4b699159fe165e53ec5b3e31bb76aa125096387f Mon Sep 17 00:00:00 2001 From: Cyber MacGeddon Date: Sat, 28 Dec 2024 15:14:45 +0000 Subject: [PATCH] More API doc hacking --- docs/apis/README.md | 2 ++ docs/apis/api-agent.md | 16 ++++++++++++++++ docs/apis/api-embeddings.md | 6 ++++++ docs/apis/api-graph-embeddings.md | 5 +++++ docs/apis/api-text-completion.md | 9 +++++++++ docs/apis/api-triples-query.md | 7 +++++++ docs/apis/websocket.md | 8 +++++--- 7 files changed, 50 insertions(+), 3 deletions(-) create mode 100644 docs/apis/api-graph-embeddings.md create mode 100644 docs/apis/api-triples-query.md diff --git a/docs/apis/README.md b/docs/apis/README.md index 25e5706f..08ed9fc2 100644 --- a/docs/apis/README.md +++ b/docs/apis/README.md @@ -66,4 +66,6 @@ Cons: - [Agent](api-agent.md) - [Embeddings](api-embeddings.md) - [Text completion](api-text-completion.md) + - [Graph embeddings](api-graph-embeddings.md) + - [Triples query](api-triples-query.md) diff --git a/docs/apis/api-agent.md b/docs/apis/api-agent.md index e69de29b..318f1087 100644 --- a/docs/apis/api-agent.md +++ b/docs/apis/api-agent.md @@ -0,0 +1,16 @@ + + +{"id":"blrqotfefnmnh7de-20","service":"agent","request":{"question":"What does NASA stand for?"}} + + +{"id": "blrqotfefnmnh7de-20", "response": {"thought": "I need to query a knowledge base to find out what NASA stands for."}, "complete": fals}e + + +{"id": "blrqotfefnmnh7de-20", "response": {"observation": "Based on the provided text, NASA stands for National Aeronautics and Space Administration."}, "complete": false} + +{"id": "blrqotfefnmnh7de-20", "response": {"thought": "I now know the final answer"}, "complete": false} + + +{"id": "blrqotfefnmnh7de-20", "response": {"answer": "National Aeronautics and Space Administration"}, "complete": true} + + diff --git a/docs/apis/api-embeddings.md b/docs/apis/api-embeddings.md index e69de29b..5ad7c854 100644 --- a/docs/apis/api-embeddings.md +++ b/docs/apis/api-embeddings.md @@ -0,0 +1,6 @@ + +{"id":"qgzw1287vfjc8wsk-2","service":"embeddings","request":{"text":"What is a cat?"}} + +{"id": "qgzw1287vfjc8wsk-2", "response": {"vectors": [[0.04013510048389435, 0.07536131888628006, -0.023531345650553703, 0.07169360667467117, -0.15987688302993774, -0.02247849479317665, 0.036921221762895584, -0.006495173089206219, -0.006823638919740915, 0.014982795342803001, -0.00021319373627193272, -0.03966668248176575, -0.022481294348835945, 0.0007392769912257791, -0.051632821559906006, -0.03197932615876198, -0.08891262114048004, -0.017552362754940987, 0.018083957955241203, 0.06086970865726471, -0.03180437907576561, 0.030211158096790314, -0.015172360464930534, -0.001651781378313899, -0.06081599369645119, 0.07544258236885071, -0.09062497317790985, -0.05467168986797333, -0.03543713688850403, 0.03622836992144585, -0.04753262177109718, 0.008554691448807716, 0.008380213752388954, 0.09091988950967789, -0.07212098687887192, -0.022453175857663155, 0.05893723666667938, 0.011216984130442142, 0.023191308602690697, 0.07570113986730576, -0.07801557332277298, -0.033267609775066376, -0.024995889514684677, -0.01984870433807373, -0.012149660848081112, 0.04756436496973038, 0.004533482249826193, -0.06850800663232803, 0.013532097451388836, -0.032784946262836456, -0.03528335317969322, 0.04323350638151169, -0.0183146633207798, 0.023617954924702644, -0.0038832430727779865, -0.015820113942027092, 0.057151906192302704, -0.009665009565651417, -0.04536531865596771, -0.05837273970246315, 0.03004506789147854, 0.04164491221308708, 0.02175053209066391, 0.11539138853549957, 0.04797767847776413, -0.06830937415361404, -0.052355170249938965, 0.013177240267395973, 0.06463044136762619, -0.027940023690462112, 0.005182492546737194, 0.016695009544491768, -0.01432872749865055, 0.018590042367577553, -0.0021544245537370443, -0.08077987283468246, 0.10514851659536362, 0.03205602616071701, 0.022097686305642128, 0.05846277251839638, -0.03454869985580444, 0.04082268103957176, 0.021156569942831993, 0.048520490527153015, 0.018535558134317398, 0.03864790499210358, 0.05196112394332886, 0.0070978617295622826, -0.07184289395809174, 0.004536033142358065, 0.02251085825264454, -0.01904439367353916, 0.045005913823843, 0.011202014982700348, -0.013371487148106098, 0.010030778124928474, 0.04475017264485359, -0.06062442436814308, -0.002890509320423007, 0.07760436087846756, 0.02025887370109558, 0.041049160063266754, -0.02742611989378929, 0.050678279250860214, -0.0655527263879776, 0.009466583840548992, -0.00930122472345829, 0.014568072743713856, 0.010836872272193432, -0.03378156200051308, -0.0071929749101400375, -0.05720309168100357, -0.0992790088057518, 0.03595418110489845, 0.03866911679506302, 0.03183543682098389, 0.01110327709466219, -0.02618161402642727, 0.0805797427892685, -0.028268685564398766, 0.015721630305051804, 0.005375631619244814, -0.011987870559096336, -0.006068783812224865, -0.004822868388146162, -0.02503162994980812, -0.06896152347326279, -1.0736348265876592e-32, -0.01002321857959032, -0.09198692440986633, -0.02478376030921936, 0.007123091723769903, 0.04859595000743866, 0.03089735470712185, 0.009878083132207394, 0.021970031782984734, -0.04833487793803215, 0.03180481120944023, -0.06592850387096405, -0.023127594962716103, -0.049550611525774, -0.0046758344396948814, 0.016349339857697487, 0.036168184131383896, -0.09210298210382462, -0.0016913226572796702, 0.018020987510681152, -0.0008788371342234313, -0.009295673109591007, 0.0898309126496315, 0.076641745865345, 0.00657157227396965, 0.005858118180185556, -0.054911404848098755, -0.06994982808828354, -0.10374791920185089, -0.0011181511217728257, -0.0029994649812579155, 0.044735491275787354, 0.02245914191007614, 0.016004133969545364, -0.008467139676213264, -0.12973463535308838, -0.10952303558588028, -0.0221225805580616, -0.01803486980497837, 0.024614477530121803, 0.01597551628947258, 0.022458702325820923, -0.031143633648753166, 0.014727883972227573, -0.014183648861944675, 0.03687454015016556, -0.013304631225764751, -0.027939775958657265, 0.039632149040699005, -0.07448630779981613, 0.0594223253428936, 0.08723203837871552, -0.027432603761553764, 0.014437294565141201, -0.036766573786735535, -0.04348757117986679, 0.02485380321741104, 0.007767475675791502, -0.04333875700831413, -0.05398793891072273, 0.11653142422437668, 0.05620746314525604, 0.0887228399515152, 0.08145259320735931, 0.04152737185359001, 0.03349597379565239, -0.07056435197591782, 0.059336695820093155, 0.05255405604839325, 0.11923463642597198, 0.039216503500938416, -0.013487003743648529, 0.010224107652902603, 0.06582564115524292, -0.07667260617017746, 0.027446499094367027, 0.001621302217245102, -0.030209798365831375, 0.010380878113210201, -0.09175080806016922, 0.07554703950881958, -0.010109415277838707, -0.034664951264858246, 0.03147020563483238, 0.02115688845515251, -0.060481585562229156, 0.05468783155083656, -0.008773748762905598, -0.05361636355519295, -0.007978825829923153, 0.00572230014950037, -0.11682526767253876, 0.06883065402507782, -0.030764417722821236, -0.14327998459339142, 0.07230779528617859, 5.6908848011214466e-33, -0.016367174685001373, -0.053800489753484726, -0.08155792951583862, 0.0355428047478199, -0.06822753697633743, 0.05587393045425415, 0.023723885416984558, 0.011157003231346607, -0.0671091228723526, 0.10380274057388306, -0.11534751951694489, 0.03870617225766182, 0.09524025022983551, 0.02245240844786167, 0.06837743520736694, -0.0325048491358757, -0.04600656405091286, -0.04055331274867058, 0.05179552361369133, -0.017418596893548965, -0.05097970366477966, 0.025332072749733925, -0.08284872770309448, 0.015557038597762585, 0.035656850785017014, -0.03272348642349243, 0.03125472366809845, -0.05149391293525696, 0.02360433153808117, -0.15876996517181396, 0.059615619480609894, -0.08203703910112381, 0.004494919907301664, -0.032808996737003326, 0.004260318353772163, 0.0732288733124733, -0.009343034587800503, -0.02967223897576332, -0.042629674077034, -0.0006941657629795372, -0.03873660787940025, 0.031036261469125748, 0.015194213017821312, 0.01714945025742054, -0.04419191926717758, 0.012114227749407291, -0.021810520440340042, 0.020867394283413887, -0.0062117669731378555, -0.027158789336681366, -0.04075757786631584, -0.05810018628835678, 0.049644067883491516, -0.021247632801532745, 0.006048713345080614, -0.0021117194555699825, -0.03560175001621246, -0.024196956306695938, 0.009086968377232552, 0.07274452596902847, 0.0726727694272995, -0.02866501733660698, -0.0057212295942008495, 0.09034832566976547, -0.055303867906332016, -0.0049026235938072205, -0.04303818941116333, -0.09611721336841583, 0.005474477540701628, -0.0792737528681755, 0.14320169389247894, 0.06299078464508057, -0.02559829130768776, -0.03245342895388603, -0.02358631044626236, 0.0073517388664186, 0.05684828385710716, -0.024149468168616295, -0.008402680978178978, -0.03552231192588806, -0.021585389971733093, -0.06357058137655258, 0.0466310977935791, -0.010958082042634487, -0.003032972337678075, -0.0992724746465683, 0.04165327921509743, 0.0955067127943039, -0.0016290871426463127, 0.032724324613809586, 0.04466875270009041, 0.02519315853714943, -0.03244766592979431, -0.0492241308093071, -0.052196722477674484, -1.834578711168433e-08, -0.040055904537439346, -0.007090199273079634, -0.09829111397266388, -0.00011693347187247127, 0.031265970319509506, 0.03137103468179703, 0.05038851127028465, -0.07139569520950317, -0.03512869030237198, -0.02852826751768589, 0.0546945258975029, -0.06543896347284317, 0.023166697472333908, 0.02481601946055889, 0.06768453866243362, 0.016432179138064384, 0.02569887414574623, -0.01793815754354, 0.006611155346035957, 0.15303677320480347, -0.006307459436357021, 0.002735643647611141, -0.12014111131429672, 0.0364021472632885, 0.010833851993083954, -0.04040781781077385, 0.015318550169467926, 0.10497935861349106, 0.026550203561782837, -0.04206441715359688, -0.003290274180471897, -0.003913129214197397, 0.011123871430754662, -0.03896685317158699, -0.0005994638777337968, -0.023511582985520363, 0.05590337514877319, -0.11892222613096237, 0.051948145031929016, -0.06540261209011078, 0.031218944117426872, 0.06795408576726913, 0.06069595739245415, -0.01932346634566784, -0.06672355532646179, 0.005571332294493914, 0.004603548441082239, -0.04232778772711754, -0.0012503537582233548, 0.06553182005882263, 0.030698304995894432, 0.13682164251804352, 0.027324771508574486, 0.033644746989011765, -0.052138347178697586, -0.044384025037288666, 0.010273761115968227, -0.051625024527311325, -0.01488937996327877, 0.028671544045209885, 0.10579434782266617, 0.05284829065203667, 0.10790473222732544, 0.03591292351484299]]}, "complete": true} + + diff --git a/docs/apis/api-graph-embeddings.md b/docs/apis/api-graph-embeddings.md new file mode 100644 index 00000000..08b302aa --- /dev/null +++ b/docs/apis/api-graph-embeddings.md @@ -0,0 +1,5 @@ + +{"id":"qgzw1287vfjc8wsk-3","service":"graph-embeddings-query","request":{"vectors":[[0.04013510048389435,0.07536131888628006,-0.023531345650553703,0.07169360667467117,-0.15987688302993774,-0.02247849479317665,0.036921221762895584,-0.006495173089206219,-0.006823638919740915,0.014982795342803001,-0.00021319373627193272,-0.03966668248176575,-0.022481294348835945,0.0007392769912257791,-0.051632821559906006,-0.03197932615876198,-0.08891262114048004,-0.017552362754940987,0.018083957955241203,0.06086970865726471,-0.03180437907576561,0.030211158096790314,-0.015172360464930534,-0.001651781378313899,-0.06081599369645119,0.07544258236885071,-0.09062497317790985,-0.05467168986797333,-0.03543713688850403,0.03622836992144585,-0.04753262177109718,0.008554691448807716,0.008380213752388954,0.09091988950967789,-0.07212098687887192,-0.022453175857663155,0.05893723666667938,0.011216984130442142,0.023191308602690697,0.07570113986730576,-0.07801557332277298,-0.033267609775066376,-0.024995889514684677,-0.01984870433807373,-0.012149660848081112,0.04756436496973038,0.004533482249826193,-0.06850800663232803,0.013532097451388836,-0.032784946262836456,-0.03528335317969322,0.04323350638151169,-0.0183146633207798,0.023617954924702644,-0.0038832430727779865,-0.015820113942027092,0.057151906192302704,-0.009665009565651417,-0.04536531865596771,-0.05837273970246315,0.03004506789147854,0.04164491221308708,0.02175053209066391,0.11539138853549957,0.04797767847776413,-0.06830937415361404,-0.052355170249938965,0.013177240267395973,0.06463044136762619,-0.027940023690462112,0.005182492546737194,0.016695009544491768,-0.01432872749865055,0.018590042367577553,-0.0021544245537370443,-0.08077987283468246,0.10514851659536362,0.03205602616071701,0.022097686305642128,0.05846277251839638,-0.03454869985580444,0.04082268103957176,0.021156569942831993,0.048520490527153015,0.018535558134317398,0.03864790499210358,0.05196112394332886,0.0070978617295622826,-0.07184289395809174,0.004536033142358065,0.02251085825264454,-0.01904439367353916,0.045005913823843,0.011202014982700348,-0.013371487148106098,0.010030778124928474,0.04475017264485359,-0.06062442436814308,-0.002890509320423007,0.07760436087846756,0.02025887370109558,0.041049160063266754,-0.02742611989378929,0.050678279250860214,-0.0655527263879776,0.009466583840548992,-0.00930122472345829,0.014568072743713856,0.010836872272193432,-0.03378156200051308,-0.0071929749101400375,-0.05720309168100357,-0.0992790088057518,0.03595418110489845,0.03866911679506302,0.03183543682098389,0.01110327709466219,-0.02618161402642727,0.0805797427892685,-0.028268685564398766,0.015721630305051804,0.005375631619244814,-0.011987870559096336,-0.006068783812224865,-0.004822868388146162,-0.02503162994980812,-0.06896152347326279,-1.0736348265876592e-32,-0.01002321857959032,-0.09198692440986633,-0.02478376030921936,0.007123091723769903,0.04859595000743866,0.03089735470712185,0.009878083132207394,0.021970031782984734,-0.04833487793803215,0.03180481120944023,-0.06592850387096405,-0.023127594962716103,-0.049550611525774,-0.0046758344396948814,0.016349339857697487,0.036168184131383896,-0.09210298210382462,-0.0016913226572796702,0.018020987510681152,-0.0008788371342234313,-0.009295673109591007,0.0898309126496315,0.076641745865345,0.00657157227396965,0.005858118180185556,-0.054911404848098755,-0.06994982808828354,-0.10374791920185089,-0.0011181511217728257,-0.0029994649812579155,0.044735491275787354,0.02245914191007614,0.016004133969545364,-0.008467139676213264,-0.12973463535308838,-0.10952303558588028,-0.0221225805580616,-0.01803486980497837,0.024614477530121803,0.01597551628947258,0.022458702325820923,-0.031143633648753166,0.014727883972227573,-0.014183648861944675,0.03687454015016556,-0.013304631225764751,-0.027939775958657265,0.039632149040699005,-0.07448630779981613,0.0594223253428936,0.08723203837871552,-0.027432603761553764,0.014437294565141201,-0.036766573786735535,-0.04348757117986679,0.02485380321741104,0.007767475675791502,-0.04333875700831413,-0.05398793891072273,0.11653142422437668,0.05620746314525604,0.0887228399515152,0.08145259320735931,0.04152737185359001,0.03349597379565239,-0.07056435197591782,0.059336695820093155,0.05255405604839325,0.11923463642597198,0.039216503500938416,-0.013487003743648529,0.010224107652902603,0.06582564115524292,-0.07667260617017746,0.027446499094367027,0.001621302217245102,-0.030209798365831375,0.010380878113210201,-0.09175080806016922,0.07554703950881958,-0.010109415277838707,-0.034664951264858246,0.03147020563483238,0.02115688845515251,-0.060481585562229156,0.05468783155083656,-0.008773748762905598,-0.05361636355519295,-0.007978825829923153,0.00572230014950037,-0.11682526767253876,0.06883065402507782,-0.030764417722821236,-0.14327998459339142,0.07230779528617859,5.6908848011214466e-33,-0.016367174685001373,-0.053800489753484726,-0.08155792951583862,0.0355428047478199,-0.06822753697633743,0.05587393045425415,0.023723885416984558,0.011157003231346607,-0.0671091228723526,0.10380274057388306,-0.11534751951694489,0.03870617225766182,0.09524025022983551,0.02245240844786167,0.06837743520736694,-0.0325048491358757,-0.04600656405091286,-0.04055331274867058,0.05179552361369133,-0.017418596893548965,-0.05097970366477966,0.025332072749733925,-0.08284872770309448,0.015557038597762585,0.035656850785017014,-0.03272348642349243,0.03125472366809845,-0.05149391293525696,0.02360433153808117,-0.15876996517181396,0.059615619480609894,-0.08203703910112381,0.004494919907301664,-0.032808996737003326,0.004260318353772163,0.0732288733124733,-0.009343034587800503,-0.02967223897576332,-0.042629674077034,-0.0006941657629795372,-0.03873660787940025,0.031036261469125748,0.015194213017821312,0.01714945025742054,-0.04419191926717758,0.012114227749407291,-0.021810520440340042,0.020867394283413887,-0.0062117669731378555,-0.027158789336681366,-0.04075757786631584,-0.05810018628835678,0.049644067883491516,-0.021247632801532745,0.006048713345080614,-0.0021117194555699825,-0.03560175001621246,-0.024196956306695938,0.009086968377232552,0.07274452596902847,0.0726727694272995,-0.02866501733660698,-0.0057212295942008495,0.09034832566976547,-0.055303867906332016,-0.0049026235938072205,-0.04303818941116333,-0.09611721336841583,0.005474477540701628,-0.0792737528681755,0.14320169389247894,0.06299078464508057,-0.02559829130768776,-0.03245342895388603,-0.02358631044626236,0.0073517388664186,0.05684828385710716,-0.024149468168616295,-0.008402680978178978,-0.03552231192588806,-0.021585389971733093,-0.06357058137655258,0.0466310977935791,-0.010958082042634487,-0.003032972337678075,-0.0992724746465683,0.04165327921509743,0.0955067127943039,-0.0016290871426463127,0.032724324613809586,0.04466875270009041,0.02519315853714943,-0.03244766592979431,-0.0492241308093071,-0.052196722477674484,-1.834578711168433e-8,-0.040055904537439346,-0.007090199273079634,-0.09829111397266388,-0.00011693347187247127,0.031265970319509506,0.03137103468179703,0.05038851127028465,-0.07139569520950317,-0.03512869030237198,-0.02852826751768589,0.0546945258975029,-0.06543896347284317,0.023166697472333908,0.02481601946055889,0.06768453866243362,0.016432179138064384,0.02569887414574623,-0.01793815754354,0.006611155346035957,0.15303677320480347,-0.006307459436357021,0.002735643647611141,-0.12014111131429672,0.0364021472632885,0.010833851993083954,-0.04040781781077385,0.015318550169467926,0.10497935861349106,0.026550203561782837,-0.04206441715359688,-0.003290274180471897,-0.003913129214197397,0.011123871430754662,-0.03896685317158699,-0.0005994638777337968,-0.023511582985520363,0.05590337514877319,-0.11892222613096237,0.051948145031929016,-0.06540261209011078,0.031218944117426872,0.06795408576726913,0.06069595739245415,-0.01932346634566784,-0.06672355532646179,0.005571332294493914,0.004603548441082239,-0.04232778772711754,-0.0012503537582233548,0.06553182005882263,0.030698304995894432,0.13682164251804352,0.027324771508574486,0.033644746989011765,-0.052138347178697586,-0.044384025037288666,0.010273761115968227,-0.051625024527311325,-0.01488937996327877,0.028671544045209885,0.10579434782266617,0.05284829065203667,0.10790473222732544,0.03591292351484299]],"limit":15}} + +{"id": "qgzw1287vfjc8wsk-3", "response": {"entities": [{"v": "http://trustgraph.ai/e/space-station-modules", "e": true}, {"v": "http://trustgraph.ai/e/rocket-propellants", "e": true}, {"v": "http://trustgraph.ai/e/second-stage-craft", "e": true}, {"v": "http://trustgraph.ai/e/continue-into", "e": true}, {"v": "http://trustgraph.ai/e/cargo-bay", "e": true}, {"v": "http://trustgraph.ai/e/fly-back-to", "e": true}, {"v": "http://trustgraph.ai/e/first-stage", "e": true}, {"v": "http://trustgraph.ai/e/larger-than", "e": true}, {"v": "http://trustgraph.ai/e/crew-and-payload", "e": true}, {"v": "http://trustgraph.ai/e/orbiting-vehicle", "e": true}, {"v": "http://trustgraph.ai/e/have", "e": true}, {"v": "http://trustgraph.ai/e/orbiter", "e": true}, {"v": "http://trustgraph.ai/e/manned", "e": true}, {"v": "http://trustgraph.ai/e/two-stages", "e": true}, {"v": "http://trustgraph.ai/e/based-on", "e": true}]}, "complete": true} + diff --git a/docs/apis/api-text-completion.md b/docs/apis/api-text-completion.md index e69de29b..c4363715 100644 --- a/docs/apis/api-text-completion.md +++ b/docs/apis/api-text-completion.md @@ -0,0 +1,9 @@ + + +{"id":"blrqotfefnmnh7de-1","service":"text-completion","request":{"system":"You are a helpful agent","prompt":"What does NASA stand for?"}} + + + + +{"id": "blrqotfefnmnh7de-1", "response": {"response": "NASA stands for the National Aeronautics and Space Administration.\n"}, "complete": true} + diff --git a/docs/apis/api-triples-query.md b/docs/apis/api-triples-query.md new file mode 100644 index 00000000..faa6f7ca --- /dev/null +++ b/docs/apis/api-triples-query.md @@ -0,0 +1,7 @@ +{"id":"qgzw1287vfjc8wsk-4","service":"triples-query","request":{"s":{"v":"http://trustgraph.ai/e/space-station-modules","e":true},"p":{"v":"http://www.w3.org/2000/01/rdf-schema#label","e":true},"limit":1}} + + + +{"id": "qgzw1287vfjc8wsk-4", "response": {"response": [{"s": {"v": "http://trustgraph.ai/e/space-station-modules", "e": true}, "p": {"v": "http://www.w3.org/2000/01/rdf-schema#label", "e": true}, "o": {"v": "space station modules", "e": false}}]}, "complete": true} + + diff --git a/docs/apis/websocket.md b/docs/apis/websocket.md index 1437f9b9..c2e1415a 100644 --- a/docs/apis/websocket.md +++ b/docs/apis/websocket.md @@ -6,10 +6,11 @@ The websocket service is provided by the `api-gateway` service on port ## URL -Depending on how the service is hosted, the websocket is invoked on URL: +Depending on how the service is hosted, the websocket is invoked on this +URL on `api-gateway`: ``` -ws://api-gateway:8088/api/v1/socket +/api/v1/socket ``` When hosted using docker compose, you can access the service at @@ -22,7 +23,8 @@ A request message is a JSON message containing 3 fields: - `id`: A unique ID which is used to correlate requests and responses. You should make sure it is unique. - `service`: The name of the service to invoke. -- `request`: The request body which is passed to the service. +- `request`: The request body which is passed to the service - this is + defined in the API documentation for that service. e.g.