Skip to content

Commit 26f2049

Browse files
simon-dewsimon-dew
committed
NO ISSUE: Update workflow diagrams (#421)
* Use sequence diagrams for clearer readability * Minor wording tweaks
1 parent ca65774 commit 26f2049

File tree

4 files changed

+193
-221
lines changed

4 files changed

+193
-221
lines changed

‎modules/vector-index/pages/use-vector-indexes.adoc‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -172,7 +172,7 @@ Hyperscale Vector indexes can handle the large datasets and perform these vector
172172
=== Hyperscale Vector Index Application Workflow
173173

174174

175-
After you create a Hyperscale Vector index, your application follows the workflow shown in the following diagram:
175+
To create and use a Hyperscale Vector index, your application follows the workflow shown in the following diagram:
176176

177177
.Application Workflow with Hyperscale Vector Indexes
178178
[plantuml,hyperscale-vector-app-workflow,svg]
@@ -214,7 +214,7 @@ Vector similarity searches can be added to these searches to find similar demand
214214

215215
=== Composite Vector Index Application Workflow
216216

217-
After you create a Composite Vector index, your application follows the workflow shown in the following diagram:
217+
To create and use a Composite Vector index, your application follows the workflow shown in the following diagram:
218218

219219
.Application Workflow with Composite Vector Indexes
220220
[plantuml,composite-vector-app-workflow,svg]
@@ -263,7 +263,7 @@ Real estate applications can use Search Vector Indexes to find properties within
263263

264264
=== Search Vector Index Application Workflow
265265

266-
After you create an Search Vector Index, your application follows the workflow shown in the following diagram:
266+
To create and use an Search Vector Index, your application follows the workflow shown in the following diagram:
267267

268268
.Application Workflow with Search Vector Indexes
269269
[plantuml,fts-app-workflow,svg]

‎modules/vector-index/partials/composite-vector-app-workflow.puml‎

Lines changed: 65 additions & 76 deletions
Original file line numberDiff line numberDiff line change
@@ -1,83 +1,72 @@
11
@startuml ai-app-workflow
22

3-
!pragma layout smetana
4-
!include <material/common>
5-
!include <material/numeric_1_box>
6-
!include <material/numeric_2_box>
7-
!include <material/numeric_3_box>
8-
!include <material/numeric_4_box>
9-
!include <material/numeric_5_box>
10-
!include <material/numeric_6_box>
11-
!include <material/numeric_7_box>
12-
!include <material/numeric_8_box>
133
sprite Couchbase <svg width="98" height="98" viewBox="0 0 98 98">
144
<path fill="#EC1218"
155
d="m 82.1,57.6 c 0,2.9 -1.7,5.5 -5,6.1 -5.8,1 -17.9,1.6 -28.1,1.6 -10.2,0 -22.3,-0.7 -28.1,-1.6 -3.3,-0.6 -5,-3.2 -5,-6.1 V 38.4 c 0,-2.9 2.3,-5.7 5,-6.1 1.7,-0.3 5.6,-0.6 8.8,-0.6 1.2,0 2.2,0.9 2.2,2.3 V 47.3 C 37.8,47.3 43,47 49,47 c 6,0 11.2,0.3 17.2,0.3 V 34.1 c 0,-1.4 1,-2.3 2.2,-2.3 3.2,0 7.1,0.3 8.8,0.6 2.7,0.4 5,3.2 5,6.1 z M 49,0 C 21.9,0 0,21.9 0,49 0,76.1 21.9,98 49,98 76.1,98 98,76.1 98,49 98,21.9 76.1,0 49,0 Z" />
166
</svg>
177

18-
'title: Application Workflow with Composite Vector Indexes
19-
20-
skinparam defaultTextAlignment center
21-
22-
skinparam linetype ortho
23-
24-
top to bottom direction
25-
26-
27-
frame "Your Application" as APP {
28-
card DL [
29-
Data
30-
Loading
31-
]
32-
card EM [
33-
Embedding
34-
Models
35-
]
36-
card SE [
37-
Search & Query Logic
38-
]
39-
40-
DL --> EM : <$ma_numeric_1_box{scale=0.4}>Complex\nData
41-
EM --> DL : Vectors
42-
SE --> EM : <$ma_numeric_4_box{scale=0.4}>Complex\nData
43-
EM --> SE : Vectors
44-
45-
}
46-
47-
frame "<$Couchbase{scale=0.15}> Couchbase Cluster" as CC {
48-
database DS [
49-
<$Couchbase{scale=0.15,color=red}>
50-
..
51-
Data
52-
..
53-
Service
54-
..
55-
]
56-
rectangle " <$Couchbase{scale=0.15}> Index Service" as IS {
57-
card COMPOSITE [
58-
Composite
59-
Vector
60-
Index
61-
]
62-
}
63-
64-
rectangle "<$Couchbase{scale=0.15}> Query Service" as QS {
65-
66-
}
67-
68-
}
69-
70-
71-
DL ----> DS : <$ma_numeric_2_box{scale=0.4}> Data &\nVectors
72-
DS --> COMPOSITE : <$ma_numeric_3_box{scale=0.4}> Scalars &\nVectors
73-
74-
QS --> COMPOSITE : <$ma_numeric_6_box{scale=0.4}> Scan\nRequest
75-
76-
QS <-- COMPOSITE : <$ma_numeric_7_box{scale=0.4}> Index Scan\nResults
77-
78-
SE ----> QS : <$ma_numeric_5_box{scale=0.4}> Queries
79-
80-
QS ----> SE :<$ma_numeric_8_box{scale=0.4}> Query Results
81-
82-
83-
@enduml
8+
skinparam maxMessageSize 60
9+
skinparam roundcorner 5
10+
skinparam responseMessageBelowArrow true
11+
skinparam sequenceMessageAlign left
12+
skinparam ParticipantPadding 10
13+
skinparam Padding 2
14+
skinparam BoxPadding 20
15+
16+
box Your Application #FloralWhite
17+
queue "Data\nLoading" as Loading
18+
queue "Search &\nQuery Logic" as Logic
19+
collections "Embedding\nModels" as Models
20+
end box
21+
22+
box <$Couchbase{scale=0.15}> Couchbase Cluster #FloralWhite
23+
participant "Query\nService" as Query
24+
participant "Data\nService" as Data
25+
participant "Index\nService" as Index
26+
end box
27+
28+
group Load
29+
|||
30+
?o-> Loading
31+
activate Loading #Maroon
32+
autonumber "<b>(0)"
33+
Loading -> Models: Complex data
34+
activate Models #GoldenRod
35+
autonumber stop
36+
Models -> Loading: Vectors
37+
deactivate Models
38+
autonumber resume
39+
Loading -> Data: Data & vectors
40+
deactivate Loading
41+
activate Data #midnightblue
42+
Data -> Index: Scalars & vectors
43+
deactivate Data
44+
activate Index #deepskyblue
45+
note left of Index: Composite\nVector\nIndex
46+
end
47+
48+
group Query
49+
' blank message to align the group boxes
50+
autonumber stop
51+
Loading -[#transparent]> Loading
52+
?o-> Logic
53+
activate Logic #IndianRed
54+
autonumber resume
55+
Logic -> Models: Complex data
56+
activate Models #GoldenRod
57+
autonumber stop
58+
Models -> Logic: Vector
59+
deactivate Models
60+
autonumber resume
61+
Logic -> Query: Query
62+
activate Query #teal
63+
Query -> Index: Scan request
64+
Index -> Query: Index scan result
65+
deactivate Index
66+
Query -> Logic: Query results
67+
deactivate Query
68+
deactivate Logic
69+
|||
70+
end
71+
72+
@enduml

‎modules/vector-index/partials/fts-vector-app-workflow.puml‎

Lines changed: 60 additions & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,74 +1,67 @@
11
@startuml ai-app-workflow
22

3-
!pragma layout smetana
4-
!include <material/common>
5-
!include <material/numeric_1_box>
6-
!include <material/numeric_2_box>
7-
!include <material/numeric_3_box>
8-
!include <material/numeric_4_box>
9-
!include <material/numeric_5_box>
10-
!include <material/numeric_6_box>
11-
!include <material/numeric_7_box>
12-
!include <material/numeric_8_box>
133
sprite Couchbase <svg width="98" height="98" viewBox="0 0 98 98">
144
<path fill="#EC1218"
155
d="m 82.1,57.6 c 0,2.9 -1.7,5.5 -5,6.1 -5.8,1 -17.9,1.6 -28.1,1.6 -10.2,0 -22.3,-0.7 -28.1,-1.6 -3.3,-0.6 -5,-3.2 -5,-6.1 V 38.4 c 0,-2.9 2.3,-5.7 5,-6.1 1.7,-0.3 5.6,-0.6 8.8,-0.6 1.2,0 2.2,0.9 2.2,2.3 V 47.3 C 37.8,47.3 43,47 49,47 c 6,0 11.2,0.3 17.2,0.3 V 34.1 c 0,-1.4 1,-2.3 2.2,-2.3 3.2,0 7.1,0.3 8.8,0.6 2.7,0.4 5,3.2 5,6.1 z M 49,0 C 21.9,0 0,21.9 0,49 0,76.1 21.9,98 49,98 76.1,98 98,76.1 98,49 98,21.9 76.1,0 49,0 Z" />
166
</svg>
177

18-
'title: Application Workflow with Search Vector Indexes
19-
20-
skinparam defaultTextAlignment center
21-
22-
skinparam linetype ortho
23-
24-
top to bottom direction
25-
26-
27-
frame "Your Application" as APP {
28-
card DL [
29-
Data
30-
Loading
31-
]
32-
card EM [
33-
Embedding
34-
Models
35-
]
36-
card SE [
37-
Search & Query Logic
38-
]
39-
40-
DL --> EM : <$ma_numeric_1_box{scale=0.4}>Complex\nData
41-
EM -d-> DL : Vectors
42-
SE --> EM : <$ma_numeric_4_box{scale=0.4}>Complex\nData
43-
EM --> SE : Vectors
44-
45-
}
46-
47-
frame "<$Couchbase{scale=0.15}> Couchbase Cluster" as CC {
48-
database DS [
49-
<$Couchbase{scale=0.15,color=red}>
50-
..
51-
Data
52-
..
53-
Service
54-
..
55-
]
56-
57-
rectangle " <$Couchbase{scale=0.15}> Search Service" as SSERV {
58-
card SI [
59-
FTS Vector
60-
Index
61-
]
62-
}
63-
64-
}
65-
66-
67-
DS ----> SI : Text &\nVectors
68-
DL ----> DS : <$ma_numeric_2_box{scale=0.4}> Data &\nVectors
69-
70-
SE ----> SSERV : <$ma_numeric_5_box{scale=0.4}>Searches
71-
72-
SSERV ----> SE :<$ma_numeric_6_box{scale=0.4}> Results
73-
74-
@enduml
8+
skinparam maxMessageSize 60
9+
skinparam roundcorner 5
10+
skinparam responseMessageBelowArrow true
11+
skinparam sequenceMessageAlign left
12+
skinparam ParticipantPadding 10
13+
skinparam Padding 2
14+
skinparam BoxPadding 50
15+
16+
box Your Application #FloralWhite
17+
queue "Data\nLoading" as Loading
18+
queue "Search &\nQuery Logic" as Logic
19+
collections "Embedding\nModels" as Models
20+
end box
21+
22+
box <$Couchbase{scale=0.15}> Couchbase Cluster #FloralWhite
23+
participant "Data\nService" as Data
24+
participant "Search\nService" as Search
25+
end box
26+
27+
group Load
28+
|||
29+
?o-> Loading
30+
activate Loading #Maroon
31+
autonumber "<b>(0)"
32+
Loading -> Models: Complex data
33+
activate Models #GoldenRod
34+
autonumber stop
35+
Models -> Loading: Vectors
36+
deactivate Models
37+
autonumber resume
38+
Loading -> Data: Data & vectors
39+
deactivate Loading
40+
activate Data #midnightblue
41+
Data -> Search: Text & vectors
42+
deactivate Data
43+
activate Search #LightGreen
44+
note left of Search: Search\nVector\nIndex
45+
end
46+
47+
group Search
48+
' blank message to align the group boxes
49+
autonumber stop
50+
Loading -[#transparent]> Loading
51+
?o-> Logic
52+
activate Logic #IndianRed
53+
autonumber resume
54+
Logic -> Models: Complex data
55+
activate Models #GoldenRod
56+
autonumber stop
57+
Models -> Logic: Vector
58+
deactivate Models
59+
autonumber resume
60+
Logic -> Search: Search
61+
Search -> Logic:Results
62+
deactivate Search
63+
deactivate Logic
64+
|||
65+
end
66+
67+
@enduml

0 commit comments

Comments
 (0)