Skip to content
Merged
Show file tree
Hide file tree
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 .librarian/state.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3500,7 +3500,7 @@ libraries:
tag_format: '{id}-v{version}'
- id: google-cloud-vectorsearch
version: 0.1.0
last_generated_commit: 9fcfbea0aa5b50fa22e190faceb073d74504172b
last_generated_commit: ded7ed1e4cce7c165c56a417572cebea9bc1d82c
apis:
- path: google/cloud/vectorsearch/v1beta
service_config: vectorsearch_v1beta.yaml
Expand Down
2 changes: 1 addition & 1 deletion packages/google-cloud-vectorsearch/.repo-metadata.json
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
"name": "google-cloud-vectorsearch",
"name_pretty": "Vector Search API",
"api_description": "The Vector Search API provides a fully-managed, highly performant, and\nscalable vector database designed to power next-generation search,\nrecommendation, and generative AI applications. It allows you to store,\nindex, and query your data and its corresponding vector embeddings through\na simple, intuitive interface. With Vector Search, you can define custom\nschemas for your data, insert objects with associated metadata,\nautomatically generate embeddings from your data, and perform fast\napproximate nearest neighbor (ANN) searches to find semantically similar\nitems at scale.",
"product_documentation": "https://docs.cloud.google.com/vertex-ai/docs/vector-search/overview",
"product_documentation": "https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview",
"client_documentation": "https://cloud.google.com/python/docs/reference/google-cloud-vectorsearch/latest",
"issue_tracker": "https://issuetracker.google.com/issues/new?component=1899904",
"release_level": "preview",
Expand Down
8 changes: 4 additions & 4 deletions packages/google-cloud-vectorsearch/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ items at scale.
:target: https://pypi.org/project/google-cloud-vectorsearch/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-vectorsearch.svg
:target: https://pypi.org/project/google-cloud-vectorsearch/
.. _Vector Search API: https://docs.cloud.google.com/vertex-ai/docs/vector-search/overview
.. _Vector Search API: https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview
.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/google-cloud-vectorsearch/latest/summary_overview
.. _Product Documentation: https://docs.cloud.google.com/vertex-ai/docs/vector-search/overview
.. _Product Documentation: https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview

Quick Start
-----------
Expand All @@ -38,7 +38,7 @@ In order to use this library, you first need to go through the following steps:

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Vector Search API.: https://docs.cloud.google.com/vertex-ai/docs/vector-search/overview
.. _Enable the Vector Search API.: https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview
.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
Expand Down Expand Up @@ -112,7 +112,7 @@ Next Steps
- View this `README`_ to see the full list of Cloud
APIs that we cover.

.. _Vector Search API Product documentation: https://docs.cloud.google.com/vertex-ai/docs/vector-search/overview
.. _Vector Search API Product documentation: https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst

Logging
Expand Down
8 changes: 4 additions & 4 deletions packages/google-cloud-vectorsearch/docs/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@ items at scale.
:target: https://pypi.org/project/google-cloud-vectorsearch/
.. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-vectorsearch.svg
:target: https://pypi.org/project/google-cloud-vectorsearch/
.. _Vector Search API: https://docs.cloud.google.com/vertex-ai/docs/vector-search/overview
.. _Vector Search API: https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview
.. _Client Library Documentation: https://cloud.google.com/python/docs/reference/google-cloud-vectorsearch/latest/summary_overview
.. _Product Documentation: https://docs.cloud.google.com/vertex-ai/docs/vector-search/overview
.. _Product Documentation: https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview

Quick Start
-----------
Expand All @@ -38,7 +38,7 @@ In order to use this library, you first need to go through the following steps:

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project
.. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
.. _Enable the Vector Search API.: https://docs.cloud.google.com/vertex-ai/docs/vector-search/overview
.. _Enable the Vector Search API.: https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview
.. _Set up Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation
Expand Down Expand Up @@ -112,7 +112,7 @@ Next Steps
- View this `README`_ to see the full list of Cloud
APIs that we cover.

.. _Vector Search API Product documentation: https://docs.cloud.google.com/vertex-ai/docs/vector-search/overview
.. _Vector Search API Product documentation: https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst

