Skip to content

Commit 83fff6c

Browse files
committed
feat: update query fan out docs
1 parent 7df770d commit 83fff6c

File tree

1 file changed

+16
-14
lines changed

1 file changed

+16
-14
lines changed

api/ai_visibility_audits.yaml

Lines changed: 16 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ paths:
2424
content:
2525
application/json:
2626
schema:
27-
"$ref": "#/components/schemas/AnalyzeURLRequest"
27+
"$ref": "#/components/schemas/AnalyzeContentRequest"
2828
responses:
2929
'200':
3030
description: Successful Response
@@ -42,9 +42,6 @@ components:
4242
schemas:
4343
AIVisibilityAnalysisResult:
4444
properties:
45-
url:
46-
type: string
47-
title: Url
4845
num_queries_requested:
4946
type: integer
5047
title: Num Queries Requested
@@ -77,7 +74,6 @@ components:
7774
readOnly: true
7875
type: object
7976
required:
80-
- url
8177
- num_queries_requested
8278
- coverage_threshold
8379
- entity_name
@@ -88,15 +84,23 @@ components:
8884
- content_chunks_count
8985
- coverage_score
9086
title: AIVisibilityAnalysisResult
91-
AnalyzeURLRequest:
87+
AnalyzeContentRequest:
9288
properties:
9389
url:
94-
type: string
95-
maxLength: 2083
96-
minLength: 1
97-
format: uri
90+
anyOf:
91+
- type: string
92+
maxLength: 2083
93+
minLength: 1
94+
format: uri
95+
- type: 'null'
9896
title: Url
99-
description: The URL to analyze
97+
description: URL to analyze
98+
text:
99+
anyOf:
100+
- type: string
101+
- type: 'null'
102+
title: Text
103+
description: Raw text to analyze
100104
num_queries:
101105
type: integer
102106
maximum: 20
@@ -112,9 +116,7 @@ components:
112116
description: The threshold for answering synthetic queries
113117
default: 0.65
114118
type: object
115-
required:
116-
- url
117-
title: AnalyzeURLRequest
119+
title: AnalyzeContentRequest
118120
HTTPValidationError:
119121
properties:
120122
detail:

0 commit comments

Comments
 (0)