Skip to content

Commit 606f97a

Browse files
committed
add beta label and cleanup ref doc
1 parent 410e7fd commit 606f97a

4 files changed

Lines changed: 264 additions & 239 deletions

File tree

handwritten/firestore/dev/src/pipelines/expression.ts

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3459,7 +3459,7 @@ export class Field
34593459
return new FunctionExpression('geo_distance', [
34603460
this,
34613461
valueToDefaultExpr(location),
3462-
]).asBoolean();
3462+
]);
34633463
}
34643464

34653465
/**
@@ -10415,6 +10415,7 @@ export function isType(
1041510415
}
1041610416

1041710417
// /**
10418+
// * @beta
1041810419
// * Perform a full-text search on the specified field.
1041910420
// *
1042010421
// * @remarks This Expression can only be used within a `Search` stage.
@@ -10430,6 +10431,8 @@ export function isType(
1043010431
// }
1043110432

1043210433
/**
10434+
* @beta
10435+
*
1043310436
* Perform a full-text search on the document.
1043410437
*
1043510438
* @remarks This Expression can only be used within a `Search` stage.
@@ -10445,15 +10448,17 @@ export function documentMatches(
1044510448
}
1044610449

1044710450
/**
10451+
* @beta
10452+
*
1044810453
* Evaluates to the search score that reflects the topicality of the document
1044910454
* to all the text predicates (for example: `documentMatches`)
1045010455
* in the search query. If `SearchOptions.query` is not set or does not contain
10451-
* any text predicates, then this topicality score will always be `0`.
10456+
* any text predicates, then this score will always be `0`.
1045210457
*
1045310458
* @remarks This Expression can only be used within a `Search` stage.
1045410459
*/
1045510460
export function score(): Expression {
10456-
return new FunctionExpression('score', []).asBoolean();
10461+
return new FunctionExpression('score', []);
1045710462
}
1045810463

1045910464
// /**
@@ -10493,6 +10498,8 @@ export function score(): Expression {
1049310498
// }
1049410499

1049510500
/**
10501+
* @beta
10502+
*
1049610503
* Evaluates to the distance in meters between the location in the specified
1049710504
* field and the query location.
1049810505
*

handwritten/firestore/dev/src/pipelines/pipelines.ts

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1425,6 +1425,8 @@ export class Pipeline implements firestore.Pipelines.Pipeline {
14251425
}
14261426

14271427
/**
1428+
* @beta
1429+
*
14281430
* Add a search stage to the Pipeline.
14291431
*
14301432
* @remarks This must be the first stage of the pipeline.

0 commit comments

Comments
 (0)