REST Kaynağı: Corpora.documents
Kaynak: Belge
Document
, Chunk
öğelerinden oluşan bir koleksiyondur. Bir Corpus
en fazla 10.000 Document
içerebilir.
JSON gösterimi |
---|
{
"name": string,
"displayName": string,
"customMetadata": [
{
object ( |
name
string
Sabit. Tanımlayıcı. Document
kaynağının adı. Kimlik ("Corpora/*/documents/" öneki hariç) en fazla 40 karakter içerebilir. Bu karakterler, küçük harfli alfanümerik veya kısa çizgiler (-) şeklindedir. Kimlik, tireyle başlayamaz veya bitemez. Oluşturma sırasında ad boş olursa 12 karakterlik rastgele bir son ek ile birlikte displayName
öğesinden benzersiz bir ad türetilir. Örnek: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
displayName
string
İsteğe bağlı. Document
için kullanıcıların okuyabileceği görünen ad. Görünen ad, boşluklar dahil en fazla 512 karakter uzunluğunda olmalıdır. Örnek: "Semantic Retriever Belgeleri"
customMetadata[]
object (CustomMetadata
)
İsteğe bağlı. Sorgu için kullanılan anahtar/değer çiftleri olarak depolanan, kullanıcı tarafından sağlanan özel meta veriler. Bir Document
en fazla 20 CustomMetadata
içerebilir.
updateTime
string (Timestamp
format)
Yalnızca çıkış. Document
öğesinin en son güncellenişinin zaman damgası.
RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z"
ve "2014-10-02T15:01:23.045123456Z"
.
createTime
string (Timestamp
format)
Yalnızca çıkış. Document
öğesinin oluşturulduğu zamana ait zaman damgası.
RFC3339 UTC "Zulu" zaman damgası biçiminde olmalıdır. Örnekler: "2014-10-02T15:01:23Z"
ve "2014-10-02T15:01:23.045123456Z"
.
Yöntem: Corpora.documents.create
Boş bir Document
oluşturur.
Uç nokta
yayınlayacağım
https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents
Yol parametreleri
parent
string
Zorunlu. Bu Document
öğesinin oluşturulacağı Corpus
biriminin adı. Örnek: corpora/my-corpus-123
corpora/{corpora}
biçimindedir.
İstek içeriği
İstek metni, Document
öğesinin bir örneğini içerir.
Yanıt gövdesi
Başarılı olursa yanıt gövdesi, yeni oluşturulmuş bir Document
örneğini içerir.
Yöntem: Corpora.documents.list
Corpus
içindeki tüm Document
'leri listeler.
Uç nokta
indir
https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*}/documents
Yol parametreleri
parent
string
Zorunlu. Document
içeren Corpus
öğesinin adı. Örnek: corpora/my-corpus-123
corpora/{corpora}
biçimindedir.
Sorgu parametreleri
pageSize
integer
İsteğe bağlı. Döndürülecek maksimum Document
sayısı (sayfa başına). Hizmet daha az Document
döndürebilir.
Belirtilmemişse en fazla 10 Document
döndürülür. Maksimum boyut sınırı sayfa başına 20 Document
'tır.
pageToken
string
İsteğe bağlı. Önceki documents.list
çağrısından alınan bir sayfa jetonu.
Yanıtta döndürülen nextPageToken
değerini, sonraki sayfayı almak için sonraki isteğin bağımsız değişkeni olarak sağlayın.
Sayfalara ayırma işlemi sırasında documents.list
öğesine sağlanan diğer tüm parametreler, sayfa jetonunu sağlayan çağrıyla eşleşmelidir.
İstek içeriği
İstek metni boş olmalıdır.
Yanıt gövdesi
documents.list
tarafından gönderilen yanıt, Document
saniyelik sayfalara ayrılmış bir liste içeriyor. Document
öğeleri artan document.create_time
düzenine göre sıralanır.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
documents[]
object (Document
)
Döndürülen Document
öğeleri.
nextPageToken
string
Sonraki sayfayı almak için pageToken
olarak gönderilebilecek bir jeton. Bu alan atlanırsa başka sayfa yoktur.
JSON gösterimi |
---|
{
"documents": [
{
object ( |
Yöntem: Corpora.documents.query
Document
üzerinde anlamsal arama gerçekleştirir.
Uç nokta
yayınlayacağım
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}:query
Yol parametreleri
name
string
Zorunlu. Sorgulanacak Document
öğesinin adı. Örnek: corpora/my-corpus-123/documents/the-doc-abc
corpora/{corpora}/documents/{document}
biçimindedir.
İstek içeriği
İstek gövdesi, aşağıdaki yapıya sahip verileri içerir:
query
string
Zorunlu. Anlamsal arama gerçekleştirmek için sorgu dizesi.
resultsCount
integer
İsteğe bağlı. Döndürülecek maksimum Chunk
sayısı. Hizmet daha az Chunk
döndürebilir.
Belirtilmezse en fazla 10 Chunk
döndürülür. Belirtilen maksimum sonuç sayısı 100'dür.
metadataFilters[]
object (MetadataFilter
)
İsteğe bağlı. Chunk
meta verileri için filtre uygulayın. Her MetadataFilter
nesnesi benzersiz bir anahtara karşılık gelmelidir. Birden fazla MetadataFilter
nesne, mantıksal "AND" ifadeleriyle birleştirilir.
Not: Zaten bir Document
adı belirtildiğinden bu istek için Document
düzeyinde filtreleme desteklenmez.
Örnek sorgu: (yıl >= 2020 VEYA yıl < 2010) VE (tür = dram VEYA tür = aksiyon)
MetadataFilter
nesne listesi: meta verilerinizdeki filtre = [ {key = "chunk.custom_metadata.year" koşullar = [{int_value = 2020, işlem = GREATER_EQUAL}, {int_value = 2010, işlem = LESS}}, {anahtar = "chunk.custom_metadata.TYPE" koşulları = [{stringValue = "drama", transaction = EQUAL}, {stringValue = "action", transaction = EQUAL}}]
Sayısal bir değer aralığı için örnek sorgu: (yıl > 2015 VE yıl <= 2020)
MetadataFilter
nesne listesi: meta verilerinizdeki filtre = [ {key = "chunk.custom_metadata.year" conditions = [{int_value = 2015, operation = GREATER}]}, {key = "chunk.custom_metadata.year" koşullar = [{int_value = 2020, işlem = LESS_EQUAL}]}]
Not: Aynı anahtara yönelik "VE" ifadeleri yalnızca sayısal değerler için desteklenir. Dize değerleri aynı anahtar için yalnızca "OR" anahtar kelimelerini destekler.
Yanıt gövdesi
Alakalı parçaların listesini içeren documents.query
yanıtı.
Başarılı olursa yanıt metni aşağıdaki yapıyla birlikte verileri içerir:
relevantChunks[]
object (RelevantChunk
)
Döndürülen ilgili parçalar.
JSON gösterimi |
---|
{
"relevantChunks": [
{
object ( |
Yöntem: Corpora.documents.get
Belirli bir Document
ile ilgili bilgileri alır.
Uç nokta
indir
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}
Yol parametreleri
name
string
Zorunlu. Alınacak Document
öğesinin adı. Örnek: corpora/my-corpus-123/documents/the-doc-abc
corpora/{corpora}/documents/{document}
biçimindedir.
İstek içeriği
İstek metni boş olmalıdır.
Yanıt metni
Başarılıysa yanıt metni, Document
öğesinin bir örneğini içerir.
Yöntem: Corpora.documents.patch
Document
günceller.
Uç nokta
yama
https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}
PATCH https://generativelanguage.googleapis.com/v1beta/{document.name=corpora/*/documents/*}
Yol parametreleri
document.name
string
Sabit. Tanımlayıcı. Document
kaynağının adı. Kimlik ("Corpora/*/documents/" öneki hariç) en fazla 40 karakter içerebilir. Bu karakterler, küçük harfli alfanümerik veya kısa çizgiler (-) şeklindedir. Kimlik, tireyle başlayamaz veya bitemez. Oluşturma sırasında ad boş olursa 12 karakterlik rastgele bir son ek ile birlikte displayName
öğesinden benzersiz bir ad türetilir. Örnek: corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c
corpora/{corpora}/documents/{document}
biçimindedir.
Sorgu parametreleri
updateMask
string (FieldMask
format)
Zorunlu. Güncellenecek alanların listesi. Şu anda bu işlem yalnızca displayName
ve customMetadata
sürümlerinin güncellenmesini desteklemektedir.
Bu, tam nitelikli alan adlarının virgülle ayrılmış bir listesidir. Örnek: "user.displayName,photo"
.
İstek içeriği
İstek metni, Document
öğesinin bir örneğini içerir.
Yanıt gövdesi
Başarılıysa yanıt metni, Document
öğesinin bir örneğini içerir.
Yöntem: Corpora.documents.delete
Document
öğesini siler.
Uç nokta
sil
https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*}
Yol parametreleri
name
string
Zorunlu. Silinecek Document
öğesinin kaynak adı. Örnek: corpora/my-corpus-123/documents/the-doc-abc
corpora/{corpora}/documents/{document}
biçimindedir.
Sorgu parametreleri
force
boolean
İsteğe bağlı. Doğru değerine ayarlanırsa bu Document
ile ilgili tüm Chunk
öğeleri ve nesneler de silinir.
Yanlış (varsayılan) değerine ayarlanırsa Document
herhangi bir Chunk
içerdiğinde FAILED_PRECONDITION
hatası döndürülür.
İstek içeriği
İstek metni boş olmalıdır.
Yanıt gövdesi
Başarılı olursa yanıt gövdesi boş olur.
CustomMetadata
Kullanıcı tarafından sağlanan meta veriler, anahtar/değer çiftleri olarak depolanır.
JSON gösterimi |
---|
{ "key": string, // Union field |
key
string
Zorunlu. Depolanacak meta verinin anahtarı.
Birleştirme alanı value
.
value
şunlardan yalnızca biri olabilir:
stringValue
string
Depolanacak meta verilerin dize değeri.
stringListValue
object (StringList
)
Depolanacak meta verilerin StringList değeri.
numericValue
number
Depolanacak meta verilerin sayısal değeri.
StringList
Kullanıcı tarafından sağlanan dize değerleri, tek bir meta veri anahtarına atanır.
JSON gösterimi |
---|
{ "values": [ string ] } |
values[]
string
Depolanacak meta verilerin dize değerleri.