Logging
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -607,9 +607,11 @@ async def sample_create_collection():
on the ``request`` instance; if ``request`` is provided, this
should not be set.
collection_id (:class:`str`):
Required. Id of the requesting object If auto-generating
Id server-side, remove this field and collection_id from
the method_signature of Create RPC
Required. ID of the Collection to create. The id must be
1-63 characters long, and comply with RFC1035.
Specifically, it must be 1-63 characters long and match
the regular expression
``[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?``.

This corresponds to the ``collection_id`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -1275,9 +1277,10 @@ async def sample_create_index():
on the ``request`` instance; if ``request`` is provided, this
should not be set.
index_id (:class:`str`):
Required. Id of the requesting object If auto-generating
Id server-side, remove this field and index_id from the
method_signature of Create RPC
Required. ID of the Index to create. The id must be 1-63
characters long, and comply with RFC1035. Specifically,
it must be 1-63 characters long and match the regular
expression ``[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?``.

This corresponds to the ``index_id`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1047,9 +1047,11 @@ def sample_create_collection():
on the ``request`` instance; if ``request`` is provided, this
should not be set.
collection_id (str):
Required. Id of the requesting object If auto-generating
Id server-side, remove this field and collection_id from
the method_signature of Create RPC
Required. ID of the Collection to create. The id must be
1-63 characters long, and comply with RFC1035.
Specifically, it must be 1-63 characters long and match
the regular expression
``[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?``.

This corresponds to the ``collection_id`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down Expand Up @@ -1700,9 +1702,10 @@ def sample_create_index():
on the ``request`` instance; if ``request`` is provided, this
should not be set.
index_id (str):
Required. Id of the requesting object If auto-generating
Id server-side, remove this field and index_id from the
method_signature of Create RPC
Required. ID of the Index to create. The id must be 1-63
characters long, and comply with RFC1035. Specifically,
it must be 1-63 characters long and match the regular
expression ``[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?``.

This corresponds to the ``index_id`` field
on the ``request`` instance; if ``request`` is provided, this
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,10 @@ class Search(proto.Message):
semantic_search (google.cloud.vectorsearch_v1beta.types.SemanticSearch):
A semantic search.

This field is a member of `oneof`_ ``search_type``.
text_search (google.cloud.vectorsearch_v1beta.types.TextSearch):
A text search operation.

This field is a member of `oneof`_ ``search_type``.
"""

Expand All @@ -180,6 +184,12 @@ class Search(proto.Message):
oneof="search_type",
message="SemanticSearch",
)
text_search: "TextSearch" = proto.Field(
proto.MESSAGE,
number=3,
oneof="search_type",
message="TextSearch",
)


class VectorSearch(proto.Message):
Expand Down Expand Up @@ -286,6 +296,10 @@ class SemanticSearch(proto.Message):
output_fields (google.cloud.vectorsearch_v1beta.types.OutputFields):
Optional. The fields to return in the search
results.
filter (google.protobuf.struct_pb2.Struct):
Optional. A JSON filter expression, e.g.
{"genre": {"$eq": "sci-fi"}}, represented as a
google.protobuf.Struct.
top_k (int):
Optional. The number of data objects to
return.
Expand All @@ -311,6 +325,11 @@ class SemanticSearch(proto.Message):
number=3,
message="OutputFields",
)
filter: struct_pb2.Struct = proto.Field(
proto.MESSAGE,
number=6,
message=struct_pb2.Struct,
)
top_k: int = proto.Field(
proto.INT32,
number=4,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,12 @@ class Collection(proto.Message):
vector_schema (MutableMapping[str, google.cloud.vectorsearch_v1beta.types.VectorField]):
Optional. Schema for vector fields. Only
vector fields in this schema will be searchable.
Field names must contain only alphanumeric
characters, underscores, and hyphens.
data_schema (google.protobuf.struct_pb2.Struct):
Optional. JSON Schema for data.
Field names must contain only alphanumeric
characters, underscores, and hyphens.
"""

name: str = proto.Field(
Expand Down Expand Up @@ -285,9 +289,10 @@ class CreateCollectionRequest(proto.Message):
parent (str):
Required. Value for parent.
collection_id (str):
Required. Id of the requesting object If auto-generating Id
server-side, remove this field and collection_id from the
method_signature of Create RPC
Required. ID of the Collection to create. The id must be
1-63 characters long, and comply with RFC1035. Specifically,
it must be 1-63 characters long and match the regular
expression ``[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?``.
collection (google.cloud.vectorsearch_v1beta.types.Collection):
Required. The resource being created
request_id (str):
Expand Down Expand Up @@ -520,9 +525,10 @@ class CreateIndexRequest(proto.Message):
create the Index. Format:
``projects/{project}/locations/{location}/collections/{collection}``
index_id (str):
Required. Id of the requesting object If auto-generating Id
server-side, remove this field and index_id from the
method_signature of Create RPC
Required. ID of the Index to create. The id must be 1-63
characters long, and comply with RFC1035. Specifically, it
must be 1-63 characters long and match the regular
expression ``[a-z](?:[-a-z0-9]{0,61}[a-z0-9])?``.
index (google.cloud.vectorsearch_v1beta.types.Index):
Required. The resource being created
request_id (str):
Expand Down
Loading