Skip to content
Draft
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/gen3-resources/developer-guide/api/gen3_ai_api.html
Original file line number Diff line number Diff line change
Expand Up @@ -421,7 +421,7 @@
</head>

<body>

<div id="redoc"><div class="sc-dxnOzf gRgPoG redoc-wrap"><div class="sc-eXHjA-d kBSkUl menu-content" style="top:0px;height:calc(100vh - 0px)"><div role="search" class="sc-kkjMEg ijJYzO"><svg class="sc-iJQrDi gtHWGb search-icon" version="1.1" viewBox="0 0 1000 1000" x="0px" xmlns="http://www.w3.org/2000/svg" y="0px"><path d="M968.2,849.4L667.3,549c83.9-136.5,66.7-317.4-51.7-435.6C477.1-25,252.5-25,113.9,113.4c-138.5,138.3-138.5,362.6,0,501C219.2,730.1,413.2,743,547.6,666.5l301.9,301.4c43.6,43.6,76.9,14.9,104.2-12.4C981,928.3,1011.8,893,968.2,849.4z M524.5,522c-88.9,88.7-233,88.7-321.8,0c-88.9-88.7-88.9-232.6,0-321.3c88.9-88.7,233-88.7,321.8,0C613.4,289.4,613.4,433.3,524.5,522z"></path></svg><input placeholder="Search..." aria-label="Search" type="text" class="sc-cMlaQv kOlXdP search-input" value=""/></div><div class="sc-kMrHXi bNwKoT scrollbar-container undefined"><ul role="menu" class="sc-imaUOy fpIsZT"><li tabindex="0" depth="1" data-item-id="tag/Embeddings" role="menuitem" aria-label="Embeddings" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc YJdNS -depth1"><span width="calc(100% - 38px)" title="Embeddings" class="sc-eIrltV jZTjzp">Embeddings</span><svg class="sc-fbJfz cNCXIL" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-imaUOy cjNZVC"><li tabindex="0" depth="2" data-item-id="tag/Embeddings/operation/get_embedding_from_collection_vectorstore_collections__collection_name__embeddings__embedding_uuid__get" role="menuitem" aria-label="Read embedding from collection" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="get" class="sc-YtoFD FLoTo operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Read embedding from collection</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Embeddings/operation/update_embedding_in_collection_vectorstore_collections__collection_name__embeddings__embedding_uuid__put" role="menuitem" aria-label="Update embedding in collection" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="put" class="sc-YtoFD FLoTo operation-type put">put</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Update embedding in collection</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Embeddings/operation/delete_embedding_vectorstore_collections__collection_name__embeddings__embedding_uuid__delete" role="menuitem" aria-label="Delete embedding from collection" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="delete" class="sc-YtoFD FLoTo operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Delete embedding from collection</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Embeddings/operation/list_embeddings_in_collection_vectorstore_collections__collection_name__embeddings_get" role="menuitem" aria-label="Read all embeddings from collection" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="get" class="sc-YtoFD FLoTo operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Read all embeddings from collection</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Embeddings/operation/create_embeddings_in_collection_vectorstore_collections__collection_name__embeddings_post" role="menuitem" aria-label="Create embeddings in collection" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="post" class="sc-YtoFD FLoTo operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Create embeddings in collection</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Embeddings-(Bulk-Read)" role="menuitem" aria-label="Embeddings (Bulk Read)" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc YJdNS -depth1"><span width="calc(100% - 38px)" title="Embeddings (Bulk Read)" class="sc-eIrltV jZTjzp">Embeddings (Bulk Read)</span><svg class="sc-fbJfz cNCXIL" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-imaUOy cjNZVC"><li tabindex="0" depth="2" data-item-id="tag/Embeddings-(Bulk-Read)/operation/get_embeddings_bulk_unknown_collections_embeddings_bulk_post" role="menuitem" aria-label="Read select embeddings from unknown collections" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="post" class="sc-YtoFD FLoTo operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Read select embeddings from unknown collections</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Embeddings-(Bulk-Read)/operation/get_embeddings_bulk_from_collection_vectorstore_collections__collection_name__embeddings_bulk_post" role="menuitem" aria-label="Read select embeddings from collection" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="post" class="sc-YtoFD FLoTo operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Read select embeddings from collection</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Vectorstore-Collections" role="menuitem" aria-label="Vectorstore Collections" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc YJdNS -depth1"><span width="calc(100% - 38px)" title="Vectorstore Collections" class="sc-eIrltV jZTjzp">Vectorstore Collections</span><svg class="sc-fbJfz cNCXIL" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-imaUOy cjNZVC"><li tabindex="0" depth="2" data-item-id="tag/Vectorstore-Collections/operation/list_collections_vectorstore_collections_get" role="menuitem" aria-label="Read all collections" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="get" class="sc-YtoFD FLoTo operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Read all collections</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Vectorstore-Collections/operation/create_collection_vectorstore_collections_post" role="menuitem" aria-label="Create collection" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="post" class="sc-YtoFD FLoTo operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Create collection</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Vectorstore-Collections/operation/get_collection_vectorstore_collections__collection_name__get" role="menuitem" aria-label="Read collection info" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="get" class="sc-YtoFD FLoTo operation-type get">get</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Read collection info</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Vectorstore-Collections/operation/update_collection_vectorstore_collections__collection_name__patch" role="menuitem" aria-label="Update collection info" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="patch" class="sc-YtoFD FLoTo operation-type patch">patch</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Update collection info</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Vectorstore-Collections/operation/delete_collection_vectorstore_collections__collection_name__delete" role="menuitem" aria-label="Delete collection" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="delete" class="sc-YtoFD FLoTo operation-type delete">del</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Delete collection</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Vectorstore-Search" role="menuitem" aria-label="Vectorstore Search" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc YJdNS -depth1"><span width="calc(100% - 38px)" title="Vectorstore Search" class="sc-eIrltV jZTjzp">Vectorstore Search</span><svg class="sc-fbJfz cNCXIL" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-imaUOy cjNZVC"><li tabindex="0" depth="2" data-item-id="tag/Vectorstore-Search/operation/search_in_collection_vectorstore_collections__collection_name__search_post" role="menuitem" aria-label="Search embeddings in collection" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="post" class="sc-YtoFD FLoTo operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Search embeddings in collection</span></label></li><li tabindex="0" depth="2" data-item-id="tag/Vectorstore-Search/operation/search_across_collections_vectorstore_search_post" role="menuitem" aria-label="Search embeddings across unknown collections" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="post" class="sc-YtoFD FLoTo operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Search embeddings across unknown collections</span></label></li></ul></li><li tabindex="0" depth="1" data-item-id="tag/Inference" role="menuitem" aria-label="Inference" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc YJdNS -depth1"><span width="calc(100% - 38px)" title="Inference" class="sc-eIrltV jZTjzp">Inference</span><svg class="sc-fbJfz cNCXIL" version="1.1" viewBox="0 0 24 24" x="0" xmlns="http://www.w3.org/2000/svg" y="0" aria-hidden="true"><polygon points="17.3 8.3 12 13.6 6.7 8.3 5.3 9.7 12 16.4 18.7 9.7 "></polygon></svg></label><ul class="sc-imaUOy cjNZVC"><li tabindex="0" depth="2" data-item-id="tag/Inference/operation/create_response_v1_responses_post" role="menuitem" aria-label="Standard Open Responses API" aria-expanded="false" class="sc-vjKnv cVgssJ"><label class="sc-bjMMwc fUjfPA -depth2"><span type="post" class="sc-YtoFD FLoTo operation-type post">post</span><span tabindex="0" width="calc(100% - 38px)" class="sc-eIrltV jZTjzp">Standard Open Responses API</span></label></li></ul></li></ul><div class="sc-hAYhfO jKUIUi"><a target="_blank" rel="noopener noreferrer" href="https://redocly.com/redoc/">API docs by Redocly</a></div></div></div><div class="sc-kVmAmQ laYfRb"><div class="sc-iqavZh dKxKge"><svg class="" style="transform:translate(2px, -4px) rotate(180deg);transition:transform 0.2s ease" viewBox="0 0 926.23699 573.74994" version="1.1" x="0px" y="0px" width="15" height="15"><g transform="translate(904.92214,-879.1482)"><path d="
m -673.67664,1221.6502 -231.2455,-231.24803 55.6165,
-55.627 c 30.5891,-30.59485 56.1806,-55.627 56.8701,-55.627 0.6894,
Expand Down