Skip to content

Commit ddfae11

Browse files
committed
chore: auto-gen by protobufs
triggered by commit: instill-ai/protobufs@88cfb5a
1 parent 5b113d6 commit ddfae11

10 files changed

+359
-191
lines changed

artifact/artifact/v1alpha/artifact_pb2.pyi

Lines changed: 1 addition & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -291,43 +291,7 @@ global___ReadinessResponse = ReadinessResponse
291291

292292
@typing_extensions.final
293293
class RepositoryTag(google.protobuf.message.Message):
294-
"""
295-
296-
This API is under development and, therefore, some of its entities and
297-
endpoints are not implemented yet. This section aims to give context about the
298-
current interface and how it fits in the Artifact vision.
299-
300-
# Artifact
301-
302-
The Artifact domain is responsible of storing data that will later be used for
303-
processing unstructured data. Artifact will support the following types of
304-
data:
305-
306-
- Repositories
307-
- Objects
308-
- Vectors
309-
310-
## Repositories
311-
312-
An implementation of the [OCI Distribution Specification](https://github.com/opencontainers/distribution-spec?tab=readme-ov-file)
313-
is used to manage versioned content. The main use for repositories is storing
314-
container images that can be used to deploy AI models or pipelines.
315-
316-
The ID of a repository has 2 segments, the owner (an Instill user or
317-
organization) and the content ID (the AI model or pipeline ID), e.g.
318-
`curious-wombat/llava-34b`.
319-
320-
## Objects
321-
322-
Raw data is stored in binary blobs. Object storage allows users to upload data
323-
(e.g. images, audio) that can be used by pipelines or to store the results or a
324-
pipeline trigger.
325-
326-
## Vectors
327-
328-
Vector embeddings have their own storage, which allows fast retrieval and similarity search.
329-
330-
RepositoryTag contains information about the version of some content in a
294+
"""RepositoryTag contains information about the version of some content in a
331295
repository.
332296
"""
333297

artifact/artifact/v1alpha/artifact_private_service_pb2.py

Lines changed: 4 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

artifact/artifact/v1alpha/artifact_private_service_pb2_grpc.py

Lines changed: 41 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,11 @@ def __init__(self, channel):
5252
request_serializer=artifact_dot_artifact_dot_v1alpha_dot_artifact__pb2.UpdateObjectRequest.SerializeToString,
5353
response_deserializer=artifact_dot_artifact_dot_v1alpha_dot_artifact__pb2.UpdateObjectResponse.FromString,
5454
)
55+
self.GetFileAsMarkdown = channel.unary_unary(
56+
'/artifact.artifact.v1alpha.ArtifactPrivateService/GetFileAsMarkdown',
57+
request_serializer=artifact_dot_artifact_dot_v1alpha_dot_file__catalog__pb2.GetFileAsMarkdownRequest.SerializeToString,
58+
response_deserializer=artifact_dot_artifact_dot_v1alpha_dot_file__catalog__pb2.GetFileAsMarkdownResponse.FromString,
59+
)
5560
self.GetChatFile = channel.unary_unary(
5661
'/artifact.artifact.v1alpha.ArtifactPrivateService/GetChatFile',
5762
request_serializer=artifact_dot_artifact_dot_v1alpha_dot_file__catalog__pb2.GetChatFileRequest.SerializeToString,
@@ -122,8 +127,21 @@ def UpdateObject(self, request, context):
122127
context.set_details('Method not implemented!')
123128
raise NotImplementedError('Method not implemented!')
124129

130+
def GetFileAsMarkdown(self, request, context):
131+
"""Get file as Markdown
132+
133+
Returns the Markdown representation of a file.
134+
"""
135+
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
136+
context.set_details('Method not implemented!')
137+
raise NotImplementedError('Method not implemented!')
138+
125139
def GetChatFile(self, request, context):
126-
"""Get Chat file
140+
"""Get file as Markdown (deprecated)
141+
142+
Returns the contents of a file conversion to Markdown as a binary blob.
143+
This method is deprecated as it identifies the file by namespace and
144+
filename instead of UID, which isn't a unique identifier anymore.
127145
"""
128146
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
129147
context.set_details('Method not implemented!')
@@ -167,6 +185,11 @@ def add_ArtifactPrivateServiceServicer_to_server(servicer, server):
167185
request_deserializer=artifact_dot_artifact_dot_v1alpha_dot_artifact__pb2.UpdateObjectRequest.FromString,
168186
response_serializer=artifact_dot_artifact_dot_v1alpha_dot_artifact__pb2.UpdateObjectResponse.SerializeToString,
169187
),
188+
'GetFileAsMarkdown': grpc.unary_unary_rpc_method_handler(
189+
servicer.GetFileAsMarkdown,
190+
request_deserializer=artifact_dot_artifact_dot_v1alpha_dot_file__catalog__pb2.GetFileAsMarkdownRequest.FromString,
191+
response_serializer=artifact_dot_artifact_dot_v1alpha_dot_file__catalog__pb2.GetFileAsMarkdownResponse.SerializeToString,
192+
),
170193
'GetChatFile': grpc.unary_unary_rpc_method_handler(
171194
servicer.GetChatFile,
172195
request_deserializer=artifact_dot_artifact_dot_v1alpha_dot_file__catalog__pb2.GetChatFileRequest.FromString,
@@ -303,6 +326,23 @@ def UpdateObject(request,
303326
options, channel_credentials,
304327
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
305328

329+
@staticmethod
330+
def GetFileAsMarkdown(request,
331+
target,
332+
options=(),
333+
channel_credentials=None,
334+
call_credentials=None,
335+
insecure=False,
336+
compression=None,
337+
wait_for_ready=None,
338+
timeout=None,
339+
metadata=None):
340+
return grpc.experimental.unary_unary(request, target, '/artifact.artifact.v1alpha.ArtifactPrivateService/GetFileAsMarkdown',
341+
artifact_dot_artifact_dot_v1alpha_dot_file__catalog__pb2.GetFileAsMarkdownRequest.SerializeToString,
342+
artifact_dot_artifact_dot_v1alpha_dot_file__catalog__pb2.GetFileAsMarkdownResponse.FromString,
343+
options, channel_credentials,
344+
insecure, call_credentials, compression, wait_for_ready, timeout, metadata)
345+
306346
@staticmethod
307347
def GetChatFile(request,
308348
target,

artifact/artifact/v1alpha/artifact_private_service_pb2_grpc.pyi

Lines changed: 44 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -70,11 +70,24 @@ class ArtifactPrivateServiceStub:
7070
artifact.artifact.v1alpha.artifact_pb2.UpdateObjectResponse,
7171
]
7272
"""Update Object"""
73+
GetFileAsMarkdown: grpc.UnaryUnaryMultiCallable[
74+
artifact.artifact.v1alpha.file_catalog_pb2.GetFileAsMarkdownRequest,
75+
artifact.artifact.v1alpha.file_catalog_pb2.GetFileAsMarkdownResponse,
76+
]
77+
"""Get file as Markdown
78+
79+
Returns the Markdown representation of a file.
80+
"""
7381
GetChatFile: grpc.UnaryUnaryMultiCallable[
7482
artifact.artifact.v1alpha.file_catalog_pb2.GetChatFileRequest,
7583
artifact.artifact.v1alpha.file_catalog_pb2.GetChatFileResponse,
7684
]
77-
"""Get Chat file"""
85+
"""Get file as Markdown (deprecated)
86+
87+
Returns the contents of a file conversion to Markdown as a binary blob.
88+
This method is deprecated as it identifies the file by namespace and
89+
filename instead of UID, which isn't a unique identifier anymore.
90+
"""
7891

7992
class ArtifactPrivateServiceAsyncStub:
8093
"""ArtifactPrivateService exposes the private endpoints that allow clients to
@@ -127,11 +140,24 @@ class ArtifactPrivateServiceAsyncStub:
127140
artifact.artifact.v1alpha.artifact_pb2.UpdateObjectResponse,
128141
]
129142
"""Update Object"""
143+
GetFileAsMarkdown: grpc.aio.UnaryUnaryMultiCallable[
144+
artifact.artifact.v1alpha.file_catalog_pb2.GetFileAsMarkdownRequest,
145+
artifact.artifact.v1alpha.file_catalog_pb2.GetFileAsMarkdownResponse,
146+
]
147+
"""Get file as Markdown
148+
149+
Returns the Markdown representation of a file.
150+
"""
130151
GetChatFile: grpc.aio.UnaryUnaryMultiCallable[
131152
artifact.artifact.v1alpha.file_catalog_pb2.GetChatFileRequest,
132153
artifact.artifact.v1alpha.file_catalog_pb2.GetChatFileResponse,
133154
]
134-
"""Get Chat file"""
155+
"""Get file as Markdown (deprecated)
156+
157+
Returns the contents of a file conversion to Markdown as a binary blob.
158+
This method is deprecated as it identifies the file by namespace and
159+
filename instead of UID, which isn't a unique identifier anymore.
160+
"""
135161

136162
class ArtifactPrivateServiceServicer(metaclass=abc.ABCMeta):
137163
"""ArtifactPrivateService exposes the private endpoints that allow clients to
@@ -199,11 +225,26 @@ class ArtifactPrivateServiceServicer(metaclass=abc.ABCMeta):
199225
) -> typing.Union[artifact.artifact.v1alpha.artifact_pb2.UpdateObjectResponse, collections.abc.Awaitable[artifact.artifact.v1alpha.artifact_pb2.UpdateObjectResponse]]:
200226
"""Update Object"""
201227
@abc.abstractmethod
228+
def GetFileAsMarkdown(
229+
self,
230+
request: artifact.artifact.v1alpha.file_catalog_pb2.GetFileAsMarkdownRequest,
231+
context: _ServicerContext,
232+
) -> typing.Union[artifact.artifact.v1alpha.file_catalog_pb2.GetFileAsMarkdownResponse, collections.abc.Awaitable[artifact.artifact.v1alpha.file_catalog_pb2.GetFileAsMarkdownResponse]]:
233+
"""Get file as Markdown
234+
235+
Returns the Markdown representation of a file.
236+
"""
237+
@abc.abstractmethod
202238
def GetChatFile(
203239
self,
204240
request: artifact.artifact.v1alpha.file_catalog_pb2.GetChatFileRequest,
205241
context: _ServicerContext,
206242
) -> typing.Union[artifact.artifact.v1alpha.file_catalog_pb2.GetChatFileResponse, collections.abc.Awaitable[artifact.artifact.v1alpha.file_catalog_pb2.GetChatFileResponse]]:
207-
"""Get Chat file"""
243+
"""Get file as Markdown (deprecated)
244+
245+
Returns the contents of a file conversion to Markdown as a binary blob.
246+
This method is deprecated as it identifies the file by namespace and
247+
filename instead of UID, which isn't a unique identifier anymore.
248+
"""
208249

209250
def add_ArtifactPrivateServiceServicer_to_server(servicer: ArtifactPrivateServiceServicer, server: typing.Union[grpc.Server, grpc.aio.Server]) -> None: ...

artifact/artifact/v1alpha/artifact_public_service_pb2_grpc.py

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -303,7 +303,7 @@ def UpdateChunk(self, request, context):
303303
def SimilarityChunksSearch(self, request, context):
304304
"""Retrieve similar chunks
305305
306-
Returns the similar chunks.
306+
Returns the top-K most similar chunks to a text prompt.
307307
"""
308308
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
309309
context.set_details('Method not implemented!')
@@ -319,9 +319,10 @@ def QuestionAnswering(self, request, context):
319319
raise NotImplementedError('Method not implemented!')
320320

321321
def GetFileCatalog(self, request, context):
322-
"""Get file catalog
322+
"""Get the catalog file.
323323
324-
Get the catalog file.
324+
Returns a view of the file within the catalog, with the text and chunks it
325+
generated after being processed.
325326
"""
326327
context.set_code(grpc.StatusCode.UNIMPLEMENTED)
327328
context.set_details('Method not implemented!')

artifact/artifact/v1alpha/artifact_public_service_pb2_grpc.pyi

Lines changed: 12 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,7 @@ class ArtifactPublicServiceStub:
169169
]
170170
"""Retrieve similar chunks
171171
172-
Returns the similar chunks.
172+
Returns the top-K most similar chunks to a text prompt.
173173
"""
174174
QuestionAnswering: grpc.UnaryUnaryMultiCallable[
175175
artifact.artifact.v1alpha.qa_pb2.QuestionAnsweringRequest,
@@ -183,9 +183,10 @@ class ArtifactPublicServiceStub:
183183
artifact.artifact.v1alpha.file_catalog_pb2.GetFileCatalogRequest,
184184
artifact.artifact.v1alpha.file_catalog_pb2.GetFileCatalogResponse,
185185
]
186-
"""Get file catalog
186+
"""Get the catalog file.
187187
188-
Get the catalog file.
188+
Returns a view of the file within the catalog, with the text and chunks it
189+
generated after being processed.
189190
"""
190191
ListCatalogRuns: grpc.UnaryUnaryMultiCallable[
191192
artifact.artifact.v1alpha.artifact_pb2.ListCatalogRunsRequest,
@@ -367,7 +368,7 @@ class ArtifactPublicServiceAsyncStub:
367368
]
368369
"""Retrieve similar chunks
369370
370-
Returns the similar chunks.
371+
Returns the top-K most similar chunks to a text prompt.
371372
"""
372373
QuestionAnswering: grpc.aio.UnaryUnaryMultiCallable[
373374
artifact.artifact.v1alpha.qa_pb2.QuestionAnsweringRequest,
@@ -381,9 +382,10 @@ class ArtifactPublicServiceAsyncStub:
381382
artifact.artifact.v1alpha.file_catalog_pb2.GetFileCatalogRequest,
382383
artifact.artifact.v1alpha.file_catalog_pb2.GetFileCatalogResponse,
383384
]
384-
"""Get file catalog
385+
"""Get the catalog file.
385386
386-
Get the catalog file.
387+
Returns a view of the file within the catalog, with the text and chunks it
388+
generated after being processed.
387389
"""
388390
ListCatalogRuns: grpc.aio.UnaryUnaryMultiCallable[
389391
artifact.artifact.v1alpha.artifact_pb2.ListCatalogRunsRequest,
@@ -601,7 +603,7 @@ class ArtifactPublicServiceServicer(metaclass=abc.ABCMeta):
601603
) -> typing.Union[artifact.artifact.v1alpha.chunk_pb2.SimilarityChunksSearchResponse, collections.abc.Awaitable[artifact.artifact.v1alpha.chunk_pb2.SimilarityChunksSearchResponse]]:
602604
"""Retrieve similar chunks
603605
604-
Returns the similar chunks.
606+
Returns the top-K most similar chunks to a text prompt.
605607
"""
606608
@abc.abstractmethod
607609
def QuestionAnswering(
@@ -619,9 +621,10 @@ class ArtifactPublicServiceServicer(metaclass=abc.ABCMeta):
619621
request: artifact.artifact.v1alpha.file_catalog_pb2.GetFileCatalogRequest,
620622
context: _ServicerContext,
621623
) -> typing.Union[artifact.artifact.v1alpha.file_catalog_pb2.GetFileCatalogResponse, collections.abc.Awaitable[artifact.artifact.v1alpha.file_catalog_pb2.GetFileCatalogResponse]]:
622-
"""Get file catalog
624+
"""Get the catalog file.
623625
624-
Get the catalog file.
626+
Returns a view of the file within the catalog, with the text and chunks it
627+
generated after being processed.
625628
"""
626629
@abc.abstractmethod
627630
def ListCatalogRuns(

0 commit comments

Comments
 (0